diff --git a/.github/workflows/star-check.yml b/.github/workflows/star-check.yml deleted file mode 100644 index 24d6c17..0000000 --- a/.github/workflows/star-check.yml +++ /dev/null @@ -1,42 +0,0 @@ -name: Check if PR author has starred required repositories -on: - pull_request: - types: [opened, synchronize, reopened] -jobs: - check-starred: - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v4 - - name: Get PR author username and repo info - id: get-info - run: | - echo "username=${{ github.event.pull_request.user.login }}" >> $GITHUB_ENV - echo "current_repo=${{ github.event.repository.name }}" >> $GITHUB_ENV - echo "current_owner=${{ github.repository_owner }}" >> $GITHUB_ENV - - name: Pull github provider - uses: stackql/stackql-exec@v2.2.1 - with: - is_command: 'true' - query: "REGISTRY PULL github;" - - name: Run stackql query - id: check-star - uses: stackql/stackql-assert@v2.2.1 - with: - test_query: | - SELECT repo, count(*) as has_starred - FROM github.activity.repo_stargazers - WHERE owner = '${{ env.current_owner }}' and repo IN ('stackql','${{ env.current_repo }}') - AND login = '${{ env.username }}' - GROUP BY repo; - expected_results_str: '[{"has_starred":"1","repo":"stackql"},{"has_starred":"1","repo":"${{ env.current_repo }}"}]' - continue-on-error: true - - name: Check if starred - if: always() # Ensures this runs regardless of check-star outcome - run: | - if [ "${{ steps.check-star.outcome }}" = "success" ]; then - echo "::notice::Thanks for your support!" - else - echo "::error::It seems you haven't starred the required repositories. Please star the following repos before proceeding: https://github.com/${{ env.current_owner }}/${{ env.current_repo }} (this repo) and https://github.com/stackql/stackql (our core repo)" - exit 1 - fi \ No newline at end of file diff --git a/.gitignore b/.gitignore index 1844196..a75ebe5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ main.zip +/tmp # Byte-compiled / optimized / DLL files __pycache__/ @@ -46,9 +47,7 @@ output/ .stackql/ stackql stackql-zip -stackql-aws-cloud-shell.sh -stackql-azure-cloud-shell.sh -stackql-google-cloud-shell.sh +stackql-*.sh .env nohup.out diff --git a/README.md b/README.md index 30b4dd3..b188943 100644 --- a/README.md +++ b/README.md @@ -1,288 +1,300 @@ -# `confluent` provider for [`stackql`](https://github.com/stackql/stackql) - -This repository is used to generate and document the `confluent` provider for StackQL, allowing you to query and manage Confluent Cloud resources using SQL-like syntax. The provider is built using the `@stackql/provider-utils` package, which provides tools for converting OpenAPI specifications into StackQL-compatible provider schemas. - -## Prerequisites - -To use the Confluent provider with StackQL, you'll need: - -1. A Confluent Cloud account with appropriate API credentials -2. Confluent Cloud API key and secret with sufficient permissions for the resources you want to access -3. StackQL CLI installed on your system (see [StackQL](https://github.com/stackql/stackql)) - -## 1. Download the Open API Specification - -First, download the Confluent Cloud API OpenAPI specification: - -```bash -mkdir -p provider-dev/downloaded -curl -L https://docs.confluent.io/cloud/current/api.html#section/OpenAPI-Specification/Consumer-OpenAPI-specification \ - -o provider-dev/downloaded/confluent-openapi.yaml - -# Convert YAML to JSON if needed -python3 provider-dev/scripts/yaml_to_json.py \ - --input provider-dev/downloaded/confluent-openapi.yaml \ - --output provider-dev/downloaded/openapi.json -``` - -## 2. Split into Service Specs - -Next, split the monolithic OpenAPI specification into service-specific files: - -```bash -rm -rf provider-dev/source/* -npm run split -- \ - --provider-name confluent \ - --api-doc provider-dev/downloaded/openapi.json \ - --svc-discriminator tag \ - --output-dir provider-dev/source \ - --overwrite \ - --svc-name-overrides "$(cat <= 16 (the regeneration pipeline uses scripts shipped by `@stackql/provider-utils`) + +Install repo dependencies: + +```bash +npm install +``` + +## 1. Download the OpenAPI specification + +Confluent publishes a single, monolithic OpenAPI document for the entire Confluent Cloud API surface. The current spec was downloaded from: + +- https://docs.confluent.io/cloud/current/api.html (download link inside the page) + +and saved to `provider-dev/downloaded/openapi.yaml`. The downstream tooling reads YAML directly — no JSON conversion is needed. To refresh: + +```bash +mkdir -p provider-dev/downloaded +curl -L https://docs.confluent.io/cloud/current/openapi.yaml -o provider-dev/downloaded/openapi.yaml +``` + +## 2. (Re)build the service-name override map + +The spec uses one OpenAPI tag per API namespace (e.g. `ACL (v3)`, `API Keys (iam/v2)`, `Schemas (v1)`). The discriminator function in `provider-dev/scripts/confluent-svc.mjs` reduces each tag to a raw bucket name; the splitter then normalizes that name (lowercased; hyphens, spaces and dots converted to underscores) before consulting the override map. Examples: + +- `API Keys (iam/v2)` -> raw `iam` -> normalized `iam` +- `Schemas (v1)` -> raw `Schemas` -> normalized `schemas` +- `Cluster Linking (v3)` -> raw `Cluster Linking` -> normalized `cluster_linking` +- `kafka-quotas` -> normalized `kafka_quotas` + +The override map keys must be the **normalized** form. + +To preserve backward compatibility with the existing provider, normalized buckets that match operations already present in `provider-dev/openapi/src/confluent/v00.00.00000/services/` are folded back into the same service file. The map is generated automatically by walking every operation in the current provider, finding the same operation in the new spec (by `operationId`, falling back to `path+verb`), running the discriminator + normalization on its tag, and recording `normalizedBucket -> existing_service`: + +```bash +node provider-dev/scripts/build_svc_overrides.mjs +``` + +This writes `provider-dev/config/svc_name_overrides.json`. Genuinely-new buckets (no operations in the current provider) are listed in the run output and intentionally left out of the map — they will become their own services unless you add an explicit override. + +## 3. Split into per-service specs + +`--svcNameOverrides` takes an inline JSON string. Pass the contents of `provider-dev/config/svc_name_overrides.json` via shell substitution: + +```bash +rm -rf provider-dev/source/* +npm run split -- \ + --provider-name confluent \ + --api-doc provider-dev/downloaded/openapi.yaml \ + --svc-discriminator function \ + --svc-discriminator-fn provider-dev/scripts/confluent-svc.mjs \ + --output-dir provider-dev/source \ + --svc-name-overrides '{ + "acl":"kafka", + "artifact":"flink_artifacts", + "byok":"encryption_keys", + "cdx":"stream_sharing", + "cluster":"kafka", + "cluster_linking":"kafka", + "cmk":"managed_kafka_clusters", + "compatibility":"schema_registry", + "config":"schema_registry", + "configs":"kafka", + "consumer_group":"kafka", + "contexts":"schema_registry", + "data_encryption_keys":"encryption_keys", + "endpoint": "endpoints", + "entity":"catalog", + "exporters":"schema_registry", + "fcpm":"flink_compute_pools", + "kafka_quotas":"quotas", + "key_encryption_keys":"encryption_keys", + "ksqldbcm":"ksqldb_clusters", + "modes":"schema_registry", + "partition":"kafka", + "pim":"provider_integrations", + "records":"kafka", + "schemas":"schema_registry", + "search":"catalog", + "service_quota":"quotas", + "srcm":"schema_registry_clusters", + "subjects":"schema_registry", + "topic":"kafka", + "types":"catalog" + }' \ + --overwrite +``` + +## 4. Normalize the split specs + +This pass clobbers polymorphism (`oneOf` / `allOf` flattening) and patches missing `type: object` declarations so the StackQL schema is well-formed: + +```bash +npm run normalize -- \ + --api-dir provider-dev/source \ + --verbose +``` + +## 5. Generate the mapping CSV + +Analyze the split specs to produce a fresh `all_services.csv` with one row per `(file, path, verb)`. The analyzer pre-fills `stackql_method_name` and `stackql_verb` from the operationId/HTTP verb but leaves `stackql_resource_name` blank. + +```bash +npm run generate-mappings -- \ + --input-dir provider-dev/source \ + --output-dir provider-dev/config +``` + +Edit `provider-dev/config/all_services.csv` and fill in `stackql_resource_name` (and revise the suggested `stackql_method_name` / `stackql_verb` / `stackql_object_key` if needed) for each operation. + +## 6. Generate the provider + +```bash +rm -rf provider-dev/openapi/* +npm run generate-provider -- \ + --provider-name confluent \ + --input-dir provider-dev/source \ + --output-dir provider-dev/openapi/src/confluent \ + --config-path provider-dev/config/all_services.csv \ + --servers '[{"url": "https://api.confluent.cloud"}]' \ + --provider-config '{"auth": {"type": "basic", "username_var": "CONFLUENT_CLOUD_API_KEY", "password_var": "CONFLUENT_CLOUD_API_SECRET"}}' \ + --naive-req-body-translate \ + --overwrite +``` + +The auth block matches the existing `provider.yaml` (`CONFLUENT_CLOUD_API_KEY` / `CONFLUENT_CLOUD_API_SECRET`). + +## 7. Test the provider + + +### Start the StackQL server + +```bash +PROVIDER_REGISTRY_ROOT_DIR="$(pwd)/provider-dev/openapi" +npm run start-server -- --provider confluent --registry $PROVIDER_REGISTRY_ROOT_DIR +``` + +### Run meta-route tests + +```bash +npm run test-meta-routes -- confluent --verbose +``` + +Stop the server when finished: + +```bash +npm run stop-server +``` + +Server status: + +```bash +npm run server-status +``` + +### Run test queries + +```bash +PROVIDER_REGISTRY_ROOT_DIR="$(pwd)/provider-dev/openapi" +REG_STR='{"url": "file://'${PROVIDER_REGISTRY_ROOT_DIR}'", "localDocRoot": "'${PROVIDER_REGISTRY_ROOT_DIR}'", "verifyConfig": {"nopVerify": true}}' +./stackql shell --registry="${REG_STR}" +``` + +Example queries: + +```sql +-- List all environments +SELECT +id, display_name +FROM confluent.org.environments; + +-- Get an environment +SELECT +id, display_name +FROM confluent.org.environments +WHERE id = 'env-216dqo'; + +-- List managed Kafka clusters +SELECT + id, + spec +FROM confluent.managed_kafka_clusters.clusters +WHERE environment = 'env-216dqo'; + +-- List topics in a Kafka cluster +SELECT + topic_name, + partitions_count, + replication_factor +FROM confluent.kafka.topic +WHERE cluster_id = 'lkc-abcdef'; + +-- List Schema Registry clusters +SELECT + id, + spec +FROM confluent.schema_registry_clusters.clusters +WHERE environment = 'env-abc123'; + +-- List service accounts +SELECT + id, + display_name, + description +FROM confluent.iam.service_accounts; +``` + +## 8. Publish the provider + +Push the generated `confluent` directory under `providers/src` in a feature branch of [`stackql-provider-registry`](https://github.com/stackql/stackql-provider-registry) and follow the [registry release flow](https://github.com/stackql/stackql-provider-registry/blob/dev/docs/build-and-deployment.md). + +To smoke-test against the dev registry: + +```bash +export DEV_REG="{ \"url\": \"https://registry-dev.stackql.app/providers\" }" +./stackql --registry="${DEV_REG}" shell +``` + +```sql +REGISTRY PULL confluent; +``` + +## 9. Generate the web docs + +Provider doc microsites are built with Docusaurus and published via GitHub Pages. + +a. Header content lives in `provider-dev/docgen/provider-data/headerContent1.txt` (frontmatter + intro) and `headerContent2.txt` (Installation + Authentication). Update them if the provider description or auth details change. + +b. The Docusaurus config is in `website/docusaurus.config.js`: + +```js +const providerName = "confluent"; +const providerTitle = "Confluent"; +``` + +c. Generate docs: + +```bash +rm -rf website/docs/* +npm run generate-docs -- \ + --provider-name confluent \ + --provider-dir ./provider-dev/openapi/src/confluent/v00.00.00000 \ + --output-dir ./website \ + --provider-data-dir ./provider-dev/docgen/provider-data +``` + +d. Fix broken links in the generated pages. + +The Confluent OpenAPI spec embeds anchors (e.g. `#section/Versioning/API-Lifecycle-Policy`, `#operation/readConnectv1Connector`) and a few regex fragments inside `` blocks (e.g. `[-a-z0-9]*[a-z0-9]`) that Docusaurus flags as broken links / mis-parses as link references. The post-doc-gen script `provider-dev/scripts/fix_doc_links.mjs` rewrites the affected pages from a curated map. + +```bash +# preview without writing +node provider-dev/scripts/fix_doc_links.mjs --dry-run + +# apply +node provider-dev/scripts/fix_doc_links.mjs +``` + +The map at the top of the script lists every fix as `{ link, action, replaceWith? }`: + +- `action: 'remove'` unwraps `[label](broken)` to `label`. Used for dead anchors today (Confluent's lifecycle-policy page doesn't exist in our docs surface). Badge images inside the label still render. +- `action: 'replace'` swaps the broken target for `replaceWith`. Use this once a real destination URL is available, or for literal-string substitutions like the regex-bracket escapes. + +When Docusaurus surfaces new broken links/anchors after a spec refresh, add an entry under the affected page in the `FIXES` map and re-run. + +## 10. Test the web docs locally + +```bash +cd website +yarn install +yarn build # production build +yarn start # local dev server +``` + +## 11. Publish web docs to GitHub Pages + +Under **Pages** in the repo settings, set **Source** to **GitHub Actions**. In Netlify DNS: + +| Source Domain | Record Type | Target | +|---------------|-------------|--------| +| confluent-provider.stackql.io | CNAME | stackql.github.io. | + +## License + +MIT + +## Contributing + +Pull requests welcome. diff --git a/bin/generate-docs.mjs b/bin/generate-docs.mjs deleted file mode 100644 index 4be9b84..0000000 --- a/bin/generate-docs.mjs +++ /dev/null @@ -1,44 +0,0 @@ -#!/usr/bin/env node - -import { docgen } from '@stackql/provider-utils'; - -async function generateDocs() { - // Get command line arguments - const args = process.argv.slice(2); - const getArg = (flag) => { - const index = args.indexOf(flag); - return index !== -1 ? args[index + 1] : null; - }; - - const providerName = getArg('--provider-name'); - const providerDir = getArg('--provider-dir'); - const outputDir = getArg('--output-dir'); - const providerDataDir = getArg('--provider-data-dir'); - - if (!providerName || !providerDir || !outputDir || !providerDataDir) { - console.error('Error: Missing required arguments'); - console.error('Usage: node generate-docs.mjs --provider-name NAME --provider-dir DIR --output-dir DIR --provider-data-dir DIR'); - process.exit(1); - } - - try { - console.log(`Generating docs for provider: ${providerName}`); - console.log(`Provider directory: ${providerDir}`); - console.log(`Output directory: ${outputDir}`); - console.log(`Provider data directory: ${providerDataDir}`); - - const result = await docgen.generateDocs({ - providerName, - providerDir, - outputDir, - providerDataDir - }); - - console.log('Documentation generated successfully:', result); - } catch (error) { - console.error('Error generating documentation:', error); - process.exit(1); - } -} - -generateDocs(); \ No newline at end of file diff --git a/bin/generate-docs.sh b/bin/generate-docs.sh deleted file mode 100644 index 0602e15..0000000 --- a/bin/generate-docs.sh +++ /dev/null @@ -1,63 +0,0 @@ -#!/usr/bin/env bash - -# Exit on error -set -e - -# Get the script directory for relative paths -SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" -REPO_ROOT="$( cd "$SCRIPT_DIR/.." && pwd )" - -# Parse command line arguments -while [[ $# -gt 0 ]]; do - case $1 in - --provider-name) - PROVIDER_NAME="$2" - shift 2 - ;; - --provider-dir) - PROVIDER_DIR="$2" - shift 2 - ;; - --output-dir) - OUTPUT_DIR="$2" - shift 2 - ;; - --provider-data-dir) - PROVIDER_DATA_DIR="$2" - shift 2 - ;; - --help) - echo "Usage: generate-docs.sh [OPTIONS]" - echo "" - echo "Options:" - echo " --provider-name NAME Provider name (default: snowflake)" - echo " --provider-dir DIR Provider directory path (default: $PROVIDER_DIR)" - echo " --output-dir DIR Output directory for docs (default: $OUTPUT_DIR)" - echo " --provider-data-dir DIR Provider data directory (default: $PROVIDER_DATA_DIR)" - echo " --help Show this help message" - exit 0 - ;; - *) - echo "Unknown option: $1" - echo "Use --help for usage information" - exit 1 - ;; - esac -done - -echo "📚 Generating documentation using @stackql/provider-utils..." - -# Run the Node.js script with arguments -node --experimental-modules "$SCRIPT_DIR/generate-docs.mjs" \ - --provider-name "$PROVIDER_NAME" \ - --provider-dir "$PROVIDER_DIR" \ - --output-dir "$OUTPUT_DIR" \ - --provider-data-dir "$PROVIDER_DATA_DIR" - -# Check if command succeeded -if [ $? -ne 0 ]; then - echo "❌ Documentation generation failed" - exit 1 -fi - -echo "✅ Documentation generated successfully" \ No newline at end of file diff --git a/bin/generate-mappings.mjs b/bin/generate-mappings.mjs deleted file mode 100644 index f711fbc..0000000 --- a/bin/generate-mappings.mjs +++ /dev/null @@ -1,42 +0,0 @@ -#!/usr/bin/env node - -import { providerdev } from '@stackql/provider-utils'; - -async function generateMappings() { - // Get command line arguments - const args = process.argv.slice(2); - const getArg = (flag) => { - const index = args.indexOf(flag); - return index !== -1 ? args[index + 1] : null; - }; - - const providerName = getArg('--provider-name'); - const inputDir = getArg('--input-dir'); - const outputDir = getArg('--output-dir'); - const verbose = args.includes('--verbose'); - - if (!providerName || !inputDir || !outputDir) { - console.error('Error: Missing required arguments'); - console.error('Usage: node generate-mappings.mjs --provider-name NAME --input-dir DIR --output-dir DIR [--verbose]'); - process.exit(1); - } - - try { - console.log(`Analyzing OpenAPI specs for provider: ${providerName}`); - console.log(`Input directory: ${inputDir}`); - console.log(`Output directory: ${outputDir}`); - - const result = await providerdev.analyze({ - inputDir, - outputDir, - verbose - }); - - console.log('Analysis completed successfully:', result); - } catch (error) { - console.error('Error analyzing OpenAPI specs:', error); - process.exit(1); - } -} - -generateMappings(); \ No newline at end of file diff --git a/bin/generate-mappings.sh b/bin/generate-mappings.sh deleted file mode 100644 index a4921c1..0000000 --- a/bin/generate-mappings.sh +++ /dev/null @@ -1,83 +0,0 @@ -#!/usr/bin/env bash - -# Exit on error -set -e - -# Get the script directory for relative paths -SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" -REPO_ROOT="$( cd "$SCRIPT_DIR/.." && pwd )" - -# Default values -PROVIDER_NAME="" -INPUT_DIR="" -OUTPUT_DIR="" -VERBOSE=false - -# Parse command line arguments -while [[ $# -gt 0 ]]; do - case $1 in - --provider-name) - PROVIDER_NAME="$2" - shift 2 - ;; - --input-dir) - INPUT_DIR="$2" - shift 2 - ;; - --output-dir) - OUTPUT_DIR="$2" - shift 2 - ;; - --verbose) - VERBOSE=true - shift - ;; - --help) - echo "Usage: generate-mappings.sh [OPTIONS]" - echo "" - echo "Options:" - echo " --provider-name NAME Provider name (required)" - echo " --input-dir DIR Input directory containing split OpenAPI files (required)" - echo " --output-dir DIR Output directory for mapping file (required)" - echo " --verbose Enable verbose output" - echo " --help Show this help message" - exit 0 - ;; - *) - echo "Unknown option: $1" - echo "Use --help for usage information" - exit 1 - ;; - esac -done - -# Check required arguments -if [ -z "$PROVIDER_NAME" ] || [ -z "$INPUT_DIR" ] || [ -z "$OUTPUT_DIR" ]; then - echo "Error: Missing required arguments" - echo "Use --help for usage information" - exit 1 -fi - -echo "🔍 Analyzing OpenAPI specs to generate mappings..." -echo "Provider: $PROVIDER_NAME" -echo "Input Directory: $INPUT_DIR" -echo "Output Directory: $OUTPUT_DIR" - -# Build command arguments -ARGS=("--provider-name" "$PROVIDER_NAME" "--input-dir" "$INPUT_DIR" "--output-dir" "$OUTPUT_DIR") - -if [ "$VERBOSE" = true ]; then - ARGS+=("--verbose") - echo "Verbose: Yes" -fi - -# Run the Node.js script with arguments -node --experimental-modules "$SCRIPT_DIR/generate-mappings.mjs" "${ARGS[@]}" - -# Check if command succeeded -if [ $? -ne 0 ]; then - echo "❌ Mapping generation failed" - exit 1 -fi - -echo "✅ Mapping file generated successfully at: $OUTPUT_DIR/all_services.csv" \ No newline at end of file diff --git a/bin/generate-provider.mjs b/bin/generate-provider.mjs deleted file mode 100644 index 501eead..0000000 --- a/bin/generate-provider.mjs +++ /dev/null @@ -1,66 +0,0 @@ -#!/usr/bin/env node - -import { providerdev } from '@stackql/provider-utils'; - -async function generateProvider() { - // Get command line arguments - const args = process.argv.slice(2); - const getArg = (flag) => { - const index = args.indexOf(flag); - return index !== -1 ? args[index + 1] : null; - }; - - const providerName = getArg('--provider-name'); - const inputDir = getArg('--input-dir'); - const outputDir = getArg('--output-dir'); - const configPath = getArg('--config-path'); - const servers = getArg('--servers'); - const providerConfig = getArg('--provider-config'); - const skipFiles = getArg('--skip-files')?.split(',') || []; - const overwrite = args.includes('--overwrite'); - const verbose = args.includes('--verbose'); - - if (!providerName || !inputDir || !outputDir || !configPath) { - console.error('Error: Missing required arguments'); - console.error('Usage: node generate-provider.mjs --provider-name NAME --input-dir DIR --output-dir DIR --config-path PATH [--servers JSON] [--provider-config JSON] [--skip-files LIST] [--overwrite] [--verbose]'); - process.exit(1); - } - - try { - console.log(`Generating StackQL provider extensions for: ${providerName}`); - console.log(`Input directory: ${inputDir}`); - console.log(`Output directory: ${outputDir}`); - console.log(`Config path: ${configPath}`); - - if (servers) { - console.log(`Custom servers configuration provided`); - } - - if (providerConfig) { - console.log(`Custom provider configuration provided`); - } - - if (skipFiles.length > 0) { - console.log(`Skipping files: ${skipFiles.join(', ')}`); - } - - const result = await providerdev.generate({ - inputDir, - outputDir, - configPath, - providerId: providerName, - servers, - providerConfig, - skipFiles, - overwrite, - verbose - }); - - console.log('Provider generation completed successfully:', result); - } catch (error) { - console.error('Error generating provider extensions:', error); - process.exit(1); - } -} - -generateProvider(); \ No newline at end of file diff --git a/bin/generate-provider.sh b/bin/generate-provider.sh deleted file mode 100644 index 429933a..0000000 --- a/bin/generate-provider.sh +++ /dev/null @@ -1,134 +0,0 @@ -#!/usr/bin/env bash - -# Exit on error -set -e - -# Get the script directory for relative paths -SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" -REPO_ROOT="$( cd "$SCRIPT_DIR/.." && pwd )" - -# Default values -PROVIDER_NAME="" -INPUT_DIR="" -OUTPUT_DIR="" -CONFIG_PATH="" -SERVERS="" -PROVIDER_CONFIG="" -SKIP_FILES="" -OVERWRITE=false -VERBOSE=false - -# Parse command line arguments -while [[ $# -gt 0 ]]; do - case $1 in - --provider-name) - PROVIDER_NAME="$2" - shift 2 - ;; - --input-dir) - INPUT_DIR="$2" - shift 2 - ;; - --output-dir) - OUTPUT_DIR="$2" - shift 2 - ;; - --config-path) - CONFIG_PATH="$2" - shift 2 - ;; - --servers) - SERVERS="$2" - shift 2 - ;; - --provider-config) - PROVIDER_CONFIG="$2" - shift 2 - ;; - --skip-files) - SKIP_FILES="$2" - shift 2 - ;; - --overwrite) - OVERWRITE=true - shift - ;; - --verbose) - VERBOSE=true - shift - ;; - --help) - echo "Usage: generate-provider.sh [OPTIONS]" - echo "" - echo "Options:" - echo " --provider-name NAME Provider name/ID (required)" - echo " --input-dir DIR Input directory containing split OpenAPI files (required)" - echo " --output-dir DIR Output directory for provider (required)" - echo " --config-path PATH Path to CSV mapping file (required)" - echo " --servers JSON JSON string with servers configuration" - echo " --provider-config JSON JSON string with provider configuration" - echo " --skip-files LIST Comma-separated list of files to skip" - echo " --overwrite Overwrite existing files" - echo " --verbose Enable verbose output" - echo " --help Show this help message" - exit 0 - ;; - *) - echo "Unknown option: $1" - echo "Use --help for usage information" - exit 1 - ;; - esac -done - -# Check required arguments -if [ -z "$PROVIDER_NAME" ] || [ -z "$INPUT_DIR" ] || [ -z "$OUTPUT_DIR" ] || [ -z "$CONFIG_PATH" ]; then - echo "Error: Missing required arguments" - echo "Use --help for usage information" - exit 1 -fi - -echo "🔧 Generating StackQL provider extensions..." -echo "Provider: $PROVIDER_NAME" -echo "Input Directory: $INPUT_DIR" -echo "Output Directory: $OUTPUT_DIR" -echo "Config Path: $CONFIG_PATH" - -# Build command arguments -ARGS=("--provider-name" "$PROVIDER_NAME" "--input-dir" "$INPUT_DIR" "--output-dir" "$OUTPUT_DIR" "--config-path" "$CONFIG_PATH") - -if [ -n "$SERVERS" ]; then - ARGS+=("--servers" "$SERVERS") - echo "Custom servers configuration provided" -fi - -if [ -n "$PROVIDER_CONFIG" ]; then - ARGS+=("--provider-config" "$PROVIDER_CONFIG") - echo "Custom provider configuration provided" -fi - -if [ -n "$SKIP_FILES" ]; then - ARGS+=("--skip-files" "$SKIP_FILES") - echo "Skipping files: $SKIP_FILES" -fi - -if [ "$OVERWRITE" = true ]; then - ARGS+=("--overwrite") - echo "Overwrite: Yes" -fi - -if [ "$VERBOSE" = true ]; then - ARGS+=("--verbose") - echo "Verbose: Yes" -fi - -# Run the Node.js script with arguments -node --experimental-modules "$SCRIPT_DIR/generate-provider.mjs" "${ARGS[@]}" - -# Check if command succeeded -if [ $? -ne 0 ]; then - echo "❌ Provider generation failed" - exit 1 -fi - -echo "✅ Provider generated successfully at: $OUTPUT_DIR" \ No newline at end of file diff --git a/bin/split.mjs b/bin/split.mjs deleted file mode 100644 index 02a344c..0000000 --- a/bin/split.mjs +++ /dev/null @@ -1,76 +0,0 @@ -#!/usr/bin/env node - -import { providerdev } from '@stackql/provider-utils'; - -async function splitOpenApi() { - // Get command line arguments - const args = process.argv.slice(2); - const getArg = (flag) => { - const index = args.indexOf(flag); - return index !== -1 ? args[index + 1] : null; - }; - - const providerName = getArg('--provider-name'); - const apiDoc = getArg('--api-doc'); - const outputDir = getArg('--output-dir'); - const svcDiscriminator = getArg('--svc-discriminator') || 'tag'; - const exclude = getArg('--exclude') || ''; - const overwrite = args.includes('--overwrite'); - const verbose = args.includes('--verbose'); - const svcNameOverridesStr = getArg('--svc-name-overrides') || '{}'; - - let svcNameOverrides = {}; - try { - svcNameOverrides = JSON.parse(svcNameOverridesStr); - } catch (err) { - console.error('Error parsing service name overrides JSON:', err.message); - console.error('Please ensure the JSON format is correct'); - process.exit(1); - } - - if (!providerName || !apiDoc || !outputDir) { - console.error('Error: Missing required arguments'); - console.error('Usage: node split.mjs --provider-name NAME --api-doc PATH --output-dir DIR [--svc-discriminator tag|path] [--exclude LIST] [--svc-name-overrides JSON] [--overwrite] [--verbose]'); - process.exit(1); - } - - try { - console.log(`Splitting OpenAPI doc for provider: ${providerName}`); - console.log(`API Doc: ${apiDoc}`); - console.log(`Output directory: ${outputDir}`); - console.log(`Service Discriminator: ${svcDiscriminator}`); - - if (exclude) { - console.log(`Excluding: ${exclude}`); - } - - const numOverrides = Object.keys(svcNameOverrides).length; - if (numOverrides > 0) { - console.log(`Service name overrides: ${numOverrides} mappings`); - if (verbose) { - console.log('Override mappings:'); - for (const [original, newName] of Object.entries(svcNameOverrides)) { - console.log(` ${original} -> ${newName}`); - } - } - } - - const result = await providerdev.split({ - apiDoc, - providerName, - outputDir, - svcDiscriminator, - exclude, - overwrite, - verbose, - svcNameOverrides - }); - - console.log('Split operation completed successfully:', result); - } catch (error) { - console.error('Error splitting OpenAPI doc:', error); - process.exit(1); - } -} - -splitOpenApi(); \ No newline at end of file diff --git a/bin/split.sh b/bin/split.sh deleted file mode 100644 index 6f961f7..0000000 --- a/bin/split.sh +++ /dev/null @@ -1,123 +0,0 @@ -#!/usr/bin/env bash - -# Exit on error -set -e - -# Get the script directory for relative paths -SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" -REPO_ROOT="$( cd "$SCRIPT_DIR/.." && pwd )" - -# Default values -PROVIDER_NAME="" -API_DOC="" -OUTPUT_DIR="" -SVC_DISCRIMINATOR="tag" -EXCLUDE="" -OVERWRITE=false -VERBOSE=false -SVC_NAME_OVERRIDES="{}" - -# Parse command line arguments -while [[ $# -gt 0 ]]; do - case $1 in - --provider-name) - PROVIDER_NAME="$2" - shift 2 - ;; - --api-doc) - API_DOC="$2" - shift 2 - ;; - --output-dir) - OUTPUT_DIR="$2" - shift 2 - ;; - --svc-discriminator) - SVC_DISCRIMINATOR="$2" - shift 2 - ;; - --exclude) - EXCLUDE="$2" - shift 2 - ;; - --svc-name-overrides) - SVC_NAME_OVERRIDES="$2" - shift 2 - ;; - --overwrite) - OVERWRITE=true - shift - ;; - --verbose) - VERBOSE=true - shift - ;; - --help) - echo "Usage: split.sh [OPTIONS]" - echo "" - echo "Options:" - echo " --provider-name NAME Provider name (required)" - echo " --api-doc PATH Path to OpenAPI document (required)" - echo " --output-dir DIR Output directory for split files (required)" - echo " --svc-discriminator TYPE Service discriminator type: 'tag' or 'path' (default: tag)" - echo " --exclude LIST Comma-separated list of tags or paths to exclude" - echo " --svc-name-overrides JSON JSON object mapping original service names to new names" - echo " --overwrite Overwrite existing files" - echo " --verbose Enable verbose output" - echo " --help Show this help message" - exit 0 - ;; - *) - echo "Unknown option: $1" - echo "Use --help for usage information" - exit 1 - ;; - esac -done - -# Check required arguments -if [ -z "$PROVIDER_NAME" ] || [ -z "$API_DOC" ] || [ -z "$OUTPUT_DIR" ]; then - echo "Error: Missing required arguments" - echo "Use --help for usage information" - exit 1 -fi - -echo "🔪 Splitting OpenAPI document..." -echo "Provider: $PROVIDER_NAME" -echo "API Doc: $API_DOC" -echo "Output Directory: $OUTPUT_DIR" -echo "Service Discriminator: $SVC_DISCRIMINATOR" - -# Build command arguments -ARGS=("--provider-name" "$PROVIDER_NAME" "--api-doc" "$API_DOC" "--output-dir" "$OUTPUT_DIR" "--svc-discriminator" "$SVC_DISCRIMINATOR") - -if [ -n "$EXCLUDE" ]; then - ARGS+=("--exclude" "$EXCLUDE") - echo "Excluding: $EXCLUDE" -fi - -if [ "$SVC_NAME_OVERRIDES" != "{}" ]; then - ARGS+=("--svc-name-overrides" "$SVC_NAME_OVERRIDES") - echo "Service Name Overrides: $SVC_NAME_OVERRIDES" -fi - -if [ "$OVERWRITE" = true ]; then - ARGS+=("--overwrite") - echo "Overwrite: Yes" -fi - -if [ "$VERBOSE" = true ]; then - ARGS+=("--verbose") - echo "Verbose: Yes" -fi - -# Run the Node.js script with arguments -node --experimental-modules "$SCRIPT_DIR/split.mjs" "${ARGS[@]}" - -# Check if command succeeded -if [ $? -ne 0 ]; then - echo "❌ Split operation failed" - exit 1 -fi - -echo "✅ Split operation completed successfully" \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 89f374e..aeb631e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,527 +1,531 @@ -{ - "name": "stackql-provider-digitalocean", - "version": "0.1.0", - "lockfileVersion": 3, - "requires": true, - "packages": { - "": { - "name": "stackql-provider-digitalocean", - "version": "0.1.0", - "dependencies": { - "@stackql/pgwire-lite": "^1.0.1", - "@stackql/provider-utils": "^0.5.0" - }, - "engines": { - "node": ">=14.16.0" - } - }, - "node_modules/@apidevtools/json-schema-ref-parser": { - "version": "11.7.2", - "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-11.7.2.tgz", - "integrity": "sha512-4gY54eEGEstClvEkGnwVkTkrx0sqwemEFG5OSRRn3tD91XH0+Q8XIkYIfo7IwEWPpJZwILb9GUXeShtplRc/eA==", - "license": "MIT", - "dependencies": { - "@jsdevtools/ono": "^7.1.3", - "@types/json-schema": "^7.0.15", - "js-yaml": "^4.1.0" - }, - "engines": { - "node": ">= 16" - }, - "funding": { - "url": "https://github.com/sponsors/philsturgeon" - } - }, - "node_modules/@apidevtools/openapi-schemas": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@apidevtools/openapi-schemas/-/openapi-schemas-2.1.0.tgz", - "integrity": "sha512-Zc1AlqrJlX3SlpupFGpiLi2EbteyP7fXmUOGup6/DnkRgjP9bgMM/ag+n91rsv0U1Gpz0H3VILA/o3bW7Ua6BQ==", - "license": "MIT", - "engines": { - "node": ">=10" - } - }, - "node_modules/@apidevtools/swagger-methods": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/@apidevtools/swagger-methods/-/swagger-methods-3.0.2.tgz", - "integrity": "sha512-QAkD5kK2b1WfjDS/UQn/qQkbwF31uqRjPTrsCs5ZG9BQGAkjwvqGFjjPqAuzac/IYzpPtRzjCP1WrTuAIjMrXg==", - "license": "MIT" - }, - "node_modules/@apidevtools/swagger-parser": { - "version": "10.1.1", - "resolved": "https://registry.npmjs.org/@apidevtools/swagger-parser/-/swagger-parser-10.1.1.tgz", - "integrity": "sha512-u/kozRnsPO/x8QtKYJOqoGtC4kH6yg1lfYkB9Au0WhYB0FNLpyFusttQtvhlwjtG3rOwiRz4D8DnnXa8iEpIKA==", - "license": "MIT", - "dependencies": { - "@apidevtools/json-schema-ref-parser": "11.7.2", - "@apidevtools/openapi-schemas": "^2.1.0", - "@apidevtools/swagger-methods": "^3.0.2", - "@jsdevtools/ono": "^7.1.3", - "ajv": "^8.17.1", - "ajv-draft-04": "^1.0.0", - "call-me-maybe": "^1.0.2" - }, - "peerDependencies": { - "openapi-types": ">=7" - } - }, - "node_modules/@colors/colors": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.6.0.tgz", - "integrity": "sha512-Ir+AOibqzrIsL6ajt3Rz3LskB7OiMVHqltZmspbW/TJuTVuyOMirVqAkjfY6JISiLHgyNqicAC8AyHHGzNd/dA==", - "license": "MIT", - "engines": { - "node": ">=0.1.90" - } - }, - "node_modules/@dabh/diagnostics": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/@dabh/diagnostics/-/diagnostics-2.0.3.tgz", - "integrity": "sha512-hrlQOIi7hAfzsMqlGSFyVucrx38O+j6wiGOf//H2ecvIEqYN4ADBSS2iLMh5UFyDunCNniUIPk/q3riFv45xRA==", - "license": "MIT", - "dependencies": { - "colorspace": "1.1.x", - "enabled": "2.0.x", - "kuler": "^2.0.0" - } - }, - "node_modules/@jsdevtools/ono": { - "version": "7.1.3", - "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz", - "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==", - "license": "MIT" - }, - "node_modules/@stackql/deno-openapi-dereferencer": { - "name": "@jsr/stackql__deno-openapi-dereferencer", - "version": "0.3.1", - "resolved": "https://npm.jsr.io/~/11/@jsr/stackql__deno-openapi-dereferencer/0.3.1.tgz", - "integrity": "sha512-7Ucdom3SYxvzp7VwzulQMe66E+1LeCZIprFQ70PwRPIUfL90bYNQDrLfe5L1WaB+X7StWdHmoFSFxoa9RDlN7w==", - "dependencies": { - "jsonpath-plus": "7.0.0" - } - }, - "node_modules/@stackql/pgwire-lite": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@stackql/pgwire-lite/-/pgwire-lite-1.0.1.tgz", - "integrity": "sha512-jgA6ogzlXySZ1xiJzBxuvgRNu9V38Gs3qUZ4AjinlT7hj+8RH3UhYaDvyBd33QWiK3tVNkglYcnXPQ7q0+rmNA==", - "license": "MIT", - "dependencies": { - "winston": "^3.14.2" - } - }, - "node_modules/@stackql/provider-utils": { - "version": "0.5.0", - "resolved": "https://registry.npmjs.org/@stackql/provider-utils/-/provider-utils-0.5.0.tgz", - "integrity": "sha512-KwHVVCBC0XwbDI/dDb7FM1fEFqqnXQ0mPJFmiEYkASNs5mXQW0jbAazVBeOFO4JN0PN6AyX6D/vWCVOmpnz9jw==", - "license": "MIT", - "dependencies": { - "@apidevtools/swagger-parser": "^10.1.1", - "@stackql/deno-openapi-dereferencer": "npm:@jsr/stackql__deno-openapi-dereferencer@^0.3.1", - "csv-parser": "^3.2.0", - "js-yaml": "^4.1.0", - "pluralize": "^8.0.0" - }, - "engines": { - "node": ">=16.0.0" - } - }, - "node_modules/@types/json-schema": { - "version": "7.0.15", - "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", - "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", - "license": "MIT" - }, - "node_modules/@types/triple-beam": { - "version": "1.3.5", - "resolved": "https://registry.npmjs.org/@types/triple-beam/-/triple-beam-1.3.5.tgz", - "integrity": "sha512-6WaYesThRMCl19iryMYP7/x2OVgCtbIVflDGFpWnb9irXI3UjYE4AzmYuiUKY1AJstGijoY+MgUszMgRxIYTYw==", - "license": "MIT" - }, - "node_modules/ajv": { - "version": "8.17.1", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", - "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.3", - "fast-uri": "^3.0.1", - "json-schema-traverse": "^1.0.0", - "require-from-string": "^2.0.2" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, - "node_modules/ajv-draft-04": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/ajv-draft-04/-/ajv-draft-04-1.0.0.tgz", - "integrity": "sha512-mv00Te6nmYbRp5DCwclxtt7yV/joXJPGS7nM+97GdxvuttCOfgI3K4U25zboyeX0O+myI8ERluxQe5wljMmVIw==", - "license": "MIT", - "peerDependencies": { - "ajv": "^8.5.0" - }, - "peerDependenciesMeta": { - "ajv": { - "optional": true - } - } - }, - "node_modules/argparse": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", - "license": "Python-2.0" - }, - "node_modules/async": { - "version": "3.2.6", - "resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz", - "integrity": "sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA==", - "license": "MIT" - }, - "node_modules/call-me-maybe": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz", - "integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ==", - "license": "MIT" - }, - "node_modules/color": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/color/-/color-3.2.1.tgz", - "integrity": "sha512-aBl7dZI9ENN6fUGC7mWpMTPNHmWUSNan9tuWN6ahh5ZLNk9baLJOnSMlrQkHcrfFgz2/RigjUVAjdx36VcemKA==", - "license": "MIT", - "dependencies": { - "color-convert": "^1.9.3", - "color-string": "^1.6.0" - } - }, - "node_modules/color-convert": { - "version": "1.9.3", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", - "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", - "license": "MIT", - "dependencies": { - "color-name": "1.1.3" - } - }, - "node_modules/color-name": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", - "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==", - "license": "MIT" - }, - "node_modules/color-string": { - "version": "1.9.1", - "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz", - "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==", - "license": "MIT", - "dependencies": { - "color-name": "^1.0.0", - "simple-swizzle": "^0.2.2" - } - }, - "node_modules/colorspace": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/colorspace/-/colorspace-1.1.4.tgz", - "integrity": "sha512-BgvKJiuVu1igBUF2kEjRCZXol6wiiGbY5ipL/oVPwm0BL9sIpMIzM8IK7vwuxIIzOXMV3Ey5w+vxhm0rR/TN8w==", - "license": "MIT", - "dependencies": { - "color": "^3.1.3", - "text-hex": "1.0.x" - } - }, - "node_modules/csv-parser": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/csv-parser/-/csv-parser-3.2.0.tgz", - "integrity": "sha512-fgKbp+AJbn1h2dcAHKIdKNSSjfp43BZZykXsCjzALjKy80VXQNHPFJ6T9Afwdzoj24aMkq8GwDS7KGcDPpejrA==", - "license": "MIT", - "bin": { - "csv-parser": "bin/csv-parser" - }, - "engines": { - "node": ">= 10" - } - }, - "node_modules/enabled": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/enabled/-/enabled-2.0.0.tgz", - "integrity": "sha512-AKrN98kuwOzMIdAizXGI86UFBoo26CL21UM763y1h/GMSJ4/OHU9k2YlsmBpyScFo/wbLzWQJBMCW4+IO3/+OQ==", - "license": "MIT" - }, - "node_modules/fast-deep-equal": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", - "license": "MIT" - }, - "node_modules/fast-uri": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.0.tgz", - "integrity": "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/fastify" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/fastify" - } - ], - "license": "BSD-3-Clause" - }, - "node_modules/fecha": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/fecha/-/fecha-4.2.3.tgz", - "integrity": "sha512-OP2IUU6HeYKJi3i0z4A19kHMQoLVs4Hc+DPqqxI2h/DPZHTm/vjsfC6P0b4jCMy14XizLBqvndQ+UilD7707Jw==", - "license": "MIT" - }, - "node_modules/fn.name": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/fn.name/-/fn.name-1.1.0.tgz", - "integrity": "sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw==", - "license": "MIT" - }, - "node_modules/inherits": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", - "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", - "license": "ISC" - }, - "node_modules/is-arrayish": { - "version": "0.3.4", - "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.4.tgz", - "integrity": "sha512-m6UrgzFVUYawGBh1dUsWR5M2Clqic9RVXC/9f8ceNlv2IcO9j9J/z8UoCLPqtsPBFNzEpfR3xftohbfqDx8EQA==", - "license": "MIT" - }, - "node_modules/is-stream": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", - "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", - "license": "MIT", - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/js-yaml": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", - "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", - "license": "MIT", - "dependencies": { - "argparse": "^2.0.1" - }, - "bin": { - "js-yaml": "bin/js-yaml.js" - } - }, - "node_modules/json-schema-traverse": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", - "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", - "license": "MIT" - }, - "node_modules/jsonpath-plus": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/jsonpath-plus/-/jsonpath-plus-7.0.0.tgz", - "integrity": "sha512-MH4UnrWrU1hJGVEyEyjvYgONkzNTO6Yol0nq18EMnUQ/ZC5cTuJheirXXIwu1b9mZ6t3XL0P79gPsu+zlTnDIQ==", - "license": "MIT", - "engines": { - "node": ">=12.0.0" - } - }, - "node_modules/kuler": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/kuler/-/kuler-2.0.0.tgz", - "integrity": "sha512-Xq9nH7KlWZmXAtodXDDRE7vs6DU1gTU8zYDHDiWLSip45Egwq3plLHzPn27NgvzL2r1LMPC1vdqh98sQxtqj4A==", - "license": "MIT" - }, - "node_modules/logform": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/logform/-/logform-2.7.0.tgz", - "integrity": "sha512-TFYA4jnP7PVbmlBIfhlSe+WKxs9dklXMTEGcBCIvLhE/Tn3H6Gk1norupVW7m5Cnd4bLcr08AytbyV/xj7f/kQ==", - "license": "MIT", - "dependencies": { - "@colors/colors": "1.6.0", - "@types/triple-beam": "^1.3.2", - "fecha": "^4.2.0", - "ms": "^2.1.1", - "safe-stable-stringify": "^2.3.1", - "triple-beam": "^1.3.0" - }, - "engines": { - "node": ">= 12.0.0" - } - }, - "node_modules/ms": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", - "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", - "license": "MIT" - }, - "node_modules/one-time": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/one-time/-/one-time-1.0.0.tgz", - "integrity": "sha512-5DXOiRKwuSEcQ/l0kGCF6Q3jcADFv5tSmRaJck/OqkVFcOzutB134KRSfF0xDrL39MNnqxbHBbUUcjZIhTgb2g==", - "license": "MIT", - "dependencies": { - "fn.name": "1.x.x" - } - }, - "node_modules/openapi-types": { - "version": "12.1.3", - "resolved": "https://registry.npmjs.org/openapi-types/-/openapi-types-12.1.3.tgz", - "integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==", - "license": "MIT", - "peer": true - }, - "node_modules/pluralize": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz", - "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==", - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/readable-stream": { - "version": "3.6.2", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", - "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", - "license": "MIT", - "dependencies": { - "inherits": "^2.0.3", - "string_decoder": "^1.1.1", - "util-deprecate": "^1.0.1" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/require-from-string": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", - "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/safe-buffer": { - "version": "5.2.1", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", - "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT" - }, - "node_modules/safe-stable-stringify": { - "version": "2.5.0", - "resolved": "https://registry.npmjs.org/safe-stable-stringify/-/safe-stable-stringify-2.5.0.tgz", - "integrity": "sha512-b3rppTKm9T+PsVCBEOUR46GWI7fdOs00VKZ1+9c1EWDaDMvjQc6tUwuFyIprgGgTcWoVHSKrU8H31ZHA2e0RHA==", - "license": "MIT", - "engines": { - "node": ">=10" - } - }, - "node_modules/simple-swizzle": { - "version": "0.2.4", - "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.4.tgz", - "integrity": "sha512-nAu1WFPQSMNr2Zn9PGSZK9AGn4t/y97lEm+MXTtUDwfP0ksAIX4nO+6ruD9Jwut4C49SB1Ws+fbXsm/yScWOHw==", - "license": "MIT", - "dependencies": { - "is-arrayish": "^0.3.1" - } - }, - "node_modules/stack-trace": { - "version": "0.0.10", - "resolved": "https://registry.npmjs.org/stack-trace/-/stack-trace-0.0.10.tgz", - "integrity": "sha512-KGzahc7puUKkzyMt+IqAep+TVNbKP+k2Lmwhub39m1AsTSkaDutx56aDCo+HLDzf/D26BIHTJWNiTG1KAJiQCg==", - "license": "MIT", - "engines": { - "node": "*" - } - }, - "node_modules/string_decoder": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", - "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", - "license": "MIT", - "dependencies": { - "safe-buffer": "~5.2.0" - } - }, - "node_modules/text-hex": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/text-hex/-/text-hex-1.0.0.tgz", - "integrity": "sha512-uuVGNWzgJ4yhRaNSiubPY7OjISw4sw4E5Uv0wbjp+OzcbmVU/rsT8ujgcXJhn9ypzsgr5vlzpPqP+MBBKcGvbg==", - "license": "MIT" - }, - "node_modules/triple-beam": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/triple-beam/-/triple-beam-1.4.1.tgz", - "integrity": "sha512-aZbgViZrg1QNcG+LULa7nhZpJTZSLm/mXnHXnbAbjmN5aSa0y7V+wvv6+4WaBtpISJzThKy+PIPxc1Nq1EJ9mg==", - "license": "MIT", - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/util-deprecate": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", - "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", - "license": "MIT" - }, - "node_modules/winston": { - "version": "3.17.0", - "resolved": "https://registry.npmjs.org/winston/-/winston-3.17.0.tgz", - "integrity": "sha512-DLiFIXYC5fMPxaRg832S6F5mJYvePtmO5G9v9IgUFPhXm9/GkXarH/TUrBAVzhTCzAj9anE/+GjrgXp/54nOgw==", - "license": "MIT", - "dependencies": { - "@colors/colors": "^1.6.0", - "@dabh/diagnostics": "^2.0.2", - "async": "^3.2.3", - "is-stream": "^2.0.0", - "logform": "^2.7.0", - "one-time": "^1.0.0", - "readable-stream": "^3.4.0", - "safe-stable-stringify": "^2.3.1", - "stack-trace": "0.0.x", - "triple-beam": "^1.3.0", - "winston-transport": "^4.9.0" - }, - "engines": { - "node": ">= 12.0.0" - } - }, - "node_modules/winston-transport": { - "version": "4.9.0", - "resolved": "https://registry.npmjs.org/winston-transport/-/winston-transport-4.9.0.tgz", - "integrity": "sha512-8drMJ4rkgaPo1Me4zD/3WLfI/zPdA9o2IipKODunnGDcuqbHwjsbB79ylv04LCGGzU0xQ6vTznOMpQGaLhhm6A==", - "license": "MIT", - "dependencies": { - "logform": "^2.7.0", - "readable-stream": "^3.6.2", - "triple-beam": "^1.3.0" - }, - "engines": { - "node": ">= 12.0.0" - } - } - } -} +{ + "name": "stackql-provider-confluent", + "version": "0.1.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "stackql-provider-confluent", + "version": "0.1.0", + "dependencies": { + "@stackql/pgwire-lite": "^1.0.1", + "@stackql/provider-utils": "^0.6.5" + }, + "engines": { + "node": ">=14.16.0" + } + }, + "node_modules/@apidevtools/json-schema-ref-parser": { + "version": "11.7.2", + "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-11.7.2.tgz", + "integrity": "sha512-4gY54eEGEstClvEkGnwVkTkrx0sqwemEFG5OSRRn3tD91XH0+Q8XIkYIfo7IwEWPpJZwILb9GUXeShtplRc/eA==", + "license": "MIT", + "dependencies": { + "@jsdevtools/ono": "^7.1.3", + "@types/json-schema": "^7.0.15", + "js-yaml": "^4.1.0" + }, + "engines": { + "node": ">= 16" + }, + "funding": { + "url": "https://github.com/sponsors/philsturgeon" + } + }, + "node_modules/@apidevtools/openapi-schemas": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@apidevtools/openapi-schemas/-/openapi-schemas-2.1.0.tgz", + "integrity": "sha512-Zc1AlqrJlX3SlpupFGpiLi2EbteyP7fXmUOGup6/DnkRgjP9bgMM/ag+n91rsv0U1Gpz0H3VILA/o3bW7Ua6BQ==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/@apidevtools/swagger-methods": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/@apidevtools/swagger-methods/-/swagger-methods-3.0.2.tgz", + "integrity": "sha512-QAkD5kK2b1WfjDS/UQn/qQkbwF31uqRjPTrsCs5ZG9BQGAkjwvqGFjjPqAuzac/IYzpPtRzjCP1WrTuAIjMrXg==", + "license": "MIT" + }, + "node_modules/@apidevtools/swagger-parser": { + "version": "10.1.1", + "resolved": "https://registry.npmjs.org/@apidevtools/swagger-parser/-/swagger-parser-10.1.1.tgz", + "integrity": "sha512-u/kozRnsPO/x8QtKYJOqoGtC4kH6yg1lfYkB9Au0WhYB0FNLpyFusttQtvhlwjtG3rOwiRz4D8DnnXa8iEpIKA==", + "license": "MIT", + "dependencies": { + "@apidevtools/json-schema-ref-parser": "11.7.2", + "@apidevtools/openapi-schemas": "^2.1.0", + "@apidevtools/swagger-methods": "^3.0.2", + "@jsdevtools/ono": "^7.1.3", + "ajv": "^8.17.1", + "ajv-draft-04": "^1.0.0", + "call-me-maybe": "^1.0.2" + }, + "peerDependencies": { + "openapi-types": ">=7" + } + }, + "node_modules/@colors/colors": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.6.0.tgz", + "integrity": "sha512-Ir+AOibqzrIsL6ajt3Rz3LskB7OiMVHqltZmspbW/TJuTVuyOMirVqAkjfY6JISiLHgyNqicAC8AyHHGzNd/dA==", + "license": "MIT", + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/@dabh/diagnostics": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@dabh/diagnostics/-/diagnostics-2.0.3.tgz", + "integrity": "sha512-hrlQOIi7hAfzsMqlGSFyVucrx38O+j6wiGOf//H2ecvIEqYN4ADBSS2iLMh5UFyDunCNniUIPk/q3riFv45xRA==", + "license": "MIT", + "dependencies": { + "colorspace": "1.1.x", + "enabled": "2.0.x", + "kuler": "^2.0.0" + } + }, + "node_modules/@jsdevtools/ono": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz", + "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==", + "license": "MIT" + }, + "node_modules/@stackql/deno-openapi-dereferencer": { + "name": "@jsr/stackql__deno-openapi-dereferencer", + "version": "0.3.1", + "resolved": "https://npm.jsr.io/~/11/@jsr/stackql__deno-openapi-dereferencer/0.3.1.tgz", + "integrity": "sha512-7Ucdom3SYxvzp7VwzulQMe66E+1LeCZIprFQ70PwRPIUfL90bYNQDrLfe5L1WaB+X7StWdHmoFSFxoa9RDlN7w==", + "dependencies": { + "jsonpath-plus": "7.0.0" + } + }, + "node_modules/@stackql/pgwire-lite": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@stackql/pgwire-lite/-/pgwire-lite-1.0.1.tgz", + "integrity": "sha512-jgA6ogzlXySZ1xiJzBxuvgRNu9V38Gs3qUZ4AjinlT7hj+8RH3UhYaDvyBd33QWiK3tVNkglYcnXPQ7q0+rmNA==", + "license": "MIT", + "dependencies": { + "winston": "^3.14.2" + } + }, + "node_modules/@stackql/provider-utils": { + "version": "0.6.5", + "resolved": "https://registry.npmjs.org/@stackql/provider-utils/-/provider-utils-0.6.5.tgz", + "integrity": "sha512-Bh6anOyOA0qo0PbbjNmvOY2iEW323hY8rdJotBEyCz9gRdEFlBHp1wq78R0dj0cOY5MxmW4k5Wn78TqLZSNTLg==", + "license": "MIT", + "dependencies": { + "@apidevtools/swagger-parser": "^10.1.1", + "@stackql/deno-openapi-dereferencer": "npm:@jsr/stackql__deno-openapi-dereferencer@^0.3.1", + "csv-parser": "^3.2.0", + "js-yaml": "^4.1.0", + "pluralize": "^8.0.0" + }, + "bin": { + "docgen-utils": "bin/docgen-utils.mjs", + "provider-dev-utils": "bin/provider-dev-utils.mjs" + }, + "engines": { + "node": ">=16.0.0" + } + }, + "node_modules/@types/json-schema": { + "version": "7.0.15", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", + "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", + "license": "MIT" + }, + "node_modules/@types/triple-beam": { + "version": "1.3.5", + "resolved": "https://registry.npmjs.org/@types/triple-beam/-/triple-beam-1.3.5.tgz", + "integrity": "sha512-6WaYesThRMCl19iryMYP7/x2OVgCtbIVflDGFpWnb9irXI3UjYE4AzmYuiUKY1AJstGijoY+MgUszMgRxIYTYw==", + "license": "MIT" + }, + "node_modules/ajv": { + "version": "8.17.1", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", + "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "fast-uri": "^3.0.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ajv-draft-04": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/ajv-draft-04/-/ajv-draft-04-1.0.0.tgz", + "integrity": "sha512-mv00Te6nmYbRp5DCwclxtt7yV/joXJPGS7nM+97GdxvuttCOfgI3K4U25zboyeX0O+myI8ERluxQe5wljMmVIw==", + "license": "MIT", + "peerDependencies": { + "ajv": "^8.5.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "license": "Python-2.0" + }, + "node_modules/async": { + "version": "3.2.6", + "resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz", + "integrity": "sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA==", + "license": "MIT" + }, + "node_modules/call-me-maybe": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz", + "integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ==", + "license": "MIT" + }, + "node_modules/color": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/color/-/color-3.2.1.tgz", + "integrity": "sha512-aBl7dZI9ENN6fUGC7mWpMTPNHmWUSNan9tuWN6ahh5ZLNk9baLJOnSMlrQkHcrfFgz2/RigjUVAjdx36VcemKA==", + "license": "MIT", + "dependencies": { + "color-convert": "^1.9.3", + "color-string": "^1.6.0" + } + }, + "node_modules/color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "license": "MIT", + "dependencies": { + "color-name": "1.1.3" + } + }, + "node_modules/color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==", + "license": "MIT" + }, + "node_modules/color-string": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz", + "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==", + "license": "MIT", + "dependencies": { + "color-name": "^1.0.0", + "simple-swizzle": "^0.2.2" + } + }, + "node_modules/colorspace": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/colorspace/-/colorspace-1.1.4.tgz", + "integrity": "sha512-BgvKJiuVu1igBUF2kEjRCZXol6wiiGbY5ipL/oVPwm0BL9sIpMIzM8IK7vwuxIIzOXMV3Ey5w+vxhm0rR/TN8w==", + "license": "MIT", + "dependencies": { + "color": "^3.1.3", + "text-hex": "1.0.x" + } + }, + "node_modules/csv-parser": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/csv-parser/-/csv-parser-3.2.0.tgz", + "integrity": "sha512-fgKbp+AJbn1h2dcAHKIdKNSSjfp43BZZykXsCjzALjKy80VXQNHPFJ6T9Afwdzoj24aMkq8GwDS7KGcDPpejrA==", + "license": "MIT", + "bin": { + "csv-parser": "bin/csv-parser" + }, + "engines": { + "node": ">= 10" + } + }, + "node_modules/enabled": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/enabled/-/enabled-2.0.0.tgz", + "integrity": "sha512-AKrN98kuwOzMIdAizXGI86UFBoo26CL21UM763y1h/GMSJ4/OHU9k2YlsmBpyScFo/wbLzWQJBMCW4+IO3/+OQ==", + "license": "MIT" + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "license": "MIT" + }, + "node_modules/fast-uri": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.0.tgz", + "integrity": "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fastify" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/fastify" + } + ], + "license": "BSD-3-Clause" + }, + "node_modules/fecha": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/fecha/-/fecha-4.2.3.tgz", + "integrity": "sha512-OP2IUU6HeYKJi3i0z4A19kHMQoLVs4Hc+DPqqxI2h/DPZHTm/vjsfC6P0b4jCMy14XizLBqvndQ+UilD7707Jw==", + "license": "MIT" + }, + "node_modules/fn.name": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/fn.name/-/fn.name-1.1.0.tgz", + "integrity": "sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw==", + "license": "MIT" + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "license": "ISC" + }, + "node_modules/is-arrayish": { + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.4.tgz", + "integrity": "sha512-m6UrgzFVUYawGBh1dUsWR5M2Clqic9RVXC/9f8ceNlv2IcO9j9J/z8UoCLPqtsPBFNzEpfR3xftohbfqDx8EQA==", + "license": "MIT" + }, + "node_modules/is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "license": "MIT" + }, + "node_modules/jsonpath-plus": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/jsonpath-plus/-/jsonpath-plus-7.0.0.tgz", + "integrity": "sha512-MH4UnrWrU1hJGVEyEyjvYgONkzNTO6Yol0nq18EMnUQ/ZC5cTuJheirXXIwu1b9mZ6t3XL0P79gPsu+zlTnDIQ==", + "license": "MIT", + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/kuler": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/kuler/-/kuler-2.0.0.tgz", + "integrity": "sha512-Xq9nH7KlWZmXAtodXDDRE7vs6DU1gTU8zYDHDiWLSip45Egwq3plLHzPn27NgvzL2r1LMPC1vdqh98sQxtqj4A==", + "license": "MIT" + }, + "node_modules/logform": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/logform/-/logform-2.7.0.tgz", + "integrity": "sha512-TFYA4jnP7PVbmlBIfhlSe+WKxs9dklXMTEGcBCIvLhE/Tn3H6Gk1norupVW7m5Cnd4bLcr08AytbyV/xj7f/kQ==", + "license": "MIT", + "dependencies": { + "@colors/colors": "1.6.0", + "@types/triple-beam": "^1.3.2", + "fecha": "^4.2.0", + "ms": "^2.1.1", + "safe-stable-stringify": "^2.3.1", + "triple-beam": "^1.3.0" + }, + "engines": { + "node": ">= 12.0.0" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "license": "MIT" + }, + "node_modules/one-time": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/one-time/-/one-time-1.0.0.tgz", + "integrity": "sha512-5DXOiRKwuSEcQ/l0kGCF6Q3jcADFv5tSmRaJck/OqkVFcOzutB134KRSfF0xDrL39MNnqxbHBbUUcjZIhTgb2g==", + "license": "MIT", + "dependencies": { + "fn.name": "1.x.x" + } + }, + "node_modules/openapi-types": { + "version": "12.1.3", + "resolved": "https://registry.npmjs.org/openapi-types/-/openapi-types-12.1.3.tgz", + "integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==", + "license": "MIT", + "peer": true + }, + "node_modules/pluralize": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz", + "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/readable-stream": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", + "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", + "license": "MIT", + "dependencies": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/safe-stable-stringify": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/safe-stable-stringify/-/safe-stable-stringify-2.5.0.tgz", + "integrity": "sha512-b3rppTKm9T+PsVCBEOUR46GWI7fdOs00VKZ1+9c1EWDaDMvjQc6tUwuFyIprgGgTcWoVHSKrU8H31ZHA2e0RHA==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/simple-swizzle": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.4.tgz", + "integrity": "sha512-nAu1WFPQSMNr2Zn9PGSZK9AGn4t/y97lEm+MXTtUDwfP0ksAIX4nO+6ruD9Jwut4C49SB1Ws+fbXsm/yScWOHw==", + "license": "MIT", + "dependencies": { + "is-arrayish": "^0.3.1" + } + }, + "node_modules/stack-trace": { + "version": "0.0.10", + "resolved": "https://registry.npmjs.org/stack-trace/-/stack-trace-0.0.10.tgz", + "integrity": "sha512-KGzahc7puUKkzyMt+IqAep+TVNbKP+k2Lmwhub39m1AsTSkaDutx56aDCo+HLDzf/D26BIHTJWNiTG1KAJiQCg==", + "license": "MIT", + "engines": { + "node": "*" + } + }, + "node_modules/string_decoder": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", + "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "license": "MIT", + "dependencies": { + "safe-buffer": "~5.2.0" + } + }, + "node_modules/text-hex": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/text-hex/-/text-hex-1.0.0.tgz", + "integrity": "sha512-uuVGNWzgJ4yhRaNSiubPY7OjISw4sw4E5Uv0wbjp+OzcbmVU/rsT8ujgcXJhn9ypzsgr5vlzpPqP+MBBKcGvbg==", + "license": "MIT" + }, + "node_modules/triple-beam": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/triple-beam/-/triple-beam-1.4.1.tgz", + "integrity": "sha512-aZbgViZrg1QNcG+LULa7nhZpJTZSLm/mXnHXnbAbjmN5aSa0y7V+wvv6+4WaBtpISJzThKy+PIPxc1Nq1EJ9mg==", + "license": "MIT", + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", + "license": "MIT" + }, + "node_modules/winston": { + "version": "3.17.0", + "resolved": "https://registry.npmjs.org/winston/-/winston-3.17.0.tgz", + "integrity": "sha512-DLiFIXYC5fMPxaRg832S6F5mJYvePtmO5G9v9IgUFPhXm9/GkXarH/TUrBAVzhTCzAj9anE/+GjrgXp/54nOgw==", + "license": "MIT", + "dependencies": { + "@colors/colors": "^1.6.0", + "@dabh/diagnostics": "^2.0.2", + "async": "^3.2.3", + "is-stream": "^2.0.0", + "logform": "^2.7.0", + "one-time": "^1.0.0", + "readable-stream": "^3.4.0", + "safe-stable-stringify": "^2.3.1", + "stack-trace": "0.0.x", + "triple-beam": "^1.3.0", + "winston-transport": "^4.9.0" + }, + "engines": { + "node": ">= 12.0.0" + } + }, + "node_modules/winston-transport": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/winston-transport/-/winston-transport-4.9.0.tgz", + "integrity": "sha512-8drMJ4rkgaPo1Me4zD/3WLfI/zPdA9o2IipKODunnGDcuqbHwjsbB79ylv04LCGGzU0xQ6vTznOMpQGaLhhm6A==", + "license": "MIT", + "dependencies": { + "logform": "^2.7.0", + "readable-stream": "^3.6.2", + "triple-beam": "^1.3.0" + }, + "engines": { + "node": ">= 12.0.0" + } + } + } +} diff --git a/package.json b/package.json index c56e58b..e12fdf7 100644 --- a/package.json +++ b/package.json @@ -1,28 +1,30 @@ -{ - "name": "stackql-provider-digitalocean", - "version": "0.1.0", - "description": "StackQL Provider for Digital Ocean", - "type": "module", - "scripts": { - "generate-docs": "./bin/generate-docs.sh", - "split": "./bin/split.sh", - "generate-mappings": "./bin/generate-mappings.sh", - "generate-provider": "./bin/generate-provider.sh", - "start-server": "bash ./bin/start-server.sh", - "stop-server": "bash ./bin/stop-server.sh", - "server-status": "bash ./bin/server-status.sh", - "test-meta-routes": "node ./bin/test-meta-routes.cjs" - }, - "dependencies": { - "@stackql/pgwire-lite": "^1.0.1", - "@stackql/provider-utils": "^0.5.0" - }, - "keywords": [ - "stackql", - "digitalocean", - "provider" - ], - "engines": { - "node": ">=14.16.0" - } -} \ No newline at end of file +{ + "name": "stackql-provider-confluent", + "version": "0.1.0", + "description": "StackQL Provider for Confluent Cloud", + "type": "module", + "scripts": { + "generate-docs": "node node_modules/@stackql/provider-utils/bin/docgen-utils.mjs generate-docs", + "split": "node node_modules/@stackql/provider-utils/bin/provider-dev-utils.mjs split", + "normalize": "node node_modules/@stackql/provider-utils/bin/provider-dev-utils.mjs normalize", + "generate-mappings": "node node_modules/@stackql/provider-utils/bin/provider-dev-utils.mjs analyze", + "generate-provider": "node node_modules/@stackql/provider-utils/bin/provider-dev-utils.mjs generate", + "start-server": "bash ./bin/start-server.sh", + "stop-server": "bash ./bin/stop-server.sh", + "server-status": "bash ./bin/server-status.sh", + "test-meta-routes": "node ./bin/test-meta-routes.cjs" + }, + "dependencies": { + "@stackql/pgwire-lite": "^1.0.1", + "@stackql/provider-utils": "^0.6.5" + }, + "keywords": [ + "stackql", + "confluent", + "kafka", + "provider" + ], + "engines": { + "node": ">=14.16.0" + } +} diff --git a/provider-dev/config/all_services.csv b/provider-dev/config/all_services.csv new file mode 100644 index 0000000..055157c --- /dev/null +++ b/provider-dev/config/all_services.csv @@ -0,0 +1,487 @@ +filename,path,operationId,formatted_op_id,verb,response_object,tags,formatted_tags,stackql_resource_name,stackql_method_name,stackql_verb,stackql_object_key,op_description +billing.yaml,/billing/v1/costs,listBillingV1Costs,list_billing_v1_costs,get,,Costs (billing/v1),costs (billing/v1),costs,list_billing_v1_costs,select,$.data,List of Costs +catalog.yaml,/catalog/v1/entity,partialEntityUpdate,partial_entity_update,put,EntityPartialUpdateResponse,Entity (v1),entity (v1),entities,partial_entity_update,replace,,Update an Entity Attribute +catalog.yaml,/catalog/v1/entity/businessmetadata,createBusinessMetadata,create_business_metadata,post,BusinessMetadataResponse,Entity (v1),entity (v1),business_metadata,create_business_metadata,insert,,Bulk Create Business Metadata +catalog.yaml,/catalog/v1/entity/businessmetadata,updateBusinessMetadata,update_business_metadata,put,BusinessMetadataResponse,Entity (v1),entity (v1),business_metadata,update_business_metadata,replace,,Bulk Update Business Metadata +catalog.yaml,/catalog/v1/entity/tags,createTags,create_tags,post,TagResponse,Entity (v1),entity (v1),tags,create_tags,insert,,Bulk Create Tags +catalog.yaml,/catalog/v1/entity/tags,updateTags,update_tags,put,TagResponse,Entity (v1),entity (v1),tags,update_tags,replace,,Bulk Update Tags +catalog.yaml,/catalog/v1/entity/type/{typeName}/name/{qualifiedName},getByUniqueAttributes,get_by_unique_attributes,get,EntityWithExtInfo,Entity (v1),entity (v1),entities,get_by_unique_attributes,select,,Read an Entity +catalog.yaml,/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata,getBusinessMetadata,get_business_metadata,get,BusinessMetadataResponse,Entity (v1),entity (v1),business_metadata,get_business_metadata,select,$,Read Business Metadata for an Entity +catalog.yaml,/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName},deleteBusinessMetadata,delete_business_metadata,delete,,Entity (v1),entity (v1),business_metadata,delete_business_metadata,delete,,Delete a Business Metadata for an Entity +catalog.yaml,/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags,getTags,get_tags,get,TagResponse,Entity (v1),entity (v1),tags,get_tags,select,$,Read Tags for an Entity +catalog.yaml,/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName},deleteTag,delete_tag,delete,,Entity (v1),entity (v1),tags,delete_tag,delete,,Delete a Tag for an Entity +catalog.yaml,/catalog/v1/search/attribute,searchUsingAttribute,search_using_attribute,get,SearchResult,Search (v1),search (v1),entities,search_using_attribute,exec,,Search by Attribute +catalog.yaml,/catalog/v1/search/basic,searchUsingBasic,search_using_basic,get,SearchResult,Search (v1),search (v1),entities,search_using_basic,exec,,Search by Fulltext Query +catalog.yaml,/catalog/v1/types/businessmetadatadefs,createBusinessMetadataDefs,create_business_metadata_defs,post,BusinessMetadataDefResponse,Types (v1),types (v1),business_metadata_defs,create_business_metadata_defs,insert,,Bulk Create Business Metadata Definitions +catalog.yaml,/catalog/v1/types/businessmetadatadefs,updateBusinessMetadataDefs,update_business_metadata_defs,put,BusinessMetadataDefResponse,Types (v1),types (v1),business_metadata_defs,update_business_metadata_defs,replace,,Bulk Update Business Metadata Definitions +catalog.yaml,/catalog/v1/types/businessmetadatadefs,getAllBusinessMetadataDefs,get_all_business_metadata_defs,get,BusinessMetadataDefResponse,Types (v1),types (v1),business_metadata_defs,get_all_business_metadata_defs,select,$,Bulk Read Business Metadata Definitions +catalog.yaml,/catalog/v1/types/businessmetadatadefs/{bmName},deleteBusinessMetadataDef,delete_business_metadata_def,delete,,Types (v1),types (v1),business_metadata_defs,delete_business_metadata_def,delete,,Delete Business Metadata Definition +catalog.yaml,/catalog/v1/types/businessmetadatadefs/{bmName},getBusinessMetadataDefByName,get_business_metadata_def_by_name,get,BusinessMetadataDef,Types (v1),types (v1),business_metadata_defs,get_business_metadata_def_by_name,select,,Read Business Metadata Definition +catalog.yaml,/catalog/v1/types/tagdefs,createTagDefs,create_tag_defs,post,TagDefResponse,Types (v1),types (v1),tag_defs,create_tag_defs,insert,,Bulk Create Tag Definitions +catalog.yaml,/catalog/v1/types/tagdefs,updateTagDefs,update_tag_defs,put,TagDefResponse,Types (v1),types (v1),tag_defs,update_tag_defs,replace,,Bulk Update Tag Definitions +catalog.yaml,/catalog/v1/types/tagdefs,getAllTagDefs,get_all_tag_defs,get,TagDefResponse,Types (v1),types (v1),tag_defs,get_all_tag_defs,select,$,Bulk Read Tag Definitions +catalog.yaml,/catalog/v1/types/tagdefs/{tagName},deleteTagDef,delete_tag_def,delete,,Types (v1),types (v1),tag_defs,delete_tag_def,delete,,Delete Tag Definition +catalog.yaml,/catalog/v1/types/tagdefs/{tagName},getTagDefByName,get_tag_def_by_name,get,TagDef,Types (v1),types (v1),tag_defs,get_tag_def_by_name,select,,Read Tag Definition +ccl.yaml,/ccl/v1/custom-code-loggings,createCclV1CustomCodeLogging,create_ccl_v1_custom_code_logging,post,,Custom Code Loggings (ccl/v1),custom code loggings (ccl/v1),custom_code_loggings,create_ccl_v1_custom_code_logging,insert,,Create a Custom Code Logging +ccl.yaml,/ccl/v1/custom-code-loggings,listCclV1CustomCodeLoggings,list_ccl_v1_custom_code_loggings,get,,Custom Code Loggings (ccl/v1),custom code loggings (ccl/v1),custom_code_loggings,list_ccl_v1_custom_code_loggings,select,$.data,List of Custom Code Loggings +ccl.yaml,/ccl/v1/custom-code-loggings/{id},deleteCclV1CustomCodeLogging,delete_ccl_v1_custom_code_logging,delete,,Custom Code Loggings (ccl/v1),custom code loggings (ccl/v1),custom_code_loggings,delete_ccl_v1_custom_code_logging,delete,,Delete a Custom Code Logging +ccl.yaml,/ccl/v1/custom-code-loggings/{id},getCclV1CustomCodeLogging,get_ccl_v1_custom_code_logging,get,,Custom Code Loggings (ccl/v1),custom code loggings (ccl/v1),custom_code_loggings,get_ccl_v1_custom_code_logging,select,,Read a Custom Code Logging +ccl.yaml,/ccl/v1/custom-code-loggings/{id},updateCclV1CustomCodeLogging,update_ccl_v1_custom_code_logging,patch,,Custom Code Loggings (ccl/v1),custom code loggings (ccl/v1),custom_code_loggings,update_ccl_v1_custom_code_logging,update,,Update a Custom Code Logging +ccpm.yaml,/ccpm/v1/plugins,createCcpmV1CustomConnectPlugin,create_ccpm_v1_custom_connect_plugin,post,,Custom Connect Plugins (ccpm/v1),custom connect plugins (ccpm/v1),custom_connect_plugins,create_ccpm_v1_custom_connect_plugin,insert,,Create a Custom Connect Plugin +ccpm.yaml,/ccpm/v1/plugins,listCcpmV1CustomConnectPlugins,list_ccpm_v1_custom_connect_plugins,get,,Custom Connect Plugins (ccpm/v1),custom connect plugins (ccpm/v1),custom_connect_plugins,list_ccpm_v1_custom_connect_plugins,select,$.data,List of Custom Connect Plugins +ccpm.yaml,/ccpm/v1/plugins/{id},deleteCcpmV1CustomConnectPlugin,delete_ccpm_v1_custom_connect_plugin,delete,,Custom Connect Plugins (ccpm/v1),custom connect plugins (ccpm/v1),custom_connect_plugins,delete_ccpm_v1_custom_connect_plugin,delete,,Delete a Custom Connect Plugin +ccpm.yaml,/ccpm/v1/plugins/{id},getCcpmV1CustomConnectPlugin,get_ccpm_v1_custom_connect_plugin,get,,Custom Connect Plugins (ccpm/v1),custom connect plugins (ccpm/v1),custom_connect_plugins,get_ccpm_v1_custom_connect_plugin,select,,Read a Custom Connect Plugin +ccpm.yaml,/ccpm/v1/plugins/{id},updateCcpmV1CustomConnectPlugin,update_ccpm_v1_custom_connect_plugin,patch,,Custom Connect Plugins (ccpm/v1),custom connect plugins (ccpm/v1),custom_connect_plugins,update_ccpm_v1_custom_connect_plugin,update,,Update a Custom Connect Plugin +ccpm.yaml,/ccpm/v1/plugins/{plugin_id}/versions,createCcpmV1CustomConnectPluginVersion,create_ccpm_v1_custom_connect_plugin_version,post,,Custom Connect Plugin Versions (ccpm/v1),custom connect plugin versions (ccpm/v1),custom_connect_plugin_versions,create_ccpm_v1_custom_connect_plugin_version,insert,,Create a Custom Connect Plugin Version +ccpm.yaml,/ccpm/v1/plugins/{plugin_id}/versions,listCcpmV1CustomConnectPluginVersions,list_ccpm_v1_custom_connect_plugin_versions,get,,Custom Connect Plugin Versions (ccpm/v1),custom connect plugin versions (ccpm/v1),custom_connect_plugin_versions,list_ccpm_v1_custom_connect_plugin_versions,select,$.data,List of Custom Connect Plugin Versions +ccpm.yaml,/ccpm/v1/plugins/{plugin_id}/versions/{id},deleteCcpmV1CustomConnectPluginVersion,delete_ccpm_v1_custom_connect_plugin_version,delete,,Custom Connect Plugin Versions (ccpm/v1),custom connect plugin versions (ccpm/v1),custom_connect_plugin_versions,delete_ccpm_v1_custom_connect_plugin_version,delete,,Delete a Custom Connect Plugin Version +ccpm.yaml,/ccpm/v1/plugins/{plugin_id}/versions/{id},getCcpmV1CustomConnectPluginVersion,get_ccpm_v1_custom_connect_plugin_version,get,,Custom Connect Plugin Versions (ccpm/v1),custom connect plugin versions (ccpm/v1),custom_connect_plugin_versions,get_ccpm_v1_custom_connect_plugin_version,select,,Read a Custom Connect Plugin Version +ccpm.yaml,/ccpm/v1/presigned-upload-url,createCcpmV1PresignedUrl,create_ccpm_v1_presigned_url,post,,Presigned Urls (ccpm/v1),presigned urls (ccpm/v1),presigned_urls,create_ccpm_v1_presigned_url,insert,,Request a presigned upload URL for a new Custom Connect Plugin. +connect.yaml,/connect/v1/custom-connector-plugins,createConnectV1CustomConnectorPlugin,create_connect_v1_custom_connector_plugin,post,,Custom Connector Plugins (connect/v1),custom connector plugins (connect/v1),custom_connector_plugins,create_connect_v1_custom_connector_plugin,insert,,Create a Custom Connector Plugin +connect.yaml,/connect/v1/custom-connector-plugins,listConnectV1CustomConnectorPlugins,list_connect_v1_custom_connector_plugins,get,,Custom Connector Plugins (connect/v1),custom connector plugins (connect/v1),custom_connector_plugins,list_connect_v1_custom_connector_plugins,select,$.data,List of Custom Connector Plugins +connect.yaml,/connect/v1/custom-connector-plugins/{id},deleteConnectV1CustomConnectorPlugin,delete_connect_v1_custom_connector_plugin,delete,,Custom Connector Plugins (connect/v1),custom connector plugins (connect/v1),custom_connector_plugins,delete_connect_v1_custom_connector_plugin,delete,,Delete a Custom Connector Plugin +connect.yaml,/connect/v1/custom-connector-plugins/{id},getConnectV1CustomConnectorPlugin,get_connect_v1_custom_connector_plugin,get,,Custom Connector Plugins (connect/v1),custom connector plugins (connect/v1),custom_connector_plugins,get_connect_v1_custom_connector_plugin,select,,Read a Custom Connector Plugin +connect.yaml,/connect/v1/custom-connector-plugins/{id},updateConnectV1CustomConnectorPlugin,update_connect_v1_custom_connector_plugin,patch,,Custom Connector Plugins (connect/v1),custom connector plugins (connect/v1),custom_connector_plugins,update_connect_v1_custom_connector_plugin,update,,Update a Custom Connector Plugin +connect.yaml,/connect/v1/custom-connector-runtimes,listConnectV1CustomConnectorRuntimes,list_connect_v1_custom_connector_runtimes,get,,Custom Connector Runtimes (connect/v1),custom connector runtimes (connect/v1),custom_connector_runtimes,list_connect_v1_custom_connector_runtimes,select,$.data,List of Custom Connector Runtimes +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins,listConnectv1ConnectorPlugins,list_connectv1_connector_plugins,get,,Managed Connector Plugins (connect/v1),managed connector plugins (connect/v1),managed_connector_plugins,list_connectv1_connector_plugins,select,$,List of Managed Connector plugins +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/translate?mask_sensitive=true,translateConnectv1ConnectorPlugin,translate_connectv1_connector_plugin,put,,Managed Connector Plugins (connect/v1),managed connector plugins (connect/v1),managed_connector_plugins,translate_connectv1_connector_plugin,exec,,Translate Self Managed Connector Plugin Configurations to Fully Managed Connector Plugin Configurations +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate,validateConnectv1ConnectorPlugin,validate_connectv1_connector_plugin,put,,Managed Connector Plugins (connect/v1),managed connector plugins (connect/v1),managed_connector_plugins,validate_connectv1_connector_plugin,exec,,Validate a Managed Connector Plugin +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors,createConnectv1Connector,create_connectv1_connector,post,connect.v1.ConnectorWithOffsets,Connectors (connect/v1),connectors (connect/v1),connectors,create_connectv1_connector,insert,,Create a Connector +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors,listConnectv1Connectors,list_connectv1_connectors,get,,Connectors (connect/v1),connectors (connect/v1),connectors,list_connectv1_connectors,select,$,List of Connectors +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name},deleteConnectv1Connector,delete_connectv1_connector,delete,,Connectors (connect/v1),connectors (connect/v1),connectors,delete_connectv1_connector,delete,,Delete a Connector +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name},readConnectv1Connector,read_connectv1_connector,get,connect.v1.Connector,Connectors (connect/v1),connectors (connect/v1),connectors,read_connectv1_connector,select,,Read a Connector +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config,createOrUpdateConnectv1ConnectorConfig,create_or_update_connectv1_connector_config,put,connect.v1.Connector,Connectors (connect/v1),connectors (connect/v1),connector_config,create_or_update_connectv1_connector_config,replace,,Create or Update a Connector Configuration +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config,getConnectv1ConnectorConfig,get_connectv1_connector_config,get,,Connectors (connect/v1),connectors (connect/v1),connector_config,get_connectv1_connector_config,select,,Read a Connector Configuration +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets,getConnectv1ConnectorOffsets,get_connectv1_connector_offsets,get,connect.v1.ConnectorOffsets,Offsets (connect/v1),offsets (connect/v1),connector_offsets,get_connectv1_connector_offsets,select,,Get a Connector Offsets +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request,alterConnectv1ConnectorOffsetsRequest,alter_connectv1_connector_offsets_request,post,connect.v1.AlterOffsetRequestInfo,Offsets (connect/v1),offsets (connect/v1),connector_offsets_requests,alter_connectv1_connector_offsets_request,exec,,Request to Alter the Connector Offsets +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status,getConnectv1ConnectorOffsetsRequestStatus,get_connectv1_connector_offsets_request_status,get,connect.v1.AlterOffsetStatus,Offsets (connect/v1),offsets (connect/v1),connector_offsets_requests,get_connectv1_connector_offsets_request_status,select,,Get the Status of Alter Offset Request +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause,pauseConnectv1Connector,pause_connectv1_connector,put,,Lifecycle (connect/v1),lifecycle (connect/v1),connectors,pause_connectv1_connector,exec,,Pause a Connector +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart,restartConnectv1Connector,restart_connectv1_connector,post,,Lifecycle (connect/v1),lifecycle (connect/v1),connectors,restart_connectv1_connector,exec,,Restart a Connector +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume,resumeConnectv1Connector,resume_connectv1_connector,put,,Lifecycle (connect/v1),lifecycle (connect/v1),connectors,resume_connectv1_connector,exec,,Resume a Connector +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status,readConnectv1ConnectorStatus,read_connectv1_connector_status,get,,Status (connect/v1),status (connect/v1),connector_status,read_connectv1_connector_status,select,,Read a Connector Status +connect.yaml,/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks,listConnectv1ConnectorTasks,list_connectv1_connector_tasks,get,connect.v1.Connectors,Status (connect/v1),status (connect/v1),connector_tasks,list_connectv1_connector_tasks,select,$,List of Connector Tasks +connect.yaml,"/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id",listConnectv1ConnectorsWithExpansions,list_connectv1_connectors_with_expansions,get,connect.v1.ConnectorExpansionMap,Connectors (connect/v1),connectors (connect/v1),connectors,list_connectv1_connectors_with_expansions,exec,,List of Connectors with Expansions +connect.yaml,/connect/v1/presigned-upload-url,presigned-upload-urlConnectV1PresignedUrl,presigned_upload_url_connect_v1_presigned_url,post,,Presigned Urls (connect/v1),presigned urls (connect/v1),presigned_urls,presigned_upload_url_connect_v1_presigned_url,exec,,Request a presigned upload URL for a new Custom Connector Plugin. +encryption_keys.yaml,/byok/v1/keys,createByokV1Key,create_byok_v1_key,post,,Keys (byok/v1),keys (byok/v1),keys,create_byok_v1_key,insert,,Create a Key +encryption_keys.yaml,/byok/v1/keys,listByokV1Keys,list_byok_v1_keys,get,,Keys (byok/v1),keys (byok/v1),keys,list_byok_v1_keys,select,$.data,List of Keys +encryption_keys.yaml,/byok/v1/keys/{id},deleteByokV1Key,delete_byok_v1_key,delete,,Keys (byok/v1),keys (byok/v1),keys,delete_byok_v1_key,delete,,Delete a Key +encryption_keys.yaml,/byok/v1/keys/{id},getByokV1Key,get_byok_v1_key,get,,Keys (byok/v1),keys (byok/v1),keys,get_byok_v1_key,select,,Read a Key +encryption_keys.yaml,/byok/v1/keys/{id},updateByokV1Key,update_byok_v1_key,patch,,Keys (byok/v1),keys (byok/v1),keys,update_byok_v1_key,update,,Update a Key +encryption_keys.yaml,/dek-registry/v1/keks,createKek,create_kek,post,,Key Encryption Keys (v1),key encryption keys (v1),key_encryption_keys,create_kek,insert,,Create a kek +encryption_keys.yaml,/dek-registry/v1/keks,getKekNames,get_kek_names,get,,Key Encryption Keys (v1),key encryption keys (v1),key_encryption_keys,get_kek_names,select,$,Get a list of kek names +encryption_keys.yaml,/dek-registry/v1/keks/{name},deleteKek,delete_kek,delete,,Key Encryption Keys (v1),key encryption keys (v1),key_encryption_keys,delete_kek,delete,,Delete a kek +encryption_keys.yaml,/dek-registry/v1/keks/{name},putKek,put_kek,put,,Key Encryption Keys (v1),key encryption keys (v1),key_encryption_keys,put_kek,replace,,Alters a kek +encryption_keys.yaml,/dek-registry/v1/keks/{name},getKek,get_kek,get,,Key Encryption Keys (v1),key encryption keys (v1),key_encryption_keys,get_kek,select,,Get a kek by name +encryption_keys.yaml,/dek-registry/v1/keks/{name}/deks,createDek,create_dek,post,,Data Encryption Keys (v1),data encryption keys (v1),data_encryption_keys,create_dek,insert,,Create a dek +encryption_keys.yaml,/dek-registry/v1/keks/{name}/deks,getDekSubjects,get_dek_subjects,get,,Data Encryption Keys (v1),data encryption keys (v1),data_encryption_keys,get_dek_subjects,select,$,Get a list of dek subjects +encryption_keys.yaml,/dek-registry/v1/keks/{name}/deks/{subject},deleteDekVersions,delete_dek_versions,delete,,Data Encryption Keys (v1),data encryption keys (v1),data_encryption_keys,delete_dek_versions,delete,,Delete all versions of a dek +encryption_keys.yaml,/dek-registry/v1/keks/{name}/deks/{subject},getDek,get_dek,get,,Data Encryption Keys (v1),data encryption keys (v1),data_encryption_keys,get_dek,select,,Get a dek by subject +encryption_keys.yaml,/dek-registry/v1/keks/{name}/deks/{subject}/undelete,undeleteDekVersions,undelete_dek_versions,post,,Data Encryption Keys (v1),data encryption keys (v1),data_encryption_keys,undelete_dek_versions,exec,,Undelete all versions of a dek +encryption_keys.yaml,/dek-registry/v1/keks/{name}/deks/{subject}/versions,getDekVersions,get_dek_versions,get,,Data Encryption Keys (v1),data encryption keys (v1),dek_versions,get_dek_versions,select,$,List versions of dek +encryption_keys.yaml,/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version},deleteDekVersion,delete_dek_version,delete,,Data Encryption Keys (v1),data encryption keys (v1),dek_versions,delete_dek_version,delete,,Delete a dek version +encryption_keys.yaml,/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version},getDekByVersion,get_dek_by_version,get,,Data Encryption Keys (v1),data encryption keys (v1),dek_versions,get_dek_by_version,select,,Get a dek by subject and version +encryption_keys.yaml,/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}/undelete,undeleteDekVersion,undelete_dek_version,post,,Data Encryption Keys (v1),data encryption keys (v1),dek_versions,undelete_dek_version,exec,,Undelete a dek version +encryption_keys.yaml,/dek-registry/v1/keks/{name}/test,testKek,test_kek,post,,Key Encryption Keys (v1),key encryption keys (v1),key_encryption_keys,test_kek,exec,,Test a kek +encryption_keys.yaml,/dek-registry/v1/keks/{name}/undelete,undeleteKek,undelete_kek,post,,Key Encryption Keys (v1),key encryption keys (v1),key_encryption_keys,undelete_kek,exec,,Undelete a kek +endpoints.yaml,/endpoint/v1/endpoints,listEndpointV1Endpoints,list_endpoint_v1_endpoints,get,,Endpoints (endpoint/v1),endpoints (endpoint/v1),endpoints,list_endpoint_v1_endpoints,select,$.data,List of Endpoints +flink_artifacts.yaml,/artifact/v1/flink-artifacts,createArtifactV1FlinkArtifact,create_artifact_v1_flink_artifact,post,,Flink Artifacts (artifact/v1),flink artifacts (artifact/v1),flink_artifacts,create_artifact_v1_flink_artifact,insert,,Create a new Flink Artifact. +flink_artifacts.yaml,/artifact/v1/flink-artifacts,listArtifactV1FlinkArtifacts,list_artifact_v1_flink_artifacts,get,,Flink Artifacts (artifact/v1),flink artifacts (artifact/v1),flink_artifacts,list_artifact_v1_flink_artifacts,select,$.data,List of Flink Artifacts +flink_artifacts.yaml,/artifact/v1/flink-artifacts/{id},deleteArtifactV1FlinkArtifact,delete_artifact_v1_flink_artifact,delete,,Flink Artifacts (artifact/v1),flink artifacts (artifact/v1),flink_artifacts,delete_artifact_v1_flink_artifact,delete,,Delete a Flink Artifact +flink_artifacts.yaml,/artifact/v1/flink-artifacts/{id},getArtifactV1FlinkArtifact,get_artifact_v1_flink_artifact,get,,Flink Artifacts (artifact/v1),flink artifacts (artifact/v1),flink_artifacts,get_artifact_v1_flink_artifact,select,,Read a Flink Artifact +flink_artifacts.yaml,/artifact/v1/flink-artifacts/{id},updateArtifactV1FlinkArtifact,update_artifact_v1_flink_artifact,patch,,Flink Artifacts (artifact/v1),flink artifacts (artifact/v1),flink_artifacts,update_artifact_v1_flink_artifact,update,,Update a Flink Artifact +flink_artifacts.yaml,/artifact/v1/presigned-upload-url,presigned-upload-urlArtifactV1PresignedUrl,presigned_upload_url_artifact_v1_presigned_url,post,,Presigned Urls (artifact/v1),presigned urls (artifact/v1),presigned_urls,presigned_upload_url_artifact_v1_presigned_url,exec,,Request a presigned upload URL for a new Flink Artifact. +flink_compute_pools.yaml,/fcpm/v2/compute-pool-config,getFcpmV2OrgComputePoolConfig,get_fcpm_v2_org_compute_pool_config,get,,Org Compute Pool Configs (fcpm/v2),org compute pool configs (fcpm/v2),org_compute_pool_configs,get_fcpm_v2_org_compute_pool_config,select,,Read an Org Compute Pool Config +flink_compute_pools.yaml,/fcpm/v2/compute-pool-config,updateFcpmV2OrgComputePoolConfig,update_fcpm_v2_org_compute_pool_config,patch,,Org Compute Pool Configs (fcpm/v2),org compute pool configs (fcpm/v2),org_compute_pool_configs,update_fcpm_v2_org_compute_pool_config,update,,Update an Org Compute Pool Config +flink_compute_pools.yaml,/fcpm/v2/compute-pools,createFcpmV2ComputePool,create_fcpm_v2_compute_pool,post,,Compute Pools (fcpm/v2),compute pools (fcpm/v2),compute_pools,create_fcpm_v2_compute_pool,insert,,Create a Compute Pool +flink_compute_pools.yaml,/fcpm/v2/compute-pools,listFcpmV2ComputePools,list_fcpm_v2_compute_pools,get,,Compute Pools (fcpm/v2),compute pools (fcpm/v2),compute_pools,list_fcpm_v2_compute_pools,select,$.data,List of Compute Pools +flink_compute_pools.yaml,/fcpm/v2/compute-pools/{id},deleteFcpmV2ComputePool,delete_fcpm_v2_compute_pool,delete,,Compute Pools (fcpm/v2),compute pools (fcpm/v2),compute_pools,delete_fcpm_v2_compute_pool,delete,,Delete a Compute Pool +flink_compute_pools.yaml,/fcpm/v2/compute-pools/{id},getFcpmV2ComputePool,get_fcpm_v2_compute_pool,get,,Compute Pools (fcpm/v2),compute pools (fcpm/v2),compute_pools,get_fcpm_v2_compute_pool,select,,Read a Compute Pool +flink_compute_pools.yaml,/fcpm/v2/compute-pools/{id},updateFcpmV2ComputePool,update_fcpm_v2_compute_pool,patch,,Compute Pools (fcpm/v2),compute pools (fcpm/v2),compute_pools,update_fcpm_v2_compute_pool,update,,Update a Compute Pool +flink_compute_pools.yaml,/fcpm/v2/regions,listFcpmV2Regions,list_fcpm_v2_regions,get,,Regions (fcpm/v2),regions (fcpm/v2),regions,list_fcpm_v2_regions,select,$.data,List of Regions +iam.yaml,/iam/v2/api-keys,createIamV2ApiKey,create_iam_v2_api_key,post,,API Keys (iam/v2),api keys (iam/v2),api_keys,create_iam_v2_api_key,insert,,Create an API Key +iam.yaml,/iam/v2/api-keys,listIamV2ApiKeys,list_iam_v2_api_keys,get,,API Keys (iam/v2),api keys (iam/v2),api_keys,list_iam_v2_api_keys,select,$.data,List of API Keys +iam.yaml,/iam/v2/api-keys/{id},deleteIamV2ApiKey,delete_iam_v2_api_key,delete,,API Keys (iam/v2),api keys (iam/v2),api_keys,delete_iam_v2_api_key,delete,,Delete an API Key +iam.yaml,/iam/v2/api-keys/{id},getIamV2ApiKey,get_iam_v2_api_key,get,,API Keys (iam/v2),api keys (iam/v2),api_keys,get_iam_v2_api_key,select,,Read an API Key +iam.yaml,/iam/v2/api-keys/{id},updateIamV2ApiKey,update_iam_v2_api_key,patch,,API Keys (iam/v2),api keys (iam/v2),api_keys,update_iam_v2_api_key,update,,Update an API Key +iam.yaml,/iam/v2/certificate-authorities,createIamV2CertificateAuthority,create_iam_v2_certificate_authority,post,,Certificate Authorities (iam/v2),certificate authorities (iam/v2),certificate_authorities,create_iam_v2_certificate_authority,insert,,Create a Certificate Authority +iam.yaml,/iam/v2/certificate-authorities,listIamV2CertificateAuthorities,list_iam_v2_certificate_authorities,get,,Certificate Authorities (iam/v2),certificate authorities (iam/v2),certificate_authorities,list_iam_v2_certificate_authorities,select,$.data,List of Certificate Authorities +iam.yaml,/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools,createIamV2CertificateIdentityPool,create_iam_v2_certificate_identity_pool,post,,Certificate Identity Pools (iam/v2),certificate identity pools (iam/v2),certificate_identity_pools,create_iam_v2_certificate_identity_pool,insert,,Create a Certificate Identity Pool +iam.yaml,/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools,listIamV2CertificateIdentityPools,list_iam_v2_certificate_identity_pools,get,,Certificate Identity Pools (iam/v2),certificate identity pools (iam/v2),certificate_identity_pools,list_iam_v2_certificate_identity_pools,select,$.data,List of Certificate Identity Pools +iam.yaml,/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id},deleteIamV2CertificateIdentityPool,delete_iam_v2_certificate_identity_pool,delete,,Certificate Identity Pools (iam/v2),certificate identity pools (iam/v2),certificate_identity_pools,delete_iam_v2_certificate_identity_pool,delete,,Delete a Certificate Identity Pool +iam.yaml,/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id},updateIamV2CertificateIdentityPool,update_iam_v2_certificate_identity_pool,put,,Certificate Identity Pools (iam/v2),certificate identity pools (iam/v2),certificate_identity_pools,update_iam_v2_certificate_identity_pool,replace,,Update a Certificate Identity Pool +iam.yaml,/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id},getIamV2CertificateIdentityPool,get_iam_v2_certificate_identity_pool,get,,Certificate Identity Pools (iam/v2),certificate identity pools (iam/v2),certificate_identity_pools,get_iam_v2_certificate_identity_pool,select,,Read a Certificate Identity Pool +iam.yaml,/iam/v2/certificate-authorities/{id},deleteIamV2CertificateAuthority,delete_iam_v2_certificate_authority,delete,,Certificate Authorities (iam/v2),certificate authorities (iam/v2),certificate_authorities,delete_iam_v2_certificate_authority,delete,,Delete a Certificate Authority +iam.yaml,/iam/v2/certificate-authorities/{id},updateIamV2CertificateAuthority,update_iam_v2_certificate_authority,put,,Certificate Authorities (iam/v2),certificate authorities (iam/v2),certificate_authorities,update_iam_v2_certificate_authority,replace,,Update a Certificate Authority +iam.yaml,/iam/v2/certificate-authorities/{id},getIamV2CertificateAuthority,get_iam_v2_certificate_authority,get,,Certificate Authorities (iam/v2),certificate authorities (iam/v2),certificate_authorities,get_iam_v2_certificate_authority,select,,Read a Certificate Authority +iam.yaml,/iam/v2/identity-providers,createIamV2IdentityProvider,create_iam_v2_identity_provider,post,,Identity Providers (iam/v2),identity providers (iam/v2),identity_providers,create_iam_v2_identity_provider,insert,,Create an Identity Provider +iam.yaml,/iam/v2/identity-providers,listIamV2IdentityProviders,list_iam_v2_identity_providers,get,,Identity Providers (iam/v2),identity providers (iam/v2),identity_providers,list_iam_v2_identity_providers,select,$.data,List of Identity Providers +iam.yaml,/iam/v2/identity-providers/{id},deleteIamV2IdentityProvider,delete_iam_v2_identity_provider,delete,,Identity Providers (iam/v2),identity providers (iam/v2),identity_providers,delete_iam_v2_identity_provider,delete,,Delete an Identity Provider +iam.yaml,/iam/v2/identity-providers/{id},getIamV2IdentityProvider,get_iam_v2_identity_provider,get,,Identity Providers (iam/v2),identity providers (iam/v2),identity_providers,get_iam_v2_identity_provider,select,,Read an Identity Provider +iam.yaml,/iam/v2/identity-providers/{id},updateIamV2IdentityProvider,update_iam_v2_identity_provider,patch,,Identity Providers (iam/v2),identity providers (iam/v2),identity_providers,update_iam_v2_identity_provider,update,,Update an Identity Provider +iam.yaml,/iam/v2/identity-providers/{provider_id}/identity-pools,createIamV2IdentityPool,create_iam_v2_identity_pool,post,,Identity Pools (iam/v2),identity pools (iam/v2),identity_pools,create_iam_v2_identity_pool,insert,,Create an Identity Pool +iam.yaml,/iam/v2/identity-providers/{provider_id}/identity-pools,listIamV2IdentityPools,list_iam_v2_identity_pools,get,,Identity Pools (iam/v2),identity pools (iam/v2),identity_pools,list_iam_v2_identity_pools,select,$.data,List of Identity Pools +iam.yaml,/iam/v2/identity-providers/{provider_id}/identity-pools/{id},deleteIamV2IdentityPool,delete_iam_v2_identity_pool,delete,,Identity Pools (iam/v2),identity pools (iam/v2),identity_pools,delete_iam_v2_identity_pool,delete,,Delete an Identity Pool +iam.yaml,/iam/v2/identity-providers/{provider_id}/identity-pools/{id},getIamV2IdentityPool,get_iam_v2_identity_pool,get,,Identity Pools (iam/v2),identity pools (iam/v2),identity_pools,get_iam_v2_identity_pool,select,,Read an Identity Pool +iam.yaml,/iam/v2/identity-providers/{provider_id}/identity-pools/{id},updateIamV2IdentityPool,update_iam_v2_identity_pool,patch,,Identity Pools (iam/v2),identity pools (iam/v2),identity_pools,update_iam_v2_identity_pool,update,,Update an Identity Pool +iam.yaml,/iam/v2/identity-providers/{provider_id}/jwks,refreshIamV2JsonWebKeySet,refresh_iam_v2_json_web_key_set,patch,,Jwks (iam/v2),jwks (iam/v2),identity_providers,refresh_iam_v2_json_web_key_set,exec,,Refresh a provider's JWKS +iam.yaml,/iam/v2/invitations,createIamV2Invitation,create_iam_v2_invitation,post,,Invitations (iam/v2),invitations (iam/v2),invitations,create_iam_v2_invitation,insert,,Create an Invitation +iam.yaml,/iam/v2/invitations,listIamV2Invitations,list_iam_v2_invitations,get,,Invitations (iam/v2),invitations (iam/v2),invitations,list_iam_v2_invitations,select,$.data,List of Invitations +iam.yaml,/iam/v2/invitations/{id},deleteIamV2Invitation,delete_iam_v2_invitation,delete,,Invitations (iam/v2),invitations (iam/v2),invitations,delete_iam_v2_invitation,delete,,Delete an Invitation +iam.yaml,/iam/v2/invitations/{id},getIamV2Invitation,get_iam_v2_invitation,get,,Invitations (iam/v2),invitations (iam/v2),invitations,get_iam_v2_invitation,select,,Read an Invitation +iam.yaml,/iam/v2/ip-filters,createIamV2IpFilter,create_iam_v2_ip_filter,post,,IP Filters (iam/v2),ip filters (iam/v2),ip_filters,create_iam_v2_ip_filter,insert,,Create an IP Filter +iam.yaml,/iam/v2/ip-filters,listIamV2IpFilters,list_iam_v2_ip_filters,get,,IP Filters (iam/v2),ip filters (iam/v2),ip_filters,list_iam_v2_ip_filters,select,$.data,List of IP Filters +iam.yaml,/iam/v2/ip-filters/{id},deleteIamV2IpFilter,delete_iam_v2_ip_filter,delete,,IP Filters (iam/v2),ip filters (iam/v2),ip_filters,delete_iam_v2_ip_filter,delete,,Delete an IP Filter +iam.yaml,/iam/v2/ip-filters/{id},getIamV2IpFilter,get_iam_v2_ip_filter,get,,IP Filters (iam/v2),ip filters (iam/v2),ip_filters,get_iam_v2_ip_filter,select,,Read an IP Filter +iam.yaml,/iam/v2/ip-filters/{id},updateIamV2IpFilter,update_iam_v2_ip_filter,patch,,IP Filters (iam/v2),ip filters (iam/v2),ip_filters,update_iam_v2_ip_filter,update,,Update an IP Filter +iam.yaml,/iam/v2/ip-filter-summary,getIamV2IpFilterSummary,get_iam_v2_ip_filter_summary,get,,IP Filter Summaries (iam/v2),ip filter summaries (iam/v2),ip_filter_summaries,get_iam_v2_ip_filter_summary,select,,Read an IP Filter Summary +iam.yaml,/iam/v2/ip-groups,createIamV2IpGroup,create_iam_v2_ip_group,post,,IP Groups (iam/v2),ip groups (iam/v2),ip_groups,create_iam_v2_ip_group,insert,,Create an IP Group +iam.yaml,/iam/v2/ip-groups,listIamV2IpGroups,list_iam_v2_ip_groups,get,,IP Groups (iam/v2),ip groups (iam/v2),ip_groups,list_iam_v2_ip_groups,select,$.data,List of IP Groups +iam.yaml,/iam/v2/ip-groups/{id},deleteIamV2IpGroup,delete_iam_v2_ip_group,delete,,IP Groups (iam/v2),ip groups (iam/v2),ip_groups,delete_iam_v2_ip_group,delete,,Delete an IP Group +iam.yaml,/iam/v2/ip-groups/{id},getIamV2IpGroup,get_iam_v2_ip_group,get,,IP Groups (iam/v2),ip groups (iam/v2),ip_groups,get_iam_v2_ip_group,select,,Read an IP Group +iam.yaml,/iam/v2/ip-groups/{id},updateIamV2IpGroup,update_iam_v2_ip_group,patch,,IP Groups (iam/v2),ip groups (iam/v2),ip_groups,update_iam_v2_ip_group,update,,Update an IP Group +iam.yaml,/iam/v2/role-bindings,createIamV2RoleBinding,create_iam_v2_role_binding,post,,Role Bindings (iam/v2),role bindings (iam/v2),role_bindings,create_iam_v2_role_binding,insert,,Create a Role Binding +iam.yaml,/iam/v2/role-bindings,listIamV2RoleBindings,list_iam_v2_role_bindings,get,,Role Bindings (iam/v2),role bindings (iam/v2),role_bindings,list_iam_v2_role_bindings,select,$.data,List of Role Bindings +iam.yaml,/iam/v2/role-bindings/{id},deleteIamV2RoleBinding,delete_iam_v2_role_binding,delete,,Role Bindings (iam/v2),role bindings (iam/v2),role_bindings,delete_iam_v2_role_binding,delete,,Delete a Role Binding +iam.yaml,/iam/v2/role-bindings/{id},getIamV2RoleBinding,get_iam_v2_role_binding,get,,Role Bindings (iam/v2),role bindings (iam/v2),role_bindings,get_iam_v2_role_binding,select,,Read a Role Binding +iam.yaml,/iam/v2/service-accounts,createIamV2ServiceAccount,create_iam_v2_service_account,post,,Service Accounts (iam/v2),service accounts (iam/v2),service_accounts,create_iam_v2_service_account,insert,,Create a Service Account +iam.yaml,/iam/v2/service-accounts,listIamV2ServiceAccounts,list_iam_v2_service_accounts,get,,Service Accounts (iam/v2),service accounts (iam/v2),service_accounts,list_iam_v2_service_accounts,select,$.data,List of Service Accounts +iam.yaml,/iam/v2/service-accounts/{id},deleteIamV2ServiceAccount,delete_iam_v2_service_account,delete,,Service Accounts (iam/v2),service accounts (iam/v2),service_accounts,delete_iam_v2_service_account,delete,,Delete a Service Account +iam.yaml,/iam/v2/service-accounts/{id},getIamV2ServiceAccount,get_iam_v2_service_account,get,,Service Accounts (iam/v2),service accounts (iam/v2),service_accounts,get_iam_v2_service_account,select,,Read a Service Account +iam.yaml,/iam/v2/service-accounts/{id},updateIamV2ServiceAccount,update_iam_v2_service_account,patch,,Service Accounts (iam/v2),service accounts (iam/v2),service_accounts,update_iam_v2_service_account,update,,Update a Service Account +iam.yaml,/iam/v2/sso/group-mappings,createIamV2SsoGroupMapping,create_iam_v2_sso_group_mapping,post,,Group Mappings (iam/v2/sso),group mappings (iam/v2/sso),group_mappings,create_iam_v2_sso_group_mapping,insert,,Create a Group Mapping +iam.yaml,/iam/v2/sso/group-mappings,listIamV2SsoGroupMappings,list_iam_v2_sso_group_mappings,get,,Group Mappings (iam/v2/sso),group mappings (iam/v2/sso),group_mappings,list_iam_v2_sso_group_mappings,select,$.data,List of Group Mappings +iam.yaml,/iam/v2/sso/group-mappings/{id},deleteIamV2SsoGroupMapping,delete_iam_v2_sso_group_mapping,delete,,Group Mappings (iam/v2/sso),group mappings (iam/v2/sso),group_mappings,delete_iam_v2_sso_group_mapping,delete,,Delete a Group Mapping +iam.yaml,/iam/v2/sso/group-mappings/{id},getIamV2SsoGroupMapping,get_iam_v2_sso_group_mapping,get,,Group Mappings (iam/v2/sso),group mappings (iam/v2/sso),group_mappings,get_iam_v2_sso_group_mapping,select,,Read a Group Mapping +iam.yaml,/iam/v2/sso/group-mappings/{id},updateIamV2SsoGroupMapping,update_iam_v2_sso_group_mapping,patch,,Group Mappings (iam/v2/sso),group mappings (iam/v2/sso),group_mappings,update_iam_v2_sso_group_mapping,update,,Update a Group Mapping +iam.yaml,/iam/v2/users,listIamV2Users,list_iam_v2_users,get,,Users (iam/v2),users (iam/v2),users,list_iam_v2_users,select,$.data,List of Users +iam.yaml,/iam/v2/users/{id},updateIamV2User,update_iam_v2_user,patch,,Users (iam/v2),users (iam/v2),users,update_iam_v2_user,update,,Update a User +iam.yaml,/iam/v2/users/{id},deleteIamV2User,delete_iam_v2_user,delete,,Users (iam/v2),users (iam/v2),users,delete_iam_v2_user,delete,,Delete a User +iam.yaml,/iam/v2/users/{id},getIamV2User,get_iam_v2_user,get,,Users (iam/v2),users (iam/v2),users,get_iam_v2_user,select,,Read a User +iam.yaml,/iam/v2/users/{id}/auth,update_auth_typeIamV2User,update_auth_type_iam_v2_user,patch,,Users (iam/v2),users (iam/v2),users,update_auth_type_iam_v2_user,exec,,Update Auth Type of a User +kafka.yaml,/kafka/v3/clusters/{cluster_id},getKafkaCluster,get_kafka_cluster,get,,Cluster (v3),cluster (v3),clusters,get_kafka_cluster,select,,Get Cluster +kafka.yaml,/kafka/v3/clusters/{cluster_id}/acls,deleteKafkaAcls,delete_kafka_acls,delete,,ACL (v3),acl (v3),acls,delete_kafka_acls,delete,,Delete ACLs +kafka.yaml,/kafka/v3/clusters/{cluster_id}/acls,createKafkaAcls,create_kafka_acls,post,,ACL (v3),acl (v3),acls,create_kafka_acls,insert,,Create an ACL +kafka.yaml,/kafka/v3/clusters/{cluster_id}/acls,getKafkaAcls,get_kafka_acls,get,,ACL (v3),acl (v3),acls,get_kafka_acls,select,,List ACLs +kafka.yaml,/kafka/v3/clusters/{cluster_id}/acls:batch,batchCreateKafkaAcls,batch_create_kafka_acls,post,,ACL (v3),acl (v3),acls,batch_create_kafka_acls,exec,,Batch Create ACLs +kafka.yaml,/kafka/v3/clusters/{cluster_id}/broker-configs,listKafkaClusterConfigs,list_kafka_cluster_configs,get,,Configs (v3),configs (v3),cluster_configs,list_kafka_cluster_configs,select,$.data,List Dynamic Broker Configs +kafka.yaml,/kafka/v3/clusters/{cluster_id}/broker-configs/{name},deleteKafkaClusterConfig,delete_kafka_cluster_config,delete,,Configs (v3),configs (v3),cluster_configs,delete_kafka_cluster_config,delete,,Reset Dynamic Broker Config +kafka.yaml,/kafka/v3/clusters/{cluster_id}/broker-configs/{name},updateKafkaClusterConfig,update_kafka_cluster_config,put,,Configs (v3),configs (v3),cluster_configs,update_kafka_cluster_config,replace,,Update Dynamic Broker Config +kafka.yaml,/kafka/v3/clusters/{cluster_id}/broker-configs/{name},getKafkaClusterConfig,get_kafka_cluster_config,get,,Configs (v3),configs (v3),cluster_configs,get_kafka_cluster_config,select,,Get Dynamic Broker Config +kafka.yaml,/kafka/v3/clusters/{cluster_id}/broker-configs:alter,updateKafkaClusterConfigs,update_kafka_cluster_configs,post,,Configs (v3),configs (v3),cluster_configs,update_kafka_cluster_configs,replace,,Batch Alter Dynamic Broker Configs +kafka.yaml,/kafka/v3/clusters/{cluster_id}/consumer-groups,listKafkaConsumerGroups,list_kafka_consumer_groups,get,,Consumer Group (v3),consumer group (v3),consumer_groups,list_kafka_consumer_groups,select,$.data,List Consumer Groups +kafka.yaml,/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id},getKafkaConsumerGroup,get_kafka_consumer_group,get,,Consumer Group (v3),consumer group (v3),consumer_groups,get_kafka_consumer_group,select,,Get Consumer Group +kafka.yaml,/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers,listKafkaConsumers,list_kafka_consumers,get,,Consumer Group (v3),consumer group (v3),consumers,list_kafka_consumers,select,$.data,List Consumers +kafka.yaml,/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id},getKafkaConsumer,get_kafka_consumer,get,,Consumer Group (v3),consumer group (v3),consumers,get_kafka_consumer,select,,Get Consumer +kafka.yaml,/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags,listKafkaConsumerLags,list_kafka_consumer_lags,get,,Consumer Group (v3),consumer group (v3),consumers_lags,list_kafka_consumer_lags,select,$.data,List Consumer Lags +kafka.yaml,/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id},getKafkaConsumerLag,get_kafka_consumer_lag,get,,Consumer Group (v3),consumer group (v3),consumers_lags,get_kafka_consumer_lag,select,,Get Consumer Lag +kafka.yaml,/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary,getKafkaConsumerGroupLagSummary,get_kafka_consumer_group_lag_summary,get,,Consumer Group (v3),consumer group (v3),consumers_lag_summary,get_kafka_consumer_group_lag_summary,select,,Get Consumer Group Lag Summary +kafka.yaml,/kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs,listKafkaGroupConfigs,list_kafka_group_configs,get,,Configs (v3),configs (v3),group_configs,list_kafka_group_configs,select,$.data,List all configs of the group +kafka.yaml,/kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name},deleteKafkaGroupConfig,delete_kafka_group_config,delete,,Configs (v3),configs (v3),group_configs,delete_kafka_group_config,delete,,Delete group config +kafka.yaml,/kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name},updateKafkaGroupConfig,update_kafka_group_config,put,,Configs (v3),configs (v3),group_configs,update_kafka_group_config,replace,,Update group config +kafka.yaml,/kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name},getKafkaGroupConfig,get_kafka_group_config,get,,Configs (v3),configs (v3),group_configs,get_kafka_group_config,select,,Get group config +kafka.yaml,/kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs:alter,updateKafkaGroupConfigBatch,update_kafka_group_config_batch,post,,Configs (v3),configs (v3),group_configs,update_kafka_group_config_batch,exec,,Batch Alter Group Configs +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links,createKafkaLink,create_kafka_link,post,,Cluster Linking (v3),cluster linking (v3),cluster_links,create_kafka_link,insert,,Create a cluster link +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links,listKafkaLinks,list_kafka_links,get,,Cluster Linking (v3),cluster linking (v3),cluster_links,list_kafka_links,select,$.data,List all cluster links in the dest cluster +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/-/mirrors,listKafkaMirrorTopics,list_kafka_mirror_topics,get,,Cluster Linking (v3),cluster linking (v3),mirror_topics,list_kafka_mirror_topics,select,$.data,List mirror topics +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name},deleteKafkaLink,delete_kafka_link,delete,,Cluster Linking (v3),cluster linking (v3),cluster_links,delete_kafka_link,delete,,Delete the cluster link +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name},getKafkaLink,get_kafka_link,get,,Cluster Linking (v3),cluster linking (v3),cluster_links,get_kafka_link,select,,Describe the cluster link +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs,listKafkaLinkConfigs,list_kafka_link_configs,get,,Cluster Linking (v3),cluster linking (v3),cluster_link_configs,list_kafka_link_configs,select,$.data,List all configs of the cluster link +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name},deleteKafkaLinkConfig,delete_kafka_link_config,delete,,Cluster Linking (v3),cluster linking (v3),cluster_link_configs,delete_kafka_link_config,delete,,Reset the given config to default value +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name},updateKafkaLinkConfig,update_kafka_link_config,put,,Cluster Linking (v3),cluster linking (v3),cluster_link_configs,update_kafka_link_config,replace,,Alter the config under the cluster link +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name},getKafkaLinkConfigs,get_kafka_link_configs,get,,Cluster Linking (v3),cluster linking (v3),cluster_link_configs,get_kafka_link_configs,select,,Describe the config under the cluster link +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs:alter,updateKafkaLinkConfigBatch,update_kafka_link_config_batch,put,,Cluster Linking (v3),cluster linking (v3),cluster_link_configs,update_kafka_link_config_batch,replace,,Batch Alter Cluster Link Configs +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors,createKafkaMirrorTopic,create_kafka_mirror_topic,post,,Cluster Linking (v3),cluster linking (v3),mirror_topics,create_kafka_mirror_topic,insert,,Create a mirror topic +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors,listKafkaMirrorTopicsUnderLink,list_kafka_mirror_topics_under_link,get,,Cluster Linking (v3),cluster linking (v3),mirror_topics,list_kafka_mirror_topics_under_link,select,$.data,List mirror topics +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors/{mirror_topic_name},readKafkaMirrorTopic,read_kafka_mirror_topic,get,,Cluster Linking (v3),cluster linking (v3),mirror_topics,read_kafka_mirror_topic,select,,Describe the mirror topic +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:failover,updateKafkaMirrorTopicsFailover,update_kafka_mirror_topics_failover,post,,Cluster Linking (v3),cluster linking (v3),mirror_topics,update_kafka_mirror_topics_failover,exec,,Failover the mirror topics +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:pause,updateKafkaMirrorTopicsPause,update_kafka_mirror_topics_pause,post,,Cluster Linking (v3),cluster linking (v3),mirror_topics,update_kafka_mirror_topics_pause,exec,,Pause the mirror topics +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:promote,updateKafkaMirrorTopicsPromote,update_kafka_mirror_topics_promote,post,,Cluster Linking (v3),cluster linking (v3),mirror_topics,update_kafka_mirror_topics_promote,exec,,Promote the mirror topics +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:resume,updateKafkaMirrorTopicsResume,update_kafka_mirror_topics_resume,post,,Cluster Linking (v3),cluster linking (v3),mirror_topics,update_kafka_mirror_topics_resume,exec,,Resume the mirror topics +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-pause-mirror,updateKafkaMirrorTopicsReverseAndPauseMirror,update_kafka_mirror_topics_reverse_and_pause_mirror,post,,Cluster Linking (v3),cluster linking (v3),mirror_topics,update_kafka_mirror_topics_reverse_and_pause_mirror,exec,,Reverse the local mirror topic and Pause the remote mirror topic +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-start-mirror,updateKafkaMirrorTopicsReverseAndStartMirror,update_kafka_mirror_topics_reverse_and_start_mirror,post,,Cluster Linking (v3),cluster linking (v3),mirror_topics,update_kafka_mirror_topics_reverse_and_start_mirror,exec,,Reverse the local mirror topic and start the remote mirror topic +kafka.yaml,/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:truncate-and-restore,updateKafkaMirrorTopicsTruncateAndRestoreMirror,update_kafka_mirror_topics_truncate_and_restore_mirror,post,,Cluster Linking (v3),cluster linking (v3),mirror_topics,update_kafka_mirror_topics_truncate_and_restore_mirror,exec,,Truncates the local topic to the remote stopped mirror log end offsets and restores mirroring to the local topic to mirror from the remote topic +kafka.yaml,/kafka/v3/clusters/{cluster_id}/topics,createKafkaTopic,create_kafka_topic,post,,Topic (v3),topic (v3),topics,create_kafka_topic,insert,,Create Topic +kafka.yaml,/kafka/v3/clusters/{cluster_id}/topics,listKafkaTopics,list_kafka_topics,get,,Topic (v3),topic (v3),topics,list_kafka_topics,select,$.data,List Topics +kafka.yaml,/kafka/v3/clusters/{cluster_id}/topics/-/configs,listKafkaAllTopicConfigs,list_kafka_all_topic_configs,get,,Configs (v3),configs (v3),topic_configs,list_kafka_all_topic_configs,select,$.data,List All Topic Configs +kafka.yaml,/kafka/v3/clusters/{cluster_id}/topics/{topic_name},deleteKafkaTopic,delete_kafka_topic,delete,,Topic (v3),topic (v3),topics,delete_kafka_topic,delete,,Delete Topic +kafka.yaml,/kafka/v3/clusters/{cluster_id}/topics/{topic_name},getKafkaTopic,get_kafka_topic,get,,Topic (v3),topic (v3),topics,get_kafka_topic,select,,Get Topic +kafka.yaml,/kafka/v3/clusters/{cluster_id}/topics/{topic_name},updatePartitionCountKafkaTopic,update_partition_count_kafka_topic,patch,,Topic (v3),topic (v3),topics,update_partition_count_kafka_topic,update,,Update Partition Count +kafka.yaml,/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs,listKafkaTopicConfigs,list_kafka_topic_configs,get,,Configs (v3),configs (v3),topic_configs,list_kafka_topic_configs,select,$.data,List Topic Configs +kafka.yaml,/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name},deleteKafkaTopicConfig,delete_kafka_topic_config,delete,,Configs (v3),configs (v3),topic_configs,delete_kafka_topic_config,delete,,Reset Topic Config +kafka.yaml,/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name},updateKafkaTopicConfig,update_kafka_topic_config,put,,Configs (v3),configs (v3),topic_configs,update_kafka_topic_config,replace,,Update Topic Config +kafka.yaml,/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name},getKafkaTopicConfig,get_kafka_topic_config,get,,Configs (v3),configs (v3),topic_configs,get_kafka_topic_config,select,,Get Topic Config +kafka.yaml,/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs:alter,updateKafkaTopicConfigBatch,update_kafka_topic_config_batch,post,,Configs (v3),configs (v3),topic_configs,update_kafka_topic_config_batch,replace,,Batch Alter Topic Configs +kafka.yaml,/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/default-configs,listKafkaDefaultTopicConfigs,list_kafka_default_topic_configs,get,,Configs (v3),configs (v3),default_topic_configs,list_kafka_default_topic_configs,select,$.data,List New Topic Default Configs +kafka.yaml,/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions,listKafkaPartitions,list_kafka_partitions,get,,Partition (v3),partition (v3),topic_partitions,list_kafka_partitions,select,$.data,List Partitions +kafka.yaml,/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id},getKafkaPartition,get_kafka_partition,get,,Partition (v3),partition (v3),topic_partitions,get_kafka_partition,select,,Get Partition +kafka.yaml,/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/records,produceRecord,produce_record,post,,Records (v3),records (v3),records,produce_record,insert,,Produce Records +ksqldb_clusters.yaml,/ksqldbcm/v2/clusters,createKsqldbcmV2Cluster,create_ksqldbcm_v2_cluster,post,,Clusters (ksqldbcm/v2),clusters (ksqldbcm/v2),clusters,create_ksqldbcm_v2_cluster,insert,,Create a Cluster +ksqldb_clusters.yaml,/ksqldbcm/v2/clusters,listKsqldbcmV2Clusters,list_ksqldbcm_v2_clusters,get,,Clusters (ksqldbcm/v2),clusters (ksqldbcm/v2),clusters,list_ksqldbcm_v2_clusters,select,$.data,List of Clusters +ksqldb_clusters.yaml,/ksqldbcm/v2/clusters/{id},deleteKsqldbcmV2Cluster,delete_ksqldbcm_v2_cluster,delete,,Clusters (ksqldbcm/v2),clusters (ksqldbcm/v2),clusters,delete_ksqldbcm_v2_cluster,delete,,Delete a Cluster +ksqldb_clusters.yaml,/ksqldbcm/v2/clusters/{id},getKsqldbcmV2Cluster,get_ksqldbcm_v2_cluster,get,,Clusters (ksqldbcm/v2),clusters (ksqldbcm/v2),clusters,get_ksqldbcm_v2_cluster,select,,Read a Cluster +managed_kafka_clusters.yaml,/cmk/v2/clusters,createCmkV2Cluster,create_cmk_v2_cluster,post,,Clusters (cmk/v2),clusters (cmk/v2),clusters,create_cmk_v2_cluster,insert,,Create a Cluster +managed_kafka_clusters.yaml,/cmk/v2/clusters,listCmkV2Clusters,list_cmk_v2_clusters,get,,Clusters (cmk/v2),clusters (cmk/v2),clusters,list_cmk_v2_clusters,select,$.data,List of Clusters +managed_kafka_clusters.yaml,/cmk/v2/clusters/{id},deleteCmkV2Cluster,delete_cmk_v2_cluster,delete,,Clusters (cmk/v2),clusters (cmk/v2),clusters,delete_cmk_v2_cluster,delete,,Delete a Cluster +managed_kafka_clusters.yaml,/cmk/v2/clusters/{id},getCmkV2Cluster,get_cmk_v2_cluster,get,,Clusters (cmk/v2),clusters (cmk/v2),clusters,get_cmk_v2_cluster,select,,Read a Cluster +managed_kafka_clusters.yaml,/cmk/v2/clusters/{id},updateCmkV2Cluster,update_cmk_v2_cluster,patch,,Clusters (cmk/v2),clusters (cmk/v2),clusters,update_cmk_v2_cluster,update,,Update a Cluster +networking.yaml,/networking/v1/access-points,createNetworkingV1AccessPoint,create_networking_v1_access_point,post,,Access Points (networking/v1),access points (networking/v1),access_points,create_networking_v1_access_point,insert,,Create an Access Point +networking.yaml,/networking/v1/access-points,listNetworkingV1AccessPoints,list_networking_v1_access_points,get,,Access Points (networking/v1),access points (networking/v1),access_points,list_networking_v1_access_points,select,$.data,List of Access Points +networking.yaml,/networking/v1/access-points/{id},deleteNetworkingV1AccessPoint,delete_networking_v1_access_point,delete,,Access Points (networking/v1),access points (networking/v1),access_points,delete_networking_v1_access_point,delete,,Delete an Access Point +networking.yaml,/networking/v1/access-points/{id},getNetworkingV1AccessPoint,get_networking_v1_access_point,get,,Access Points (networking/v1),access points (networking/v1),access_points,get_networking_v1_access_point,select,,Read an Access Point +networking.yaml,/networking/v1/access-points/{id},updateNetworkingV1AccessPoint,update_networking_v1_access_point,patch,,Access Points (networking/v1),access points (networking/v1),access_points,update_networking_v1_access_point,update,,Update an Access Point +networking.yaml,/networking/v1/dns-forwarders,createNetworkingV1DnsForwarder,create_networking_v1_dns_forwarder,post,,DNS Forwarders (networking/v1),dns forwarders (networking/v1),dns_forwarders,create_networking_v1_dns_forwarder,insert,,Create a DNS Forwarder +networking.yaml,/networking/v1/dns-forwarders,listNetworkingV1DnsForwarders,list_networking_v1_dns_forwarders,get,,DNS Forwarders (networking/v1),dns forwarders (networking/v1),dns_forwarders,list_networking_v1_dns_forwarders,select,$.data,List of DNS Forwarders +networking.yaml,/networking/v1/dns-forwarders/{id},deleteNetworkingV1DnsForwarder,delete_networking_v1_dns_forwarder,delete,,DNS Forwarders (networking/v1),dns forwarders (networking/v1),dns_forwarders,delete_networking_v1_dns_forwarder,delete,,Delete a DNS Forwarder +networking.yaml,/networking/v1/dns-forwarders/{id},getNetworkingV1DnsForwarder,get_networking_v1_dns_forwarder,get,,DNS Forwarders (networking/v1),dns forwarders (networking/v1),dns_forwarders,get_networking_v1_dns_forwarder,select,,Read a DNS Forwarder +networking.yaml,/networking/v1/dns-forwarders/{id},updateNetworkingV1DnsForwarder,update_networking_v1_dns_forwarder,patch,,DNS Forwarders (networking/v1),dns forwarders (networking/v1),dns_forwarders,update_networking_v1_dns_forwarder,update,,Update a DNS Forwarder +networking.yaml,/networking/v1/dns-records,createNetworkingV1DnsRecord,create_networking_v1_dns_record,post,,DNS Records (networking/v1),dns records (networking/v1),dns_records,create_networking_v1_dns_record,insert,,Create a DNS Record +networking.yaml,/networking/v1/dns-records,listNetworkingV1DnsRecords,list_networking_v1_dns_records,get,,DNS Records (networking/v1),dns records (networking/v1),dns_records,list_networking_v1_dns_records,select,$.data,List of DNS Records +networking.yaml,/networking/v1/dns-records/{id},deleteNetworkingV1DnsRecord,delete_networking_v1_dns_record,delete,,DNS Records (networking/v1),dns records (networking/v1),dns_records,delete_networking_v1_dns_record,delete,,Delete a DNS Record +networking.yaml,/networking/v1/dns-records/{id},getNetworkingV1DnsRecord,get_networking_v1_dns_record,get,,DNS Records (networking/v1),dns records (networking/v1),dns_records,get_networking_v1_dns_record,select,,Read a DNS Record +networking.yaml,/networking/v1/dns-records/{id},updateNetworkingV1DnsRecord,update_networking_v1_dns_record,patch,,DNS Records (networking/v1),dns records (networking/v1),dns_records,update_networking_v1_dns_record,update,,Update a DNS Record +networking.yaml,/networking/v1/gateways,createNetworkingV1Gateway,create_networking_v1_gateway,post,,Gateways (networking/v1),gateways (networking/v1),gateways,create_networking_v1_gateway,insert,,Create a Gateway +networking.yaml,/networking/v1/gateways,listNetworkingV1Gateways,list_networking_v1_gateways,get,,Gateways (networking/v1),gateways (networking/v1),gateways,list_networking_v1_gateways,select,$.data,List of Gateways +networking.yaml,/networking/v1/gateways/{id},deleteNetworkingV1Gateway,delete_networking_v1_gateway,delete,,Gateways (networking/v1),gateways (networking/v1),gateways,delete_networking_v1_gateway,delete,,Delete a Gateway +networking.yaml,/networking/v1/gateways/{id},getNetworkingV1Gateway,get_networking_v1_gateway,get,,Gateways (networking/v1),gateways (networking/v1),gateways,get_networking_v1_gateway,select,,Read a Gateway +networking.yaml,/networking/v1/gateways/{id},updateNetworkingV1Gateway,update_networking_v1_gateway,patch,,Gateways (networking/v1),gateways (networking/v1),gateways,update_networking_v1_gateway,update,,Update a Gateway +networking.yaml,/networking/v1/ip-addresses,listNetworkingV1IpAddresses,list_networking_v1_ip_addresses,get,,IP Addresses (networking/v1),ip addresses (networking/v1),ip_addresses,list_networking_v1_ip_addresses,select,$.data,List of IP Addresses +networking.yaml,/networking/v1/network-link-endpoints,createNetworkingV1NetworkLinkEndpoint,create_networking_v1_network_link_endpoint,post,,Network Link Endpoints (networking/v1),network link endpoints (networking/v1),network_link_endpoints,create_networking_v1_network_link_endpoint,insert,,Create a Network Link Endpoint +networking.yaml,/networking/v1/network-link-endpoints,listNetworkingV1NetworkLinkEndpoints,list_networking_v1_network_link_endpoints,get,,Network Link Endpoints (networking/v1),network link endpoints (networking/v1),network_link_endpoints,list_networking_v1_network_link_endpoints,select,$.data,List of Network Link Endpoints +networking.yaml,/networking/v1/network-link-endpoints/{id},deleteNetworkingV1NetworkLinkEndpoint,delete_networking_v1_network_link_endpoint,delete,,Network Link Endpoints (networking/v1),network link endpoints (networking/v1),network_link_endpoints,delete_networking_v1_network_link_endpoint,delete,,Delete a Network Link Endpoint +networking.yaml,/networking/v1/network-link-endpoints/{id},getNetworkingV1NetworkLinkEndpoint,get_networking_v1_network_link_endpoint,get,,Network Link Endpoints (networking/v1),network link endpoints (networking/v1),network_link_endpoints,get_networking_v1_network_link_endpoint,select,,Read a Network Link Endpoint +networking.yaml,/networking/v1/network-link-endpoints/{id},updateNetworkingV1NetworkLinkEndpoint,update_networking_v1_network_link_endpoint,patch,,Network Link Endpoints (networking/v1),network link endpoints (networking/v1),network_link_endpoints,update_networking_v1_network_link_endpoint,update,,Update a Network Link Endpoint +networking.yaml,/networking/v1/network-link-service-associations,listNetworkingV1NetworkLinkServiceAssociations,list_networking_v1_network_link_service_associations,get,,Network Link Service Associations (networking/v1),network link service associations (networking/v1),network_link_service_associations,list_networking_v1_network_link_service_associations,select,$.data,List of Network Link Service Associations +networking.yaml,/networking/v1/network-link-service-associations/{id},getNetworkingV1NetworkLinkServiceAssociation,get_networking_v1_network_link_service_association,get,,Network Link Service Associations (networking/v1),network link service associations (networking/v1),network_link_service_associations,get_networking_v1_network_link_service_association,select,,Read a Network Link Service Association +networking.yaml,/networking/v1/network-link-services,createNetworkingV1NetworkLinkService,create_networking_v1_network_link_service,post,,Network Link Services (networking/v1),network link services (networking/v1),network_link_services,create_networking_v1_network_link_service,insert,,Create a Network Link Service +networking.yaml,/networking/v1/network-link-services,listNetworkingV1NetworkLinkServices,list_networking_v1_network_link_services,get,,Network Link Services (networking/v1),network link services (networking/v1),network_link_services,list_networking_v1_network_link_services,select,$.data,List of Network Link Services +networking.yaml,/networking/v1/network-link-services/{id},deleteNetworkingV1NetworkLinkService,delete_networking_v1_network_link_service,delete,,Network Link Services (networking/v1),network link services (networking/v1),network_link_services,delete_networking_v1_network_link_service,delete,,Delete a Network Link Service +networking.yaml,/networking/v1/network-link-services/{id},getNetworkingV1NetworkLinkService,get_networking_v1_network_link_service,get,,Network Link Services (networking/v1),network link services (networking/v1),network_link_services,get_networking_v1_network_link_service,select,,Read a Network Link Service +networking.yaml,/networking/v1/network-link-services/{id},updateNetworkingV1NetworkLinkService,update_networking_v1_network_link_service,patch,,Network Link Services (networking/v1),network link services (networking/v1),network_link_services,update_networking_v1_network_link_service,update,,Update a Network Link Service +networking.yaml,/networking/v1/networks,createNetworkingV1Network,create_networking_v1_network,post,,Networks (networking/v1),networks (networking/v1),networks,create_networking_v1_network,insert,,Create a Network +networking.yaml,/networking/v1/networks,listNetworkingV1Networks,list_networking_v1_networks,get,,Networks (networking/v1),networks (networking/v1),networks,list_networking_v1_networks,select,$.data,List of Networks +networking.yaml,/networking/v1/networks/{id},deleteNetworkingV1Network,delete_networking_v1_network,delete,,Networks (networking/v1),networks (networking/v1),networks,delete_networking_v1_network,delete,,Delete a Network +networking.yaml,/networking/v1/networks/{id},getNetworkingV1Network,get_networking_v1_network,get,,Networks (networking/v1),networks (networking/v1),networks,get_networking_v1_network,select,,Read a Network +networking.yaml,/networking/v1/networks/{id},updateNetworkingV1Network,update_networking_v1_network,patch,,Networks (networking/v1),networks (networking/v1),networks,update_networking_v1_network,update,,Update a Network +networking.yaml,/networking/v1/peerings,createNetworkingV1Peering,create_networking_v1_peering,post,,Peerings (networking/v1),peerings (networking/v1),peerings,create_networking_v1_peering,insert,,Create a Peering +networking.yaml,/networking/v1/peerings,listNetworkingV1Peerings,list_networking_v1_peerings,get,,Peerings (networking/v1),peerings (networking/v1),peerings,list_networking_v1_peerings,select,$.data,List of Peerings +networking.yaml,/networking/v1/peerings/{id},deleteNetworkingV1Peering,delete_networking_v1_peering,delete,,Peerings (networking/v1),peerings (networking/v1),peerings,delete_networking_v1_peering,delete,,Delete a Peering +networking.yaml,/networking/v1/peerings/{id},getNetworkingV1Peering,get_networking_v1_peering,get,,Peerings (networking/v1),peerings (networking/v1),peerings,get_networking_v1_peering,select,,Read a Peering +networking.yaml,/networking/v1/peerings/{id},updateNetworkingV1Peering,update_networking_v1_peering,patch,,Peerings (networking/v1),peerings (networking/v1),peerings,update_networking_v1_peering,update,,Update a Peering +networking.yaml,/networking/v1/private-link-accesses,createNetworkingV1PrivateLinkAccess,create_networking_v1_private_link_access,post,,Private Link Accesses (networking/v1),private link accesses (networking/v1),private_link_accesses,create_networking_v1_private_link_access,insert,,Create a Private Link Access +networking.yaml,/networking/v1/private-link-accesses,listNetworkingV1PrivateLinkAccesses,list_networking_v1_private_link_accesses,get,,Private Link Accesses (networking/v1),private link accesses (networking/v1),private_link_accesses,list_networking_v1_private_link_accesses,select,$.data,List of Private Link Accesses +networking.yaml,/networking/v1/private-link-accesses/{id},deleteNetworkingV1PrivateLinkAccess,delete_networking_v1_private_link_access,delete,,Private Link Accesses (networking/v1),private link accesses (networking/v1),private_link_accesses,delete_networking_v1_private_link_access,delete,,Delete a Private Link Access +networking.yaml,/networking/v1/private-link-accesses/{id},getNetworkingV1PrivateLinkAccess,get_networking_v1_private_link_access,get,,Private Link Accesses (networking/v1),private link accesses (networking/v1),private_link_accesses,get_networking_v1_private_link_access,select,,Read a Private Link Access +networking.yaml,/networking/v1/private-link-accesses/{id},updateNetworkingV1PrivateLinkAccess,update_networking_v1_private_link_access,patch,,Private Link Accesses (networking/v1),private link accesses (networking/v1),private_link_accesses,update_networking_v1_private_link_access,update,,Update a Private Link Access +networking.yaml,/networking/v1/private-link-attachment-connections,createNetworkingV1PrivateLinkAttachmentConnection,create_networking_v1_private_link_attachment_connection,post,,Private Link Attachment Connections (networking/v1),private link attachment connections (networking/v1),private_link_attachment_connections,create_networking_v1_private_link_attachment_connection,insert,,Create a Private Link Attachment Connection +networking.yaml,/networking/v1/private-link-attachment-connections,listNetworkingV1PrivateLinkAttachmentConnections,list_networking_v1_private_link_attachment_connections,get,,Private Link Attachment Connections (networking/v1),private link attachment connections (networking/v1),private_link_attachment_connections,list_networking_v1_private_link_attachment_connections,select,$.data,List of Private Link Attachment Connections +networking.yaml,/networking/v1/private-link-attachment-connections/{id},deleteNetworkingV1PrivateLinkAttachmentConnection,delete_networking_v1_private_link_attachment_connection,delete,,Private Link Attachment Connections (networking/v1),private link attachment connections (networking/v1),private_link_attachment_connections,delete_networking_v1_private_link_attachment_connection,delete,,Delete a Private Link Attachment Connection +networking.yaml,/networking/v1/private-link-attachment-connections/{id},getNetworkingV1PrivateLinkAttachmentConnection,get_networking_v1_private_link_attachment_connection,get,,Private Link Attachment Connections (networking/v1),private link attachment connections (networking/v1),private_link_attachment_connections,get_networking_v1_private_link_attachment_connection,select,,Read a Private Link Attachment Connection +networking.yaml,/networking/v1/private-link-attachment-connections/{id},updateNetworkingV1PrivateLinkAttachmentConnection,update_networking_v1_private_link_attachment_connection,patch,,Private Link Attachment Connections (networking/v1),private link attachment connections (networking/v1),private_link_attachment_connections,update_networking_v1_private_link_attachment_connection,update,,Update a Private Link Attachment Connection +networking.yaml,/networking/v1/private-link-attachments,createNetworkingV1PrivateLinkAttachment,create_networking_v1_private_link_attachment,post,,Private Link Attachments (networking/v1),private link attachments (networking/v1),private_link_attachments,create_networking_v1_private_link_attachment,insert,,Create a Private Link Attachment +networking.yaml,/networking/v1/private-link-attachments,listNetworkingV1PrivateLinkAttachments,list_networking_v1_private_link_attachments,get,,Private Link Attachments (networking/v1),private link attachments (networking/v1),private_link_attachments,list_networking_v1_private_link_attachments,select,$.data,List of Private Link Attachments +networking.yaml,/networking/v1/private-link-attachments/{id},deleteNetworkingV1PrivateLinkAttachment,delete_networking_v1_private_link_attachment,delete,,Private Link Attachments (networking/v1),private link attachments (networking/v1),private_link_attachments,delete_networking_v1_private_link_attachment,delete,,Delete a Private Link Attachment +networking.yaml,/networking/v1/private-link-attachments/{id},getNetworkingV1PrivateLinkAttachment,get_networking_v1_private_link_attachment,get,,Private Link Attachments (networking/v1),private link attachments (networking/v1),private_link_attachments,get_networking_v1_private_link_attachment,select,,Read a Private Link Attachment +networking.yaml,/networking/v1/private-link-attachments/{id},updateNetworkingV1PrivateLinkAttachment,update_networking_v1_private_link_attachment,patch,,Private Link Attachments (networking/v1),private link attachments (networking/v1),private_link_attachments,update_networking_v1_private_link_attachment,update,,Update a Private Link Attachment +networking.yaml,/networking/v1/transit-gateway-attachments,createNetworkingV1TransitGatewayAttachment,create_networking_v1_transit_gateway_attachment,post,,Transit Gateway Attachments (networking/v1),transit gateway attachments (networking/v1),transit_gateway_attachments,create_networking_v1_transit_gateway_attachment,insert,,Create a Transit Gateway Attachment +networking.yaml,/networking/v1/transit-gateway-attachments,listNetworkingV1TransitGatewayAttachments,list_networking_v1_transit_gateway_attachments,get,,Transit Gateway Attachments (networking/v1),transit gateway attachments (networking/v1),transit_gateway_attachments,list_networking_v1_transit_gateway_attachments,select,$.data,List of Transit Gateway Attachments +networking.yaml,/networking/v1/transit-gateway-attachments/{id},deleteNetworkingV1TransitGatewayAttachment,delete_networking_v1_transit_gateway_attachment,delete,,Transit Gateway Attachments (networking/v1),transit gateway attachments (networking/v1),transit_gateway_attachments,delete_networking_v1_transit_gateway_attachment,delete,,Delete a Transit Gateway Attachment +networking.yaml,/networking/v1/transit-gateway-attachments/{id},getNetworkingV1TransitGatewayAttachment,get_networking_v1_transit_gateway_attachment,get,,Transit Gateway Attachments (networking/v1),transit gateway attachments (networking/v1),transit_gateway_attachments,get_networking_v1_transit_gateway_attachment,select,,Read a Transit Gateway Attachment +networking.yaml,/networking/v1/transit-gateway-attachments/{id},updateNetworkingV1TransitGatewayAttachment,update_networking_v1_transit_gateway_attachment,patch,,Transit Gateway Attachments (networking/v1),transit gateway attachments (networking/v1),transit_gateway_attachments,update_networking_v1_transit_gateway_attachment,update,,Update a Transit Gateway Attachment +notifications.yaml,/notifications/v1/integrations,createNotificationsV1Integration,create_notifications_v1_integration,post,,Integrations (notifications/v1),integrations (notifications/v1),integrations,create_notifications_v1_integration,insert,,Create an Integration +notifications.yaml,/notifications/v1/integrations,listNotificationsV1Integrations,list_notifications_v1_integrations,get,,Integrations (notifications/v1),integrations (notifications/v1),integrations,list_notifications_v1_integrations,select,$.data,List of Integrations +notifications.yaml,/notifications/v1/integrations/{id},deleteNotificationsV1Integration,delete_notifications_v1_integration,delete,,Integrations (notifications/v1),integrations (notifications/v1),integrations,delete_notifications_v1_integration,delete,,Delete an Integration +notifications.yaml,/notifications/v1/integrations/{id},getNotificationsV1Integration,get_notifications_v1_integration,get,,Integrations (notifications/v1),integrations (notifications/v1),integrations,get_notifications_v1_integration,select,,Read an Integration +notifications.yaml,/notifications/v1/integrations/{id},updateNotificationsV1Integration,update_notifications_v1_integration,patch,,Integrations (notifications/v1),integrations (notifications/v1),integrations,update_notifications_v1_integration,update,,Update an Integration +notifications.yaml,/notifications/v1/integrations:test,testNotificationsV1Integration,test_notifications_v1_integration,post,,Integrations (notifications/v1),integrations (notifications/v1),integrations,test_notifications_v1_integration,exec,,"Test a Webhook, Slack or Microsoft Teams integration" +notifications.yaml,/notifications/v1/notification-types,listNotificationsV1NotificationTypes,list_notifications_v1_notification_types,get,,Notification Types (notifications/v1),notification types (notifications/v1),notification_types,list_notifications_v1_notification_types,select,$.data,Retrieve a list of all notification types for the resource type. +notifications.yaml,/notifications/v1/notification-types/{id},getNotificationsV1NotificationType,get_notifications_v1_notification_type,get,,Notification Types (notifications/v1),notification types (notifications/v1),notification_types,get_notifications_v1_notification_type,select,,Read a Notification Type +notifications.yaml,/notifications/v1/resource-preferences,createNotificationsV1ResourcePreference,create_notifications_v1_resource_preference,post,,Resource Preferences (notifications/v1),resource preferences (notifications/v1),resource_preferences,create_notifications_v1_resource_preference,insert,,Create a Resource Preference +notifications.yaml,/notifications/v1/resource-preferences/{id},deleteNotificationsV1ResourcePreference,delete_notifications_v1_resource_preference,delete,,Resource Preferences (notifications/v1),resource preferences (notifications/v1),resource_preferences,delete_notifications_v1_resource_preference,delete,,Delete a Resource Preference +notifications.yaml,/notifications/v1/resource-preferences/{id},getNotificationsV1ResourcePreference,get_notifications_v1_resource_preference,get,,Resource Preferences (notifications/v1),resource preferences (notifications/v1),resource_preferences,get_notifications_v1_resource_preference,select,,Read a Resource Preference +notifications.yaml,/notifications/v1/resource-preferences/{id},updateNotificationsV1ResourcePreference,update_notifications_v1_resource_preference,patch,,Resource Preferences (notifications/v1),resource preferences (notifications/v1),resource_preferences,update_notifications_v1_resource_preference,update,,Update a Resource Preference +notifications.yaml,/notifications/v1/resource-preferences:lookup,getNotificationsV1ResourcePreferenceByFilter,get_notifications_v1_resource_preference_by_filter,get,,Resource Preferences (notifications/v1),resource preferences (notifications/v1),resource_preferences,get_notifications_v1_resource_preference_by_filter,select,,Lookup a resource preference by filter (returns one) +notifications.yaml,/notifications/v1/resource-subscriptions,createNotificationsV1ResourceSubscription,create_notifications_v1_resource_subscription,post,,Resource Subscriptions (notifications/v1),resource subscriptions (notifications/v1),resource_subscriptions,create_notifications_v1_resource_subscription,insert,,Create a Resource Subscription +notifications.yaml,/notifications/v1/resource-subscriptions/{id},deleteNotificationsV1ResourceSubscription,delete_notifications_v1_resource_subscription,delete,,Resource Subscriptions (notifications/v1),resource subscriptions (notifications/v1),resource_subscriptions,delete_notifications_v1_resource_subscription,delete,,Delete a Resource Subscription +notifications.yaml,/notifications/v1/resource-subscriptions/{id},getNotificationsV1ResourceSubscription,get_notifications_v1_resource_subscription,get,,Resource Subscriptions (notifications/v1),resource subscriptions (notifications/v1),resource_subscriptions,get_notifications_v1_resource_subscription,select,,Read a Resource Subscription +notifications.yaml,/notifications/v1/resource-subscriptions/{id},updateNotificationsV1ResourceSubscription,update_notifications_v1_resource_subscription,patch,,Resource Subscriptions (notifications/v1),resource subscriptions (notifications/v1),resource_subscriptions,update_notifications_v1_resource_subscription,update,,Update a Resource Subscription +notifications.yaml,/notifications/v1/resource-subscriptions:lookup,listNotificationsV1ResourceSubscriptionsByFilter,list_notifications_v1_resource_subscriptions_by_filter,get,,Resource Subscriptions (notifications/v1),resource subscriptions (notifications/v1),resource_subscriptions,list_notifications_v1_resource_subscriptions_by_filter,select,$.data,Lookup a list of resource subscription by filter +notifications.yaml,/notifications/v1/subscriptions,createNotificationsV1Subscription,create_notifications_v1_subscription,post,,Subscriptions (notifications/v1),subscriptions (notifications/v1),subscriptions,create_notifications_v1_subscription,insert,,Create a Subscription +notifications.yaml,/notifications/v1/subscriptions,listNotificationsV1Subscriptions,list_notifications_v1_subscriptions,get,,Subscriptions (notifications/v1),subscriptions (notifications/v1),subscriptions,list_notifications_v1_subscriptions,select,$.data,List of Subscriptions +notifications.yaml,/notifications/v1/subscriptions/{id},deleteNotificationsV1Subscription,delete_notifications_v1_subscription,delete,,Subscriptions (notifications/v1),subscriptions (notifications/v1),subscriptions,delete_notifications_v1_subscription,delete,,Delete a Subscription +notifications.yaml,/notifications/v1/subscriptions/{id},getNotificationsV1Subscription,get_notifications_v1_subscription,get,,Subscriptions (notifications/v1),subscriptions (notifications/v1),subscriptions,get_notifications_v1_subscription,select,,Read a Subscription +notifications.yaml,/notifications/v1/subscriptions/{id},updateNotificationsV1Subscription,update_notifications_v1_subscription,patch,,Subscriptions (notifications/v1),subscriptions (notifications/v1),subscriptions,update_notifications_v1_subscription,update,,Update a Subscription +org.yaml,/org/v2/environments,createOrgV2Environment,create_org_v2_environment,post,,Environments (org/v2),environments (org/v2),environments,create_org_v2_environment,insert,,Create an Environment +org.yaml,/org/v2/environments,listOrgV2Environments,list_org_v2_environments,get,,Environments (org/v2),environments (org/v2),environments,list_org_v2_environments,select,$.data,List of Environments +org.yaml,/org/v2/environments/{id},deleteOrgV2Environment,delete_org_v2_environment,delete,,Environments (org/v2),environments (org/v2),environments,delete_org_v2_environment,delete,,Delete an Environment +org.yaml,/org/v2/environments/{id},getOrgV2Environment,get_org_v2_environment,get,,Environments (org/v2),environments (org/v2),environments,get_org_v2_environment,select,,Read an Environment +org.yaml,/org/v2/environments/{id},updateOrgV2Environment,update_org_v2_environment,patch,,Environments (org/v2),environments (org/v2),environments,update_org_v2_environment,update,,Update an Environment +org.yaml,/org/v2/organizations,listOrgV2Organizations,list_org_v2_organizations,get,,Organizations (org/v2),organizations (org/v2),organizations,list_org_v2_organizations,select,$.data,List of Organizations +org.yaml,/org/v2/organizations/{id},getOrgV2Organization,get_org_v2_organization,get,,Organizations (org/v2),organizations (org/v2),organizations,get_org_v2_organization,select,,Read an Organization +org.yaml,/org/v2/organizations/{id},updateOrgV2Organization,update_org_v2_organization,patch,,Organizations (org/v2),organizations (org/v2),organizations,update_org_v2_organization,update,,Update an Organization +partner.yaml,/partner/v2/entitlements,createPartnerV2Entitlement,create_partner_v2_entitlement,post,,Entitlements (partner/v2),entitlements (partner/v2),entitlements,create_partner_v2_entitlement,insert,,Create an Entitlement +partner.yaml,/partner/v2/entitlements,listPartnerV2Entitlements,list_partner_v2_entitlements,get,partner.v2.EntitlementList,Entitlements (partner/v2),entitlements (partner/v2),entitlements,list_partner_v2_entitlements,select,$.data,List of Entitlements +partner.yaml,/partner/v2/entitlements/{id},getPartnerV2Entitlement,get_partner_v2_entitlement,get,,Entitlements (partner/v2),entitlements (partner/v2),entitlements,get_partner_v2_entitlement,select,,Read an Entitlement +partner.yaml,/partner/v2/organizations,listPartnerV2Organizations,list_partner_v2_organizations,get,partner.v2.OrganizationList,Organizations (partner/v2),organizations (partner/v2),organizations,list_partner_v2_organizations,select,$.data,List of Organizations +partner.yaml,/partner/v2/organizations/{id},getPartnerV2Organization,get_partner_v2_organization,get,,Organizations (partner/v2),organizations (partner/v2),organizations,get_partner_v2_organization,select,,Read an Organization +partner.yaml,/partner/v2/signup,signup,signup,post,PartnerSignupResponse,Signup (partner/v2),signup (partner/v2),signups,signup,exec,,Signup an Organization on behalf of a Customer +partner.yaml,/partner/v2/signup/activate,activateSignup,activate_signup,post,PartnerSignupResponse,Signup (partner/v2),signup (partner/v2),signups,activate_signup,exec,,Activate an Incomplete Signup +partner.yaml,/partner/v2/signup/link,signupPartnerV2Link,signup_partner_v2_link,post,PartnerSignupResponse,Signup (partner/v2),signup (partner/v2),signups,signup_partner_v2_link,exec,,Signup a Customer by Linking to an Existing Organization +provider_integrations.yaml,/pim/v1/integrations,createPimV1Integration,create_pim_v1_integration,post,,Integrations (pim/v1),integrations (pim/v1),integrations_v1,create_pim_v1_integration,insert,,Create an Integration +provider_integrations.yaml,/pim/v1/integrations,listPimV1Integrations,list_pim_v1_integrations,get,,Integrations (pim/v1),integrations (pim/v1),integrations_v1,list_pim_v1_integrations,select,$.data,List of Integrations +provider_integrations.yaml,/pim/v1/integrations/{id},deletePimV1Integration,delete_pim_v1_integration,delete,,Integrations (pim/v1),integrations (pim/v1),integrations_v1,delete_pim_v1_integration,delete,,Delete an Integration +provider_integrations.yaml,/pim/v1/integrations/{id},getPimV1Integration,get_pim_v1_integration,get,,Integrations (pim/v1),integrations (pim/v1),integrations_v1,get_pim_v1_integration,select,,Read an Integration +provider_integrations.yaml,/pim/v2/integrations,createPimV2Integration,create_pim_v2_integration,post,,Integrations (pim/v2),integrations (pim/v2),integrations_v2,create_pim_v2_integration,insert,,Create an Integration +provider_integrations.yaml,/pim/v2/integrations,listPimV2Integrations,list_pim_v2_integrations,get,,Integrations (pim/v2),integrations (pim/v2),integrations_v2,list_pim_v2_integrations,select,$.data,List of Integrations +provider_integrations.yaml,/pim/v2/integrations/{id},updatePimV2Integration,update_pim_v2_integration,patch,,Integrations (pim/v2),integrations (pim/v2),integrations,update_pim_v2_integration,update,,Update an Integration +provider_integrations.yaml,/pim/v2/integrations/{id},deletePimV2Integration,delete_pim_v2_integration,delete,,Integrations (pim/v2),integrations (pim/v2),integrations_v2,delete_pim_v2_integration,delete,,Delete an Integration +provider_integrations.yaml,/pim/v2/integrations/{id},getPimV2Integration,get_pim_v2_integration,get,,Integrations (pim/v2),integrations (pim/v2),integrations_v2,get_pim_v2_integration,select,,Read an Integration +provider_integrations.yaml,/pim/v2/integrations:validate,validatePimV2Integration,validate_pim_v2_integration,post,,Integrations (pim/v2),integrations (pim/v2),integrations,validate_pim_v2_integration,exec,,Validate an Integration +quotas.yaml,/kafka-quotas/v1/client-quotas,createKafkaQuotasV1ClientQuota,create_kafka_quotas_v1_client_quota,post,,Client Quotas (kafka-quotas/v1),client quotas (kafka_quotas/v1),client_quotas,create_kafka_quotas_v1_client_quota,insert,,Create a Client Quota +quotas.yaml,/kafka-quotas/v1/client-quotas,listKafkaQuotasV1ClientQuotas,list_kafka_quotas_v1_client_quotas,get,,Client Quotas (kafka-quotas/v1),client quotas (kafka_quotas/v1),client_quotas,list_kafka_quotas_v1_client_quotas,select,$.data,List of Client Quotas +quotas.yaml,/kafka-quotas/v1/client-quotas/{id},deleteKafkaQuotasV1ClientQuota,delete_kafka_quotas_v1_client_quota,delete,,Client Quotas (kafka-quotas/v1),client quotas (kafka_quotas/v1),client_quotas,delete_kafka_quotas_v1_client_quota,delete,,Delete a Client Quota +quotas.yaml,/kafka-quotas/v1/client-quotas/{id},getKafkaQuotasV1ClientQuota,get_kafka_quotas_v1_client_quota,get,,Client Quotas (kafka-quotas/v1),client quotas (kafka_quotas/v1),client_quotas,get_kafka_quotas_v1_client_quota,select,,Read a Client Quota +quotas.yaml,/kafka-quotas/v1/client-quotas/{id},updateKafkaQuotasV1ClientQuota,update_kafka_quotas_v1_client_quota,patch,,Client Quotas (kafka-quotas/v1),client quotas (kafka_quotas/v1),client_quotas,update_kafka_quotas_v1_client_quota,update,,Update a Client Quota +quotas.yaml,/service-quota/v1/applied-quotas,listServiceQuotaV1AppliedQuotas,list_service_quota_v1_applied_quotas,get,,Applied Quotas (service-quota/v1),applied quotas (service_quota/v1),applied_quotas,list_service_quota_v1_applied_quotas,select,$.data,List of Applied Quotas +quotas.yaml,/service-quota/v1/applied-quotas/{id},getServiceQuotaV1AppliedQuota,get_service_quota_v1_applied_quota,get,,Applied Quotas (service-quota/v1),applied quotas (service_quota/v1),applied_quotas,get_service_quota_v1_applied_quota,select,,Read an Applied Quota +quotas.yaml,/service-quota/v1/scopes,listServiceQuotaV1Scopes,list_service_quota_v1_scopes,get,,Scopes (service-quota/v1),scopes (service_quota/v1),scopes,list_service_quota_v1_scopes,select,$.data,List of Scopes +quotas.yaml,/service-quota/v1/scopes/{id},getServiceQuotaV1Scope,get_service_quota_v1_scope,get,,Scopes (service-quota/v1),scopes (service_quota/v1),scopes,get_service_quota_v1_scope,select,,Read a Scope +schema_registry.yaml,/clusterconfig,getClusterConfig,get_cluster_config,get,,Config (v1),config (v1),cluster_config,get_cluster_config,select,,Get cluster config +schema_registry.yaml,/compatibility/subjects/{subject}/versions,testCompatibilityForSubject,test_compatibility_for_subject,post,,Compatibility (v1),compatibility (v1),compatibilities,test_compatibility_for_subject,exec,,Test schema compatibility against all schemas under a subject +schema_registry.yaml,/compatibility/subjects/{subject}/versions/{version},testCompatibilityBySubjectName,test_compatibility_by_subject_name,post,,Compatibility (v1),compatibility (v1),compatibilities,test_compatibility_by_subject_name,exec,,Test schema compatibility against a particular schema subject-version +schema_registry.yaml,/config,deleteTopLevelConfig,delete_top_level_config,delete,,Config (v1),config (v1),top_level_config,delete_top_level_config,delete,,Delete global compatibility level +schema_registry.yaml,/config,updateTopLevelConfig,update_top_level_config,put,,Config (v1),config (v1),top_level_config,update_top_level_config,replace,,Update global compatibility level +schema_registry.yaml,/config,getTopLevelConfig,get_top_level_config,get,,Config (v1),config (v1),top_level_config,get_top_level_config,select,,Get global compatibility level +schema_registry.yaml,/config/{subject},deleteSubjectConfig,delete_subject_config,delete,,Config (v1),config (v1),subject_level_config,delete_subject_config,delete,,Delete subject compatibility level +schema_registry.yaml,/config/{subject},updateSubjectLevelConfig,update_subject_level_config,put,,Config (v1),config (v1),subject_level_config,update_subject_level_config,replace,,Update subject compatibility level +schema_registry.yaml,/config/{subject},getSubjectLevelConfig,get_subject_level_config,get,,Config (v1),config (v1),subject_level_config,get_subject_level_config,select,,Get subject compatibility level +schema_registry.yaml,/contexts,listContexts,list_contexts,get,,Contexts (v1),contexts (v1),contexts,list_contexts,select,$,List contexts +schema_registry.yaml,/exporters,registerExporter,register_exporter,post,,Exporters (v1),exporters (v1),exporters,register_exporter,insert,,Creates a new schema exporter +schema_registry.yaml,/exporters,listExporters,list_exporters,get,,Exporters (v1),exporters (v1),exporters,list_exporters,select,$,Gets all schema exporters +schema_registry.yaml,/exporters/{name},deleteExporter,delete_exporter,delete,,Exporters (v1),exporters (v1),exporters,delete_exporter,delete,,Delete schema exporter by name +schema_registry.yaml,/exporters/{name},updateExporterInfo,update_exporter_info,put,,Exporters (v1),exporters (v1),exporters,update_exporter_info,replace,,Update schema exporter by name +schema_registry.yaml,/exporters/{name},getExporterInfoByName,get_exporter_info_by_name,get,,Exporters (v1),exporters (v1),exporters,get_exporter_info_by_name,select,,Gets schema exporter by name +schema_registry.yaml,/exporters/{name}/config,updateExporterConfigByName,update_exporter_config_by_name,put,,Exporters (v1),exporters (v1),exporter_configs,update_exporter_config_by_name,replace,,Update schema exporter config by name +schema_registry.yaml,/exporters/{name}/config,getExporterConfigByName,get_exporter_config_by_name,get,,Exporters (v1),exporters (v1),exporter_configs,get_exporter_config_by_name,select,,Gets schema exporter config by name +schema_registry.yaml,/exporters/{name}/pause,pauseExporterByName,pause_exporter_by_name,put,,Exporters (v1),exporters (v1),exporters,pause_exporter_by_name,exec,,Pause schema exporter by name +schema_registry.yaml,/exporters/{name}/reset,resetExporterByName,reset_exporter_by_name,put,,Exporters (v1),exporters (v1),exporters,reset_exporter_by_name,exec,,Reset schema exporter by name +schema_registry.yaml,/exporters/{name}/resume,resumeExporterByName,resume_exporter_by_name,put,,Exporters (v1),exporters (v1),exporters,resume_exporter_by_name,exec,,Resume schema exporter by name +schema_registry.yaml,/exporters/{name}/status,getExporterStatusByName,get_exporter_status_by_name,get,,Exporters (v1),exporters (v1),exporter_status,get_exporter_status_by_name,select,,Gets schema exporter status by name +schema_registry.yaml,/mode,updateTopLevelMode,update_top_level_mode,put,,Modes (v1),modes (v1),modes,update_top_level_mode,replace,,Update global mode +schema_registry.yaml,/mode,getTopLevelMode,get_top_level_mode,get,,Modes (v1),modes (v1),modes,get_top_level_mode,select,,Get global mode +schema_registry.yaml,/mode/{subject},deleteSubjectMode,delete_subject_mode,delete,,Modes (v1),modes (v1),modes,delete_subject_mode,delete,,Delete subject mode +schema_registry.yaml,/mode/{subject},updateMode,update_mode,put,,Modes (v1),modes (v1),modes,update_mode,replace,,Update subject mode +schema_registry.yaml,/mode/{subject},getMode,get_mode,get,,Modes (v1),modes (v1),modes,get_mode,select,,Get subject mode +schema_registry.yaml,/schemas,getSchemas,get_schemas,get,,Schemas (v1),schemas (v1),schemas,get_schemas,select,$,List schemas +schema_registry.yaml,/schemas/ids/{id},getSchema,get_schema,get,,Schemas (v1),schemas (v1),schemas,get_schema,select,,Get schema string by ID +schema_registry.yaml,/schemas/ids/{id}/schema,getSchemaOnly,get_schema_only,get,,Schemas (v1),schemas (v1),schemas,get_schema_only,exec,,Get schema by ID +schema_registry.yaml,/schemas/ids/{id}/subjects,getSubjects,get_subjects,get,,Schemas (v1),schemas (v1),subjects,get_subjects,select,$,List subjects associated to schema ID +schema_registry.yaml,/schemas/ids/{id}/versions,getVersions,get_versions,get,,Schemas (v1),schemas (v1),versions,get_versions,select,$,List subject-versions associated to schema ID +schema_registry.yaml,/schemas/types,getSchemaTypes,get_schema_types,get,,Schemas (v1),schemas (v1),types,get_schema_types,select,$,List supported schema types +schema_registry.yaml,/subjects,list,list,get,,Subjects (v1),subjects (v1),subjects,list,select,$,List subjects +schema_registry.yaml,/subjects/{subject},deleteSubject,delete_subject,delete,,Subjects (v1),subjects (v1),subjects,delete_subject,delete,,Delete subject +schema_registry.yaml,/subjects/{subject},lookUpSchemaUnderSubject,look_up_schema_under_subject,post,,Subjects (v1),subjects (v1),subjects,look_up_schema_under_subject,exec,,Lookup schema under subject +schema_registry.yaml,/subjects/{subject}/metadata,getLatestWithMetadata,get_latest_with_metadata,get,,Subjects (v1),subjects (v1),latest_version,get_latest_with_metadata,select,,Retrieve the latest version with the given metadata. +schema_registry.yaml,/subjects/{subject}/versions,register,register,post,,Subjects (v1),subjects (v1),versions,register,insert,,Register schema under a subject +schema_registry.yaml,/subjects/{subject}/versions,listVersions,list_versions,get,,Subjects (v1),subjects (v1),versions,list_versions,select,$,List versions under subject +schema_registry.yaml,/subjects/{subject}/versions/{version},getSchemaByVersion,get_schema_by_version,get,,Subjects (v1),subjects (v1),versions,get_schema_by_version,select,,Get schema by version +schema_registry.yaml,/subjects/{subject}/versions/{version},deleteSchemaVersion,delete_schema_version,delete,,Subjects (v1),subjects (v1),versions,delete_schema_version,delete,,Delete schema version +schema_registry.yaml,/subjects/{subject}/versions/{version}/referencedby,getReferencedBy,get_referenced_by,get,,Subjects (v1),subjects (v1),subjects_referenced_by,get_referenced_by,select,$,List schemas referencing a schema +schema_registry.yaml,/subjects/{subject}/versions/{version}/schema,getSchemaOnly_1,get_schema_only_1,get,,Subjects (v1),subjects (v1),schemas,get_schema_only_1,exec,,Get schema string by version +schema_registry_clusters.yaml,/srcm/v2/clusters,createSrcmV2Cluster,create_srcm_v2_cluster,post,,Clusters (srcm/v2),clusters (srcm/v2),v2_clusters,create_srcm_v2_cluster,insert,,Create a Cluster +schema_registry_clusters.yaml,/srcm/v2/clusters,listSrcmV2Clusters,list_srcm_v2_clusters,get,,Clusters (srcm/v2),clusters (srcm/v2),v2_clusters,list_srcm_v2_clusters,select,$.data,List of Clusters +schema_registry_clusters.yaml,/srcm/v2/clusters/{id},deleteSrcmV2Cluster,delete_srcm_v2_cluster,delete,,Clusters (srcm/v2),clusters (srcm/v2),v2_clusters,delete_srcm_v2_cluster,delete,,Delete a Cluster +schema_registry_clusters.yaml,/srcm/v2/clusters/{id},getSrcmV2Cluster,get_srcm_v2_cluster,get,,Clusters (srcm/v2),clusters (srcm/v2),v2_clusters,get_srcm_v2_cluster,select,,Read a Cluster +schema_registry_clusters.yaml,/srcm/v2/clusters/{id},updateSrcmV2Cluster,update_srcm_v2_cluster,patch,,Clusters (srcm/v2),clusters (srcm/v2),v2_clusters,update_srcm_v2_cluster,update,,Update a Cluster +schema_registry_clusters.yaml,/srcm/v2/regions,listSrcmV2Regions,list_srcm_v2_regions,get,,Regions (srcm/v2),regions (srcm/v2),regions,list_srcm_v2_regions,select,$.data,List of Regions +schema_registry_clusters.yaml,/srcm/v2/regions/{id},getSrcmV2Region,get_srcm_v2_region,get,,Regions (srcm/v2),regions (srcm/v2),regions,get_srcm_v2_region,select,,Read a Region +schema_registry_clusters.yaml,/srcm/v3/clusters,listSrcmV3Clusters,list_srcm_v3_clusters,get,,Clusters (srcm/v3),clusters (srcm/v3),v3_clusters,list_srcm_v3_clusters,select,$.data,List of Clusters +schema_registry_clusters.yaml,/srcm/v3/clusters/{id},getSrcmV3Cluster,get_srcm_v3_cluster,get,,Clusters (srcm/v3),clusters (srcm/v3),v3_clusters,get_srcm_v3_cluster,select,,Read a Cluster +share_group.yaml,/kafka/v3/clusters/{cluster_id}/share-groups,listKafkaShareGroups,list_kafka_share_groups,get,,Share Group (v3),share group (v3),share_groups,list_kafka_share_groups,select,$.data,List Share Groups +share_group.yaml,/kafka/v3/clusters/{cluster_id}/share-groups/{group_id},deleteKafkaShareGroup,delete_kafka_share_group,delete,,Share Group (v3),share group (v3),share_groups,delete_kafka_share_group,delete,,Delete Share Group +share_group.yaml,/kafka/v3/clusters/{cluster_id}/share-groups/{group_id},getKafkaShareGroup,get_kafka_share_group,get,,Share Group (v3),share group (v3),share_groups,get_kafka_share_group,select,,Get Share Group +share_group.yaml,/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers,listKafkaShareGroupConsumers,list_kafka_share_group_consumers,get,,Share Group (v3),share group (v3),consumers,list_kafka_share_group_consumers,select,$.data,List Share Group Consumers +share_group.yaml,/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id},getKafkaShareGroupConsumer,get_kafka_share_group_consumer,get,,Share Group (v3),share group (v3),consumers,get_kafka_share_group_consumer,select,,Get Share Group Consumer +share_group.yaml,/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}/assignments,listKafkaShareGroupConsumerAssignments,list_kafka_share_group_consumer_assignments,get,,Share Group (v3),share group (v3),consumer_assignments,list_kafka_share_group_consumer_assignments,select,$.data,List Share Group Consumer Assignments +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/agents,listSqlv1Agents,list_sqlv1_agents,get,sql.v1.AgentList,Agents (sql/v1),agents (sql/v1),agents,list_sqlv1_agents,select,$.data,List all agents +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections,createSqlv1Connection,create_sqlv1_connection,post,,Connections (sql/v1),connections (sql/v1),connections,create_sqlv1_connection,insert,,Create a Connection +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections,listSqlv1Connections,list_sqlv1_connections,get,sql.v1.ConnectionList,Connections (sql/v1),connections (sql/v1),connections,list_sqlv1_connections,select,$.data,List of Connections +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name},deleteSqlv1Connection,delete_sqlv1_connection,delete,,Connections (sql/v1),connections (sql/v1),connections,delete_sqlv1_connection,delete,,Delete a Connection +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name},updateSqlv1Connection,update_sqlv1_connection,put,,Connections (sql/v1),connections (sql/v1),connections,update_sqlv1_connection,replace,,Update a Connection +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name},getSqlv1Connection,get_sqlv1_connection,get,,Connections (sql/v1),connections (sql/v1),connections,get_sqlv1_connection,select,,Read a Connection +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools,createSqlv1Tool,create_sqlv1_tool,post,,Tools (sql/v1),tools (sql/v1),tools,create_sqlv1_tool,insert,,Create a Tool +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools,listSqlv1Tools,list_sqlv1_tools,get,sql.v1.ToolList,Tools (sql/v1),tools (sql/v1),tools,list_sqlv1_tools,select,$.data,List of Tools +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools/{tool_name},deleteSqlv1Tool,delete_sqlv1_tool,delete,,Tools (sql/v1),tools (sql/v1),tools,delete_sqlv1_tool,delete,,Delete a Tool +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools/{tool_name},getSqlv1Tool,get_sqlv1_tool,get,,Tools (sql/v1),tools (sql/v1),tools,get_sqlv1_tool,select,,Read a Tool +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents,createSqlv1Agent,create_sqlv1_agent,post,,Agents (sql/v1),agents (sql/v1),agents,create_sqlv1_agent,insert,,Create an Agent +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name},deleteSqlv1Agent,delete_sqlv1_agent,delete,,Agents (sql/v1),agents (sql/v1),agents,delete_sqlv1_agent,delete,,Delete an Agent +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name},updateSqlv1Agent,update_sqlv1_agent,put,sql.v1.Agent,Agents (sql/v1),agents (sql/v1),agents,update_sqlv1_agent,replace,,Alter an Agent +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name},getSqlv1Agent,get_sqlv1_agent,get,sql.v1.Agent,Agents (sql/v1),agents (sql/v1),agents,get_sqlv1_agent,select,,Read an Agent +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables,createSqlv1MaterializedTable,create_sqlv1_materialized_table,post,,Materialized Tables (sql/v1),materialized tables (sql/v1),materialized_tables,create_sqlv1_materialized_table,insert,,Create a materialized table +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name},deleteSqlv1MaterializedTable,delete_sqlv1_materialized_table,delete,,Materialized Tables (sql/v1),materialized tables (sql/v1),materialized_tables,delete_sqlv1_materialized_table,delete,,Delete a materialized table +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name},updateSqlv1MaterializedTable,update_sqlv1_materialized_table,put,sql.v1.MaterializedTable,Materialized Tables (sql/v1),materialized tables (sql/v1),materialized_tables,update_sqlv1_materialized_table,replace,,Update/Evolve a materialized table +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name},getSqlv1MaterializedTable,get_sqlv1_materialized_table,get,sql.v1.MaterializedTable,Materialized Tables (sql/v1),materialized tables (sql/v1),materialized_tables,get_sqlv1_materialized_table,select,,Read a materialized table +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions,listSqlv1MaterializedTableVersions,list_sqlv1_materialized_table_versions,get,sql.v1.MaterializedTableVersionList,Materialized Table Versions (sql/v1),materialized table versions (sql/v1),materialized_table_versions,list_sqlv1_materialized_table_versions,select,$.data,List all the versions of a materialized table +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions/{version},getSqlv1MaterializedTableVersion,get_sqlv1_materialized_table_version,get,sql.v1.MaterializedTableVersion,Materialized Table Versions (sql/v1),materialized table versions (sql/v1),materialized_table_versions,get_sqlv1_materialized_table_version,select,,Read a materialized table version +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/materialized-tables,listSqlv1MaterializedTables,list_sqlv1_materialized_tables,get,sql.v1.MaterializedTableList,Materialized Tables (sql/v1),materialized tables (sql/v1),materialized_tables,list_sqlv1_materialized_tables,select,$.data,List all materialized tables +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements,createSqlv1Statement,create_sqlv1_statement,post,,Statements (sql/v1),statements (sql/v1),statements,create_sqlv1_statement,insert,,Create a Statement +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements,listSqlv1Statements,list_sqlv1_statements,get,sql.v1.StatementList,Statements (sql/v1),statements (sql/v1),statements,list_sqlv1_statements,select,$.data,List of Statements +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name}/results,getSqlv1StatementResult,get_sqlv1_statement_result,get,,Statement Results (sql/v1),statement results (sql/v1),statement_results,get_sqlv1_statement_result,select,,Read Statement Result +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name},deleteSqlv1Statement,delete_sqlv1_statement,delete,,Statements (sql/v1),statements (sql/v1),statements,delete_sqlv1_statement,delete,,Delete a Statement +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name},updateSqlv1Statement,update_sqlv1_statement,put,,Statements (sql/v1),statements (sql/v1),statements,update_sqlv1_statement,replace,,Update a Statement +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name},getSqlv1Statement,get_sqlv1_statement,get,,Statements (sql/v1),statements (sql/v1),statements,get_sqlv1_statement,select,,Read a Statement +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name},patchSqlv1Statement,patch_sqlv1_statement,patch,,Statements (sql/v1),statements (sql/v1),statements,patch_sqlv1_statement,update,,Patch a Statement +sql.yaml,/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}/exceptions,getSqlv1StatementExceptions,get_sqlv1_statement_exceptions,get,sql.v1.StatementExceptionList,Statement Exceptions (sql/v1),statement exceptions (sql/v1),statement_exceptions,get_sqlv1_statement_exceptions,select,$.data,List of Statement Exceptions +stream_sharing.yaml,/cdx/v1/consumer-shared-resources,listCdxV1ConsumerSharedResources,list_cdx_v1_consumer_shared_resources,get,,Consumer Shared Resources (cdx/v1),consumer shared resources (cdx/v1),consumer_shared_resources,list_cdx_v1_consumer_shared_resources,select,$.data,List of Consumer Shared Resources +stream_sharing.yaml,/cdx/v1/consumer-shared-resources/{id},getCdxV1ConsumerSharedResource,get_cdx_v1_consumer_shared_resource,get,,Consumer Shared Resources (cdx/v1),consumer shared resources (cdx/v1),consumer_shared_resources,get_cdx_v1_consumer_shared_resource,select,,Read a Consumer Shared Resource +stream_sharing.yaml,/cdx/v1/consumer-shared-resources/{id}/images/{file_name},imageCdxV1ConsumerSharedResource,image_cdx_v1_consumer_shared_resource,get,,Consumer Shared Resources (cdx/v1),consumer shared resources (cdx/v1),consumer_shared_resources,image_cdx_v1_consumer_shared_resource,exec,,Get image for shared resource +stream_sharing.yaml,/cdx/v1/consumer-shared-resources/{id}:network,networkCdxV1ConsumerSharedResource,network_cdx_v1_consumer_shared_resource,get,cdx.v1.Network,Consumer Shared Resources (cdx/v1),consumer shared resources (cdx/v1),shared_resources_network_config,network_cdx_v1_consumer_shared_resource,select,,Get shared resource's network configuration +stream_sharing.yaml,/cdx/v1/consumer-shares,listCdxV1ConsumerShares,list_cdx_v1_consumer_shares,get,,Consumer Shares (cdx/v1),consumer shares (cdx/v1),consumer_shares,list_cdx_v1_consumer_shares,select,$.data,List of Consumer Shares +stream_sharing.yaml,/cdx/v1/consumer-shares/{id},deleteCdxV1ConsumerShare,delete_cdx_v1_consumer_share,delete,,Consumer Shares (cdx/v1),consumer shares (cdx/v1),consumer_shares,delete_cdx_v1_consumer_share,delete,,Delete a Consumer Share +stream_sharing.yaml,/cdx/v1/consumer-shares/{id},getCdxV1ConsumerShare,get_cdx_v1_consumer_share,get,,Consumer Shares (cdx/v1),consumer shares (cdx/v1),consumer_shares,get_cdx_v1_consumer_share,select,,Read a Consumer Share +stream_sharing.yaml,/cdx/v1/opt-in,getCdxV1OptIn,get_cdx_v1_opt_in,get,,Opt Ins (cdx/v1),opt ins (cdx/v1),opt_ins,get_cdx_v1_opt_in,select,,Read the organization's stream sharing opt-in settings +stream_sharing.yaml,/cdx/v1/opt-in,updateCdxV1OptIn,update_cdx_v1_opt_in,patch,,Opt Ins (cdx/v1),opt ins (cdx/v1),opt_ins,update_cdx_v1_opt_in,update,,Set the organization's stream sharing opt-in settings +stream_sharing.yaml,/cdx/v1/provider-shared-resources,listCdxV1ProviderSharedResources,list_cdx_v1_provider_shared_resources,get,,Provider Shared Resources (cdx/v1),provider shared resources (cdx/v1),provider_shared_resources,list_cdx_v1_provider_shared_resources,select,$.data,List of Provider Shared Resources +stream_sharing.yaml,/cdx/v1/provider-shared-resources/{id},getCdxV1ProviderSharedResource,get_cdx_v1_provider_shared_resource,get,,Provider Shared Resources (cdx/v1),provider shared resources (cdx/v1),provider_shared_resources,get_cdx_v1_provider_shared_resource,select,,Read a Provider Shared Resource +stream_sharing.yaml,/cdx/v1/provider-shared-resources/{id},updateCdxV1ProviderSharedResource,update_cdx_v1_provider_shared_resource,patch,,Provider Shared Resources (cdx/v1),provider shared resources (cdx/v1),provider_shared_resources,update_cdx_v1_provider_shared_resource,update,,Update a Provider Shared Resource +stream_sharing.yaml,/cdx/v1/provider-shared-resources/{id}/images/{file_name},delete_imageCdxV1ProviderSharedResource,delete_image_cdx_v1_provider_shared_resource,delete,,Provider Shared Resources (cdx/v1),provider shared resources (cdx/v1),provider_shared_resources,delete_image_cdx_v1_provider_shared_resource,delete,,Delete the shared resource's image +stream_sharing.yaml,/cdx/v1/provider-shared-resources/{id}/images/{file_name},upload_imageCdxV1ProviderSharedResource,upload_image_cdx_v1_provider_shared_resource,post,,Provider Shared Resources (cdx/v1),provider shared resources (cdx/v1),provider_shared_resources,upload_image_cdx_v1_provider_shared_resource,exec,,Upload image for shared resource +stream_sharing.yaml,/cdx/v1/provider-shared-resources/{id}/images/{file_name},view_imageCdxV1ProviderSharedResource,view_image_cdx_v1_provider_shared_resource,get,,Provider Shared Resources (cdx/v1),provider shared resources (cdx/v1),provider_shared_resources,view_image_cdx_v1_provider_shared_resource,exec,,Get image for shared resource +stream_sharing.yaml,/cdx/v1/provider-shares,createCdxV1ProviderShare,create_cdx_v1_provider_share,post,cdx.v1.ProviderShare,Provider Shares (cdx/v1),provider shares (cdx/v1),provider_shares,create_cdx_v1_provider_share,insert,,Create a provider share +stream_sharing.yaml,/cdx/v1/provider-shares,listCdxV1ProviderShares,list_cdx_v1_provider_shares,get,,Provider Shares (cdx/v1),provider shares (cdx/v1),provider_shares,list_cdx_v1_provider_shares,select,$.data,List of Provider Shares +stream_sharing.yaml,/cdx/v1/provider-shares/{id},deleteCdxV1ProviderShare,delete_cdx_v1_provider_share,delete,,Provider Shares (cdx/v1),provider shares (cdx/v1),provider_shares,delete_cdx_v1_provider_share,delete,,Delete a Provider Share +stream_sharing.yaml,/cdx/v1/provider-shares/{id},getCdxV1ProviderShare,get_cdx_v1_provider_share,get,,Provider Shares (cdx/v1),provider shares (cdx/v1),provider_shares,get_cdx_v1_provider_share,select,,Read a Provider Share +stream_sharing.yaml,/cdx/v1/provider-shares/{id}:resend,resendCdxV1ProviderShare,resend_cdx_v1_provider_share,post,,Provider Shares (cdx/v1),provider shares (cdx/v1),provider_shares,resend_cdx_v1_provider_share,exec,,Resend +stream_sharing.yaml,/cdx/v1/shared-tokens:redeem,redeemCdxV1SharedToken,redeem_cdx_v1_shared_token,post,cdx.v1.RedeemTokenResponse,Shared Tokens (cdx/v1),shared tokens (cdx/v1),shared_tokens,redeem_cdx_v1_shared_token,exec,,Redeem token +stream_sharing.yaml,/cdx/v1/shared-tokens:resources,resourcesCdxV1SharedToken,resources_cdx_v1_shared_token,post,,Shared Tokens (cdx/v1),shared tokens (cdx/v1),shared_tokens,resources_cdx_v1_shared_token,exec,,Validate token to view shared resources +streams_group.yaml,/kafka/v3/clusters/{cluster_id}/streams-groups,listKafkaStreamsGroups,list_kafka_streams_groups,get,,Streams Group (v3),streams group (v3),streams_groups,list_kafka_streams_groups,select,$.data,List Streams Groups +streams_group.yaml,/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id},getKafkaStreamsGroup,get_kafka_streams_group,get,,Streams Group (v3),streams group (v3),streams_groups,get_kafka_streams_group,select,,Get Streams Group +streams_group.yaml,/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members,listKafkaStreamsGroupMembers,list_kafka_streams_group_members,get,,Streams Group (v3),streams group (v3),members,list_kafka_streams_group_members,select,$.data,List Streams Group Members +streams_group.yaml,/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id},getKafkaStreamsGroupMember,get_kafka_streams_group_member,get,,Streams Group (v3),streams group (v3),members,get_kafka_streams_group_member,select,,Get Streams Group Member +streams_group.yaml,/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments,getKafkaStreamsGroupMemberAssignments,get_kafka_streams_group_member_assignments,get,,Streams Group (v3),streams group (v3),member_assignments,get_kafka_streams_group_member_assignments,select,,Get Streams Group Member Assignments +streams_group.yaml,/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type},listKafkaStreamsGroupMemberAssignmentTasks,list_kafka_streams_group_member_assignment_tasks,get,,Streams Group (v3),streams group (v3),member_assignment_tasks,list_kafka_streams_group_member_assignment_tasks,select,$.data,List Streams Group Assignments of a Specific Type +streams_group.yaml,/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}/subtopologies/{subtopology_id},getKafkaStreamsGroupMemberAssignmentTaskPartitions,get_kafka_streams_group_member_assignment_task_partitions,get,,Streams Group (v3),streams group (v3),member_assignment_task_partitions,get_kafka_streams_group_member_assignment_task_partitions,select,,List Streams Group Assignments Task Partitions of a Specific Type and Subtopology +streams_group.yaml,/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments,getKafkaStreamsGroupMemberTargetAssignments,get_kafka_streams_group_member_target_assignments,get,,Streams Group (v3),streams group (v3),member_target_assignments,get_kafka_streams_group_member_target_assignments,select,,Get Streams Group Member Target Assignments +streams_group.yaml,/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type},listKafkaStreamsGroupMemberTargetAssignmentTasks,list_kafka_streams_group_member_target_assignment_tasks,get,,Streams Group (v3),streams group (v3),member_target_assignment_tasks,list_kafka_streams_group_member_target_assignment_tasks,select,$.data,List Streams Group Target Assignments of a Specific Type +streams_group.yaml,/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}/subtopologies/{subtopology_id},getKafkaStreamsGroupMemberTargetAssignmentTaskPartitions,get_kafka_streams_group_member_target_assignment_task_partitions,get,,Streams Group (v3),streams group (v3),member_target_assignment_task_partitions,get_kafka_streams_group_member_target_assignment_task_partitions,select,,List Streams Group Target Assignments Task Partitions of a Specific Type and Subtopology +streams_group.yaml,/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/subtopologies,listKafkaStreamsGroupSubtopologies,list_kafka_streams_group_subtopologies,get,,Streams Group (v3),streams group (v3),subtopologies,list_kafka_streams_group_subtopologies,select,$.data,List Streams Group Subtopologies +streams_group.yaml,/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/subtopologies/{subtopology_id},getKafkaStreamsGroupSubtopology,get_kafka_streams_group_subtopology,get,,Streams Group (v3),streams group (v3),subtopologies,get_kafka_streams_group_subtopology,select,,Get Streams Group Subtopology +sts.yaml,/sts/v1/oauth2/token,exchangeStsV1OauthToken,exchange_sts_v1_oauth_token,post,sts.v1.TokenExchangeReply,OAuth Tokens (sts/v1),oauth tokens (sts/v1),oauth_tokens,exchange_sts_v1_oauth_token,exec,,Exchange an OAuth Token +tableflow.yaml,/tableflow/v1/catalog-integrations,createTableflowV1CatalogIntegration,create_tableflow_v1_catalog_integration,post,,Catalog Integrations (tableflow/v1),catalog integrations (tableflow/v1),catalog_integrations,create_tableflow_v1_catalog_integration,insert,,Create a Catalog Integration +tableflow.yaml,/tableflow/v1/catalog-integrations,listTableflowV1CatalogIntegrations,list_tableflow_v1_catalog_integrations,get,,Catalog Integrations (tableflow/v1),catalog integrations (tableflow/v1),catalog_integrations,list_tableflow_v1_catalog_integrations,select,$.data,List of Catalog Integrations +tableflow.yaml,/tableflow/v1/catalog-integrations/{id},deleteTableflowV1CatalogIntegration,delete_tableflow_v1_catalog_integration,delete,,Catalog Integrations (tableflow/v1),catalog integrations (tableflow/v1),catalog_integrations,delete_tableflow_v1_catalog_integration,delete,,Delete a Catalog Integration +tableflow.yaml,/tableflow/v1/catalog-integrations/{id},getTableflowV1CatalogIntegration,get_tableflow_v1_catalog_integration,get,,Catalog Integrations (tableflow/v1),catalog integrations (tableflow/v1),catalog_integrations,get_tableflow_v1_catalog_integration,select,,Read a Catalog Integration +tableflow.yaml,/tableflow/v1/catalog-integrations/{id},updateTableflowV1CatalogIntegration,update_tableflow_v1_catalog_integration,patch,,Catalog Integrations (tableflow/v1),catalog integrations (tableflow/v1),catalog_integrations,update_tableflow_v1_catalog_integration,update,,Update a Catalog Integration +tableflow.yaml,/tableflow/v1/regions,listTableflowV1Regions,list_tableflow_v1_regions,get,,Regions (tableflow/v1),regions (tableflow/v1),regions,list_tableflow_v1_regions,select,$.data,List of Regions +tableflow.yaml,/tableflow/v1/tableflow-topics,createTableflowV1TableflowTopic,create_tableflow_v1_tableflow_topic,post,,Tableflow Topics (tableflow/v1),tableflow topics (tableflow/v1),topics,create_tableflow_v1_tableflow_topic,insert,,Create a Tableflow Topic +tableflow.yaml,/tableflow/v1/tableflow-topics,listTableflowV1TableflowTopics,list_tableflow_v1_tableflow_topics,get,,Tableflow Topics (tableflow/v1),tableflow topics (tableflow/v1),topics,list_tableflow_v1_tableflow_topics,select,$.data,List of Tableflow Topics +tableflow.yaml,/tableflow/v1/tableflow-topics/{display_name},deleteTableflowV1TableflowTopic,delete_tableflow_v1_tableflow_topic,delete,,Tableflow Topics (tableflow/v1),tableflow topics (tableflow/v1),topics,delete_tableflow_v1_tableflow_topic,delete,,Delete a Tableflow Topic +tableflow.yaml,/tableflow/v1/tableflow-topics/{display_name},getTableflowV1TableflowTopic,get_tableflow_v1_tableflow_topic,get,,Tableflow Topics (tableflow/v1),tableflow topics (tableflow/v1),topics,get_tableflow_v1_tableflow_topic,select,,Read a Tableflow Topic +tableflow.yaml,/tableflow/v1/tableflow-topics/{display_name},updateTableflowV1TableflowTopic,update_tableflow_v1_tableflow_topic,patch,,Tableflow Topics (tableflow/v1),tableflow topics (tableflow/v1),topics,update_tableflow_v1_tableflow_topic,update,,Update a Tableflow Topic +usm.yaml,/usm/v1/connect-clusters,createUsmV1ConnectCluster,create_usm_v1_connect_cluster,post,,Connect Clusters (usm/v1),connect clusters (usm/v1),connect_clusters,create_usm_v1_connect_cluster,insert,,Create a Connect Cluster +usm.yaml,/usm/v1/connect-clusters,listUsmV1ConnectClusters,list_usm_v1_connect_clusters,get,,Connect Clusters (usm/v1),connect clusters (usm/v1),connect_clusters,list_usm_v1_connect_clusters,select,$.data,List of Connect Clusters +usm.yaml,/usm/v1/connect-clusters/{id},deleteUsmV1ConnectCluster,delete_usm_v1_connect_cluster,delete,,Connect Clusters (usm/v1),connect clusters (usm/v1),connect_clusters,delete_usm_v1_connect_cluster,delete,,Delete a Connect Cluster +usm.yaml,/usm/v1/connect-clusters/{id},getUsmV1ConnectCluster,get_usm_v1_connect_cluster,get,,Connect Clusters (usm/v1),connect clusters (usm/v1),connect_clusters,get_usm_v1_connect_cluster,select,,Read a Connect Cluster +usm.yaml,/usm/v1/kafka-clusters,createUsmV1KafkaCluster,create_usm_v1_kafka_cluster,post,,Kafka Clusters (usm/v1),kafka clusters (usm/v1),kafka_clusters,create_usm_v1_kafka_cluster,insert,,Create a Kafka Cluster +usm.yaml,/usm/v1/kafka-clusters,listUsmV1KafkaClusters,list_usm_v1_kafka_clusters,get,,Kafka Clusters (usm/v1),kafka clusters (usm/v1),kafka_clusters,list_usm_v1_kafka_clusters,select,$.data,List of Kafka Clusters +usm.yaml,/usm/v1/kafka-clusters/{id},deleteUsmV1KafkaCluster,delete_usm_v1_kafka_cluster,delete,,Kafka Clusters (usm/v1),kafka clusters (usm/v1),kafka_clusters,delete_usm_v1_kafka_cluster,delete,,Delete a Kafka Cluster +usm.yaml,/usm/v1/kafka-clusters/{id},getUsmV1KafkaCluster,get_usm_v1_kafka_cluster,get,,Kafka Clusters (usm/v1),kafka clusters (usm/v1),kafka_clusters,get_usm_v1_kafka_cluster,select,,Read a Kafka Cluster diff --git a/provider-dev/docgen/provider-data/headerContent1.txt b/provider-dev/docgen/provider-data/headerContent1.txt index 8e95862..9ddd731 100644 --- a/provider-dev/docgen/provider-data/headerContent1.txt +++ b/provider-dev/docgen/provider-data/headerContent1.txt @@ -1,19 +1,20 @@ ---- -title: REPLACEME -hide_title: false -hide_table_of_contents: false -keywords: - - REPLACEME - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage REPLACEME resources using SQL -custom_edit_url: null -image: /img/stackql-REPLACEME-provider-featured-image.png -id: 'provider-intro' ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - -REPLACEME with description for the provider. \ No newline at end of file +--- +title: confluent +hide_title: false +hide_table_of_contents: false +keywords: + - confluent + - kafka + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Confluent Cloud resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +id: 'provider-intro' +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + +Confluent Cloud for managing Kafka clusters, topics, and streaming services in a scalable cloud environment. diff --git a/provider-dev/docgen/provider-data/headerContent2.txt b/provider-dev/docgen/provider-data/headerContent2.txt index 0eeb8c1..185258d 100644 --- a/provider-dev/docgen/provider-data/headerContent2.txt +++ b/provider-dev/docgen/provider-data/headerContent2.txt @@ -1,42 +1,44 @@ -See also: -[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry) -* * * - -## Installation - -To pull the latest version of the `REPLACEME` provider, run the following command: - -```bash -REGISTRY PULL REPLACEME; -``` -> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry). - -## Authentication - -The following system environment variables are used for authentication by default: - -- - REPLACEME API token (see \ No newline at end of file +See also: +[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry) +* * * + +## Installation + +To pull the latest version of the `confluent` provider, run the following command: + +```bash +REGISTRY PULL confluent; +``` +> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry). + +## Authentication + +The following system environment variables are used for authentication by default: + +- - Confluent Cloud API key (see Confluent Cloud API Keys) +- - Confluent Cloud API secret (see Confluent Cloud API Keys) + +These variables are sourced at runtime (from the local machine or as CI variables/secrets). + +
+ +Using different environment variables + +To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example: + +```bash + +AUTH='{ "confluent": { "type": "basic", "username_var": "MY_CONFLUENT_CLOUD_API_KEY_VAR", "password_var": "MY_CONFLUENT_CLOUD_API_SECRET_VAR" }}' +stackql shell --auth="${AUTH}" + +``` + +or using PowerShell: + +```powershell + +$Auth = "{ 'confluent': { 'type': 'basic', 'username_var': 'MY_CONFLUENT_CLOUD_API_KEY_VAR', 'password_var': 'MY_CONFLUENT_CLOUD_API_SECRET_VAR' }}" +stackql.exe shell --auth=$Auth + +``` +
diff --git a/provider-dev/downloaded/openapi.yaml b/provider-dev/downloaded/openapi.yaml new file mode 100644 index 0000000..0e8dbcc --- /dev/null +++ b/provider-dev/downloaded/openapi.yaml @@ -0,0 +1,65348 @@ +--- +openapi: 3.0.0 +info: + title: Confluent Cloud APIs + version: '' # TODO: figure out our aggregate API spec versioning strategy, this is here to pass the linter + x-api-id: 46234552-5833-42eb-ba0f-883ad3f70d2b + x-audience: external-public + x-logo: + url: https://assets.confluent.io/m/1661ef5e4ff82d3d/ + description: | + # Introduction + +
+

Note

+ This documents the collection of Confluent Cloud APIs. Each API documents its + lifecycle phase. APIs + marked as Early Access or Preview are not ready for production usage. We're currently + working with a select group of customers to get feedback and iterate on these APIs. +
+ + Confluent Cloud APIs are a core building block of Confluent Cloud. You can use the APIs to + manage your own account or to integrate Confluent into your product. + + Most of the APIs are organized around + REST + and the resources which make up Confluent Cloud. The APIs have predictable + resource-oriented URLs, transport data using JSON, and use standard HTTP verbs, + response codes, authentication, and design principles. + + ## Object Model + +
+

Note

+ This section describes the object model for many Confluent Cloud APIs, but not all. + The Connect v1 API group has a different object model. You can review the example + request and response bodies in Connect v1 API + to see its object model. +
+ + Confluent Cloud APIs are primarily designed to be declarative and intent-oriented. In other words, + tell the API what you want (for example, throughput or SLOs) and it will figure out how to make it happen + (for example, cluster sizing). A Confluent object acts as a "record of intent" — after you create the + object, Confluent Cloud will work tirelessly in the background to ensure that the object exists + as specified. + + Confluent APIs represent objects in JSON with media-type `application/json`. + + Many objects follow a model consisting of `spec` and `status`. An object's `spec` tells + Confluent the _desired state_ (specification) of the resource. The object may not be + immediately available or changes may not be immediately applied. For this reason, + many objects also have a `status` property that provides info about the + _current state_ of the resource. Confluent Cloud is continuously and actively managing + each resource's current state to match it's desired state. + + All Confluent objects share a set of common properties: + + - **api_version** – API objects have an `api_version` field indicating their API version. + - **kind** – API objects have a `kind` field indicating the kind of object it is. + - **id** – Each object in the API will have an identifier, indicated via its `id` field, + and should be treated as an opaque string unless otherwise specified. + + There are a number of other [standard properties](#standard-properties) and that you'll encounter + used by many API objects. And of course, objects have plenty of non-standard fields that are + specific to each object _kind_... this is what makes them interesting! + + # Authentication + + Confluent uses API keys and JSON Web Tokens (JWTs) to integrate your applications + and workflows to your Confluent Cloud resources using the Confluent Cloud REST APIs. + Your applications and workflows must be authenticated and authorized in order to + access and manage Confluent Cloud resources. + + ## API keys + + You can create and manage your API keys using the Confluent Cloud Console or + Confluent CLI. For more information, see [Use API Keys to Control Access in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/api-keys/api-keys.html). + + Confluent Cloud uses the following two categories of API keys: + + - A **Cloud API key** grants access to the Confluent Cloud Management APIs, + such as for Provisioning and Metrics integrations. + - A **resource-specific API key** grants access to a Confluent Kafka cluster + (Kafka API key), a Confluent Cloud Schema Registry (Schema Registry API key), + Flink (Flink API key scoped to an Environment + Region pair), or a ksqlDB application. + + Each Confluent Cloud API key is associated with a principal (specific user or + service account) and inherits the permissions granted to the owner. + + - For example, if service account `Armageddon` is granted ACLs on Kafka cluster + `neptune`, then a Kafka API Key for `neptune` owned by `Armageddon` will have + these ACLs enforced. + - **Note:** API keys are automatically deleted when the associated user or service + account is deleted (for example, when an employee leaves the company or moves to + a new department and an SSO integration removes the Confluent Cloud user as they + no longer require access). + - Confluent **strongly recommends** that you use service accounts for all + production-critical access. + + Confluent Cloud API keys grant access to Confluent Cloud resources, so **keep them secure**! + Do not share your API keys and secrets in publicly-accessible locations, such as + GitHub or client-side code. + + All API requests must be made over HTTPS. Calls made over plain HTTP will fail. + API requests without authentication will also fail. + + To use an API key, you must send it in an `Authorization: Basic {credentials}` header. + Remember that HTTP Basic authentication requires you to provide your credentials as + the API key ID and associated API secret separated by a colon and encoded using Base64 + format. For example, if your API key ID is `ABCDEFGH123456789` and the API key Secret + is `XNCIW93I2L1SQPJSJ823K1LS902KLDFMCZPWEO`, then the authorization header is: + + ```text​ + Authorization: Basic QUJDREVGR0gxMjM0NTY3ODk6WE5DSVc5M0kyTDFTUVBKU0o4MjNLMUxTOTAyS0xERk1DWlBXRU8= + ``` + + You can generate this header example from the API key: + + macOS: + + ```shell + $ echo -n "ABCDEFGH123456789:XNCIW93I2L1SQPJSJ823K1LS902KLDFMCZPWEO" | base64 + + ``` + + Linux: + + ```shell + $ echo -n "ABCDEFGH123456789:XNCIW93I2L1SQPJSJ823K1LS902KLDFMCZPWEO" | base64 -w 0 + ``` + + Windows (PowerShell only): + + This command is only supported for PowerShell and will not work in the Command shell. + + ```shell + $ [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("ABCDEFGH123456789:XNCIW93I2L1SQPJSJ823K1LS902KLDFMCZPWEO")) + ``` + + To find out if an API operation supports Cloud API Keys, look in the **AUTHORIZATIONS** + listing for `cloud-api-key`. + + To find out if an API operation supports resource-specific API Keys, look in the **AUTHORIZATIONS** + listing for `resource-api-key`. + + ## External OAuth + + You can use [OAuth/OIDC support for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html) + to authenticate and authorize access to applications and workloads for the + following Confluent Cloud REST APIs: + + - **Kafka REST API**: [Kafka REST API for Clusters(V3)](../ccloud/cluster-v-3/). + For an API overview and examples, see [Cluster Management with Kafka REST API](https://docs.confluent.io/cloud/current/kafka-rest/kafka-rest-cc.html). + - **Schema Registry REST API**: [Schema Registry REST API for Schemas(V1)](../ccloud/schemas-v-1/) + and [Subjects](../ccloud/subjects-v-1/). + For an API overview and examples, see [Schema Registry REST API for Confluent Cloud](https://docs.confluent.io/cloud/current/sr/sr-rest-apis.html). + + Alternatively, to find out if an API operation supports external tokens, look in the **AUTHORIZATIONS** + listing for `external-access-token`. + + ## Confluent STS tokens + + Confluent Security Token Service (STS) issues access tokens (`confluent-sts-access-token`) + by exchanging an external token (`external-access-token`) for a `confluent-sts-access-token`. You can use + Confluent STS tokens to authenticate to Confluent Cloud APIs that support the + `confluent-sts-access-token` notation. + + To find out if an API operation supports Confluent STS tokens, look in the **AUTHORIZATIONS** + listing for `confluent-sts-access-token`. + + ## Partner OAuth + + Approved partners can fetch Partner tokens (`confluent-partner-access-token`) that validate their identity + and grant access to the Partner API (`partner/v2`), which lets them sign up + an organization on behalf of a customer, manage entitlements (create, read, and list), + and read or list organizations they have signed up. + + To find out an API operation supports Partner tokens, look in the **AUTHORIZATIONS** + listing for `confluent-partner-access-token`. + + + + + + # Errors + + Confluent API error messages are a critical part of the developer experience. For Confluent Cloud, they must be + clear, consistent, actionable, and designed for both developers and automated systems. Strong error + handling supports fast troubleshooting, reliable integration, and efficient support–the foundation of + a positive developer experience. + + Our APIs are built on RESTful principles. They use resource-oriented URLs, standard HTTP verbs, and JSON + for requests and responses. This section defines clear standards for structuring, formatting, and documenting + error messages for all Confluent REST APIs. + +
+

Note

+ This error format applies to most Confluent Cloud APIs. However, the Connect v1 API group uses a different structure. For Connect v1-specific error behavior and examples, refer to the Connect v1 API documentation below to see its error behavior. +
+ + ## Key principles + + Use the following best practices when designing and documenting API error messages: + + - **Ensure clarity and consistency**: Messages must be easy to understand–use active voice and plain language–and consistently formatted across endpoints. + + - **Write actionable messages**: Always include a resolution or next step, enabling users to correct the problem. + + - **Avoid exposing sensitive data**: Never expose internal system details, stack traces, logs, or user-specific content. + + - **Follow industry best practices**: Don't use a period at the end of the message field, even if it is a full sentence. This follows industry standards. Use periods in the details and suggestion fields if the content is a complete sentence. View the [API best practices blog](#status-codes) by Postman, a trusted API leader. + + ## HTTP status codes + + Confluent Cloud APIs return standard [HTTP status codes](#status-codes) to + indicate the outcome of API request. Each error response includes a `status` field that reflects the appropriate HTTP code as a string (for example, `"403"` or `"404"`). + For a list of supported codes and their meaning, see the [HTTP status codes](#status-codes) section. + + ## Error response structure + + Each API error response **should** include the following fields: + + **Top-level fields** + + | Field | Type | Required | Description | + | ------------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | + | status | String | Yes | HTTP status code (for example, 400, 404, 500). | + | error | Object | Yes | Main object containing error details. | + | requestId | String | Optional | Unique identifier for the API request. Use for tracing, debugging, and support inquiries. | + | doc_url | String | Optional | Link to relevant documentation or troubleshooting steps. | + + **Fields inside `error` object** + + | Field | Type | Required | Description | + | ------------| ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | + | code | String | Yes | Unique, application-specific error code. Write error codes in uppercase letters, using underscores to separate words (for example, RESOURCE_NOT_FOUND). | + | message | String | Yes | Clear, actionable, user-friendly description of what went wrong using active voice. | + | details | String | Optional | Additional explanation or context about the error using active voice. | + | timestamp | String | Yes | ISO 8601 UTC timestamp indicating the date and time when the error occurred. | + | path | String | Yes | The exact API endpoint or resource path related to the error. | + | suggestion | String | Optional | Recommend actions the user can take to fix or avoid the error using active voice. | + + Each Confluent API error includes a status and a structured error object with a code, message, and optional context to help you understand and resolve the issue. The following example + shows a standard Confluent API error response in JSON format: + + { + "status": 400, + "error": { + "code": "INVALID_SCHEMA_FIELD", + "message": "The 'name' field in the schema is required and cannot be empty.", + "details": "Schemas must include a top-level 'name' field with a non-empty string value.", + "timestamp": "2025-08-01T20:36:45Z", + "path": "/api/v1/schemas", + "suggestion": "Ensure the 'name' field is included in the payload and is not an empty string." + }, + "requestId": "a1b2c3d4-e5f6-7890-g1h2-i3j4k516m7n8", + "doc_url": "https://docs.confluent.io/cloud/current/api/errors/INVALID_SCHEMA_FIELD.html" + } + + Note that if a request fails validation, it will return an HTTP `422 Unprocessable Entity` + with a list of fields that failed validation. + + ## Pagination + +
+

Note

+ This section describes the pagination behavior of “list” operations for many Confluent Cloud APIs, but not all. + The Connect V1 and Kafka V3 API list operations do not support pagination. +
+ + All API resources have support for bulk reads via "list" API operations. For example, + you can "list Kafka clusters", "list api keys", and "list environments". These "list" + operations require pagination; by requesting smaller subsets of data, API clients + receive a response much faster than requesting the entire, potentially large, data set. + + All "list" operations follow the same pattern with the following parameters: + + - `page_size` – client-provided max number of items per page, only valid on the first request. + - `page_token` – server-generated token used for traversing through the result set. + + A paginated response may include any of the following pagination links. API clients may + follow the respective link to page forward or backward through the result set as desired. + + | [Link Relation](https://www.iana.org/assignments/link-relations/link-relations.xml) | Description | + | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | `next` | A link to the next page of results. A response that does not contain a next link does not have further data to fetch. | + | `prev` | A link to the previous page of results. A response that does not contain a prev link has no previous data. This link is **optional** for collections that cannot be traversed backward. | + | `first` | A link to the first page of results. This link is **optional** for collections that cannot be indexed directly to a given page. | + | `last` | A link to the last page of results. This link is **optional** for collections that cannot be indexed directly to a given page. | + + API clients must treat pagination links and the `page_token` parameter in particular as an opaque string. + + An example paginated list response may look like + + ``` + { + "api_version": "v2", + "kind": "KafkaClusterList", + "metadata": { + "next": "https://api.confluent.cloud/kafka-clusters?page_token=ABCDEFGHIJKLMNOP1234567890" + } + "data": [ + { + "metadata": { + "id": "lkc-abc123", + "self": "https://api.confluent.cloud/kafka-clusters/lkc-abc123", + "resource_name": "crn://confluent.cloud/kafka=lkc-abc123", + } + "spec": { + "display_name": "My Kafka Cluster", + + }, + "status": { + "phase": "RUNNING", + + } + }, + + ] + } + ``` + + # Rate Limiting + + To protect the stability of the API and keep it available to all users, Confluent employs + multiple safeguards. If you send too many requests in quick succession or perform too many + concurrent operations, you may be throttled or have your request rejected with an error. + + When a rate limit is breached, an HTTP `429 Too Many Requests` error is + returned. The following headers are sent back to provide assistance in dealing + with rate limits. Note that headers are not returned for a `429` error response with + [Kafka REST API (v3)](../ccloud/cluster-v-3/). + + | Header | Description | + | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | `X-RateLimit-Limit` | The maximum number of requests you're permitted to make per time period. | + | `X-RateLimit-Reset` | The relative time in seconds until the current rate limit window resets. | + | `Retry-After` | The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. | + | `X-RateLimit-Remaining` | The number of requests remaining in the current rate-limit window. **Important:** This differs from Github and Twitter\'s same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. | + + Confluent enforces multiple kinds of limits, including request-rate and concurrency limits, both per user and organization-wide. Unauthenticated requests are associated with the originating IP address, not the user making requests. + + Integrations should gracefully handle these limits by watching for `429` error responses and + building in a retry mechanism. This mechanism should follow a capped exponential backoff policy to + prevent [retry amplification](https://landing.google.com/sre/sre-book/chapters/addressing-cascading-failures/) + ("retry storms") and also introduce some randomness ("jitter") to avoid the + [thundering herd effect](https://en.wikipedia.org/wiki/Thundering_herd_problem). + + If you’re running into this error and think you need a higher rate limit, contact Confluent at + [support@confluent.io](mailto:support@confluent.io). + + # Identifiers and URLs + + Most resources have multiple identifiers: + + - `id` is the "natural identifier" for an object. It is only unique within its parent resource. + The `id` is unique across time: the ID will not be reclaimed and reused after an object is deleted. + - `resource_name` is a Uniform Resource Identifier (URI) that is globally unique across all resources. + This encompasses all parent resource `kind`s and `id`s necessary to uniquely identify a particular + instance of this object `kind`. Because it uses object `id`s, the CRN will not be reclaimed and + reused after an object is deleted. It is represented as a Confluent Resource Name (see below). + - `self` is a Uniform Resource Locator (URL) at which an object can be addressed. + This URL encodes the service location, API version, and other particulars necessary to + locate the resource at a point in time. + + To see how these relate to each other, consider `KafkaBroker` with `broker.id=2` in a `KafkaCluster` + in Confluent Cloud identified as `lkc-xsi8201`. In such an example, the `KafkaBroker` has `id=2`, + the `resource_name` is `crn://confluent.cloud/kafka=lkc-xsi8201/broker=2` and the `self` URL may be + something like `https://pkc-8wlk2n.us-west-2.aws.confluent.cloud`. Note that different identifiers + carry different information for different purposes, but the `resource_name` is the most complete + and canonical identifier. + + ## Confluent Resource Names (CRNs) + + _Confluent Resource Names_ (CRNs) are used to uniquely identify all Confluent resources. + + A CRN is a valid URI having an "authority" of `confluent.cloud` or a self-managed + + metadata service URL, followed by the minimal hierarchical set of key-value + pairs necessary to uniquely identify a resource. + + Here are some examples for basic resources in Confluent Cloud: + + | Resource | Example CRN | + | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | + | Organization | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a | + | Environment | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy | + | User | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/user=u-rst9876 | + | API Key | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/user=u-zyx98/api-key=ABCDEFG9876543210 | + | Service Account | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/service-account=sa-abc1234 | + | Kafka Cluster | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/kafka=lkc-123abc | + | Kafka Topic | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/kafka=lkc-123abc/topic=my_kafka_topic | + | Consumer Group | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/kafka=lkc-123abc/group=confluent_cli_consumer_123 | + | Network | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/network=n-123abc | + | Peering | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/network=n-123abc/peering=p-123abc | + | Private Link Access | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/network=n-123abc/private-link-access=pla-123abc | + | Transit Gateway Attachment | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/network=n-123abc/transit-gateway-attachment=tgwa-123abc | + | Schema Registry Cluster | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/schema-registry=lsrc-789qw | + | Schema Subject | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/schema-registry=lsrc-789qw/subject=test | + | KEK | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/schema-registry=lsrc-789qw//kek=test_kek | + | Connector | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector | + | Provider Integration | crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/provider-integration=cspi-123j1 | + + # Data Types + + ## Primitive Types + + | Data Type | Representation | + | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | Integers | Each API may specify the type as `int32` or `int64`. Note that many languages, including JavaScript, are limited to a max size of approx `2**53` and don't correctly handle large `int64` values with their default JSON parser. | + | Dates | RFC 3339 formatted string. UTC timezones are assumed, unless otherwise given. | + | Times | RFC 3339 formatted string. UTC timezones are assumed, unless otherwise given. | + | Durations | RFC 3339 formatted string. | + | Periods | RFC 3339 formatted string. UTC timezones are assumed, unless otherwise given. | + | Ranges | All ranges are represented using half-open intervals with naming conventions like `[start_XXX, end_XXX)` such as `[start_time, end_time)`. | + | Enums | Most APIs use `x-extensible-enum` as an open-ended list of values. This improves compatibility compared with a standard `enum` which by definition represents a closed set. All enums have a `0`-valued entry which either serves as the default for common cases, or represents `UNSPECIFIED` when no default exists and results in an error. | + + + + ### Standard Properties + + Confluent uses this set of standard properties to ensure common concepts use + the same name and semantics across different APIs. + + | Name | Description | + | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | **api_version**  | Many API objects have an `api_version` field indicating their API version. See the [Object Model](#object-model). | + | **kind**  | Many API objects have a `kind` field indicating the kind of object it is. See the [Object Model](#object-model). | + | **id** | Many objects in the API will have an identifier, indicated via its `id` field, and should be treated as an opaque string unless otherwise specified. See the [Object Model](#object-model). | + | **name** | Objects which support a client-provided unique identifier instead of a generated `id` will indicate this identifier via its `name` field. | + | **display_name** | The human-readable display name of an API object. | + | **title** | The official name of an API object, such as a company name. It should be treated as the formal version of `display_name`. | + | **description** | One or more paragraphs of text description of an entity. | + | **created_at**  | The date and time the object was created, represented as a string in RFC 3339 format. | + | **updated_at**   | The date and time the object was last modified, represented as a string in RFC 3339 format. | + | **deleted_at** | If present, the date and time after which the object was/will be deleted, represented as a string in RFC 3339 format. | + | **page_token** | The pagination token in the List request. See [Pagination](#pagination). | + | **page_size** | The pagination size in the List request. See [Pagination](#pagination). | + | **total_size** | The total count of items in the list irrespective of pagination. See [Pagination](#pagination). | + | **spec** | The _desired state_ specification of the resource, as observed by Confluent Cloud. | + | **status** | The _current state_ of the resource, as observed by Confluent Cloud. | + + # Versioning + + Confluent APIs ensure stability for your integrations by avoiding the introduction + of breaking changes to customers unexpectedly. Confluent will make non-breaking + API changes without advance notice. Thus, API clients **must** follow the + [Compatibility Policy](#compatibility-policy) below to ensure your + integration remains stable. All APIs follow the API Lifecycle Policy described below, + which describes the guarantees API clients can rely on. + + Breaking changes will be [widely communicated](#communication) in advance in accordance + with the Confluent [Deprecation Policy](#deprecation-policy). Confluent will provide + timelines and a migration path for all API changes, where available. Be sure to subscribe + to one or more [communication channels](#communication) so you don't miss any updates! + + One exception to these guidelines is for critical security issues. Confluent will take any necessary + actions to mitigate any critical security issue as soon as possible, which may include disabling + the vulnerable functionality until a proper solution is available. + + Do not consume any Confluent API unless it is documented in the API Reference. All undocumented + endpoints should be considered private, subject to change without notice, and not covered by any + agreements. + + > Note: The version in the URL (e.g. "v1" or "v2") is not a "major version" in the + > [Semantic Versioning](https://semver.org/) sense. It is a "generational version" or "meta version", as seen in + > APIs like Github API or the + > Stripe API. + + ## API Groups + + Confluent APIs are divided into API Groups, such as the Cluster Management for Apache Kafka (CMK) API group, + the Connect API group, and the Data Catalog API group. Each group has its own set of endpoints and resources, + as well as its own API group version. + + Because different API groups have different versions, there is no single version for the "Confluent Cloud API". + The latest version of the Connect API group may be `connect/v1`, while the latest version of the CMK API group + may be `cmk/v2`. + + When a breaking change is introduced into one API group, Confluent will increase the API version for that API group + only, leaving the other API groups' versions unchanged. This makes it easier for you to understand whether a given + breaking change impacts your usage of the APIs. + + ## Known Issues + + During the Early Access and Preview periods, we have a few known issues. + + | Issue | Description | Proposed Resolution | + | -------------- | ----------------------------------------------------------------------------- | --------------------------------------------------- | + | Quota Exceeded | Some "Quota Exceeded" errors will be returned as HTTP 400 instead of HTTP 402 | Return 402 consistently for "Quota Exceeded" errors | + + ## API Lifecycle Policy + + The following status labels are applicable to APIs, features, and SDK versions, based on + the current support status of each: + + - **Early Access** – May change at any time. Not recommended for production usage. Not officially supported by + Confluent. Intended for user feedback only. Users must be granted explicit access to the API by Confluent. + - **Preview** – Unlikely to change between Preview and General Availability. Not recommended for production usage. + Officially supported by Confluent for non-production usage. Accessible to all users. + - **Limited Availability (LA)** - Available to key select customers in a subset of regions/providers/networks and recommended for production usage. + - **Generally Available (GA)** – Will not change at short notice. Recommended for production usage. + Officially supported by Confluent for non-production and production usage. + - **Deprecated** – Still supported, but no longer under active development. Existing usage will continue to function + but migration following the upgrade guide is strongly recommended. New use cases should be built against the new + version. Deprecated feature or version will be removed in the future at the announced date. + - **Sunset** – Removed, and no longer supported or available. + + An API is "Generally Available" unless explicitly marked otherwise. + + ## Compatibility Policy + + Confluent Cloud APIs are governed by + + Confluent Cloud Upgrade Policy, which means that backward incompatible changes and + deprecations will be made approximately once per year, and 180 days notice will be provided via email to all + registered Confluent Cloud users. + + ### Backward Compatibility + + > _An API version is backward compatible if a program written against the previous version of the API will continue to work the same way, without modification, against this version of the API._ + + Confluent considers the following changes to be backward compatible: + + - Adding new API resources. + - Adding new optional parameters to existing API requests (e.g., query string). + - Adding new properties to existing API resources (e.g., request body). + - Changing the order of properties in existing API responses. + - Changing the length or format of object IDs or other opaque strings. + - Unless otherwise documented, you can safely assume object IDs generated by Confluent will never exceed 255 + characters, but you should be able to handle IDs of up to that length. If you're using MySQL, + for example, you should store IDs in a `VARCHAR(255) COLLATE utf8_bin` column. + - This includes adding or removing fixed prefixes (such as `lkc-` on Kafka cluster IDs). + - This includes API keys, API tokens, and similar authentication mechanisms. + - This includes all strings described as "opaque" in the docs, such as pagination cursors. + - Adding new API event types. + - Adding new properties to existing API event types. + - Omitting properties with null values from existing API responses. + + ### Forward Compatibility + + > _An API version is forward compatible if a program written against the next version of the API + > will continue to work the same way, without modification, against this version of the API._ + + In other words, a forward compatible API will accept input intended for a later version of itself. + + Confluent does not guarantee the forward compatibility of the APIs, but Confluent does generally follow the guidelines + given by the [Robustness principle](https://en.wikipedia.org/wiki/Robustness_principle). + This means that the API determines what to do with a request based only on the parts that it recognizes. + + This is often referred to as the MUST IGNORE rule. + + - Request parameters that are not recognized will be ignored (e.g., query string). + - Request properties that are not recognized will be ignored (e.g., request body). + - Request metadata that are not recognized will be ignored (e.g., request headers). + + API clients must also follow the MUST IGNORE rule. + + - Response properties that are not recognized must be ignored (e.g., response body). + - Response metadata that are not recognized must be ignored (e.g., response headers). + + Additionally, there is a more subtle related rule called the MUST FORWARD rule. Any parts of + a request that an API doesn't recognize must be forwarded unchanged. + + - Response properties that are not recognized must be included in any input subsequent updates (e.g., request body) + - This includes future `PUT` requests in a read/modify/write operation. + (This isn't required for `PATCH` partial updates, which is why Confluent APIs use `PATCH`.) + - Event processors must not strip unknown properties before forwarding messages. + + #### Compatibility Implementation Hints + + Confluent considers adding new properties to existing API resources (e.g., response bodies) to be a backward-compatible change. To ensure your integrations remain stable when new fields are introduced, your JSON parsers should be configured to ignore unknown properties rather than throwing an error. + + For the **Jackson** library (Java), use one of these approaches: + + **1. Global Configuration (Recommended)** + + Configure `ObjectMapper` to ignore unknown properties globally. + + ```java + ObjectMapper objectMapper = new ObjectMapper(); + objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); + ``` + + **2. Class-Level Control** + + Use `@JsonIgnoreProperties` to ignore unknown fields on specific classes. + + ```java + @JsonIgnoreProperties(ignoreUnknown = true) + public class MyResource { ... } + ``` + + **3. Capturing Unknown Fields** + + Use `@JsonAnySetter` to preserve unknown fields in a `Map`, in order to use them on future requests to fulfill the MUST FORWARD requirement. + + ```java + public class MyResource { + // ... existing fields ... + private Map unknownProperties = new HashMap<>(); + + @JsonAnySetter + public void addUnknownProperty(String key, Object value) { + this.unknownProperties.put(key, value); + } + + public Map getUnknownProperties() { + return unknownProperties; + } + } + ``` + + ### Client Responsibilities + + - Resource and rate limits, and the default and maximum sizes of paginated data **are not** + considered part of the API contract and may change (possibly dynamically). It is the client's + responsibility to read the road signs and obey the speed limit. + - If a property has a primitive type and the API documentation does not explicitly limit its + possible values, clients **must not** assume the values are constrained to a particular set + of possible responses. + - If a property of an object is not explicitly declared as mandatory in the API, clients + **must not** assume it will be present. + - A resource **may** be modified to return a "redirection" response (e.g. `301`, `307`) instead of + directly returning the resource. Clients **must** handle HTTP-level redirects, and respect HTTP + headers (e.g. `Location`). + + ## Deprecation Policy + + Confluent will announce deprecations at least 180 days in advance of a breaking change + and will continue to maintain the deprecated APIs in their original form during this time. + + Exceptions to this policy apply in case of critical security vulnerabilities or functional defects. + + ### Communication + + When a deprecation is announced, the details and any relevant migration + information will be available on one or more of the following channels: + + - Announcements on the Developer Blog, + Community Slack + (join!), + Google Group, + the @ConfluentInc twitter + account, and similar channels + - Enterprise customers may receive information by email to their specified Confluent contact, if applicable. + + + + # HTTP Guidelines + + ## Status Codes + + Confluent respects the meanings and behavior of HTTP status codes as defined + in RFC2616 and elsewhere. + + - Codes in the `2xx` range indicate success + - Codes in the `3xx` range indicate redirection + - Codes in the `4xx` range indicate an error caused by the client request + (e.g., a required parameter was omitted, an invalid cluster configuration was provided, etc.) + - Codes in the `5xx` range indicate an error with Confluent's servers (these are rare) + + The various HTTP status codes that might be returned are listed below. + + | Code | Title | Description | + | ------------------ | ----------------- | --------------------------------------------------------------------------------------------------------------- | + | 200 | OK | Everything worked as expected. | + | 201 | Created | The resource was created. Follow the `Location` header. | + | 204 | No Content | Everything worked and there is no content to return. | + | 400 | Bad Request | The request was unacceptable, often due to malformed syntax, or a missing or malformed parameter. | + | 401 | Unauthorized | No valid credentials provided. or the credentials are unsuitable, invalid, or unauthorized. | + | 402 | Over Quota | The request was valid, but you've exceeded your plan quota or limits. | + | 404 | Not Found | The requested resource doesn't exist or you're unauthorized to know it exists. | + | 409 | Conflict | The request conflicts with another request (perhaps it already exists or was based on a stale version of data). | + | 422 | Validation Failed | The request was parsed correctly but failed some sort of validation. | + | 429 | Too Many Requests | Too many requests hit the API too quickly. Confluent recommends an exponential backoff of your requests. | + | 500, 502, 503, 504 | Server Errors | Something went wrong on Confluent's end. (These are rare.) | + + This list is not exhaustive; other standard HTTP error codes may be used, + including `304`, `307`, `308`, `405`, `406`, `408`, `410`, and `415`. + + For more details, see https://httpstatuses.com. + + + + # Metrics APIs + + For Metrics APIs, see Confluent Cloud Metrics API. +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API +x-tagGroups: + - name: Identity Access Management (v2) + tags: + - API Keys (iam/v2) + - Users (iam/v2) + - Service Accounts (iam/v2) + - Invitations (iam/v2) + - IP Groups (iam/v2) + - IP Filters (iam/v2) + - IP Filter Summaries (iam/v2) + - Role Bindings (iam/v2) + - Identity Providers (iam/v2) + - Jwks (iam/v2) + - Identity Pools (iam/v2) + - Group Mappings (iam/v2/sso) + - Certificate Authorities (iam/v2) + - Certificate Identity Pools (iam/v2) + - name: Org API (v2) + tags: + - Environments (org/v2) + - Organizations (org/v2) + - name: Notifications API (v1) + tags: + - Subscriptions (notifications/v1) + - Integrations (notifications/v1) + - Notification Types (notifications/v1) + - Resource Preferences (notifications/v1) + - Resource Subscriptions (notifications/v1) + - name: Cluster Mgmt for Kafka (v2) + tags: + - Clusters (cmk/v2) + - name: Cluster Mgmt for ksqlDB (v2) + tags: + - Clusters (ksqldbcm/v2) + - name: Connect API (v1) + tags: + - Connectors (connect/v1) + - Lifecycle (connect/v1) + - Status (connect/v1) + - Managed Connector Plugins (connect/v1) + - Offsets (connect/v1) + - Custom Connector Plugins (connect/v1) + - Presigned Urls (connect/v1) + - Custom Connector Runtimes (connect/v1) + - name: Kafka API (v3) + tags: + - Cluster (v3) + - Configs (v3) + - ACL (v3) + - Consumer Group (v3) + - Partition (v3) + - Topic (v3) + - Records (v3) + - Cluster Linking (v3) + - Share Group (v3) + - Streams Group (v3) + - name: Service Quota API (v1) + tags: + - Applied Quotas (service-quota/v1) + - Scopes (service-quota/v1) + - name: Partner API (v2) + tags: + - Entitlements (partner/v2) + - Organizations (partner/v2) + - Signup (partner/v2) + - name: Cluster Mgmt for Schema Registry (v2) + tags: + - Regions (srcm/v2) + - Clusters (srcm/v2) + - name: Cluster Mgmt for Schema Registry (v3) + tags: + - Clusters (srcm/v3) + - name: Schema Registry API (v1) + tags: + - Compatibility (v1) + - Config (v1) + - Contexts (v1) + - Exporters (v1) + - Modes (v1) + - Schemas (v1) + - Subjects (v1) + - Key Encryption Keys (v1) + - Data Encryption Keys (v1) + - name: Catalog API (v1) + tags: + - Entity (v1) + - Search (v1) + - Types (v1) + - name: Stream Sharing API (v1) + tags: + - Provider Shared Resources (cdx/v1) + - Provider Shares (cdx/v1) + - Consumer Shared Resources (cdx/v1) + - Consumer Shares (cdx/v1) + - Shared Tokens (cdx/v1) + - Opt Ins (cdx/v1) + - name: Networking (v1) + tags: + - Networks (networking/v1) + - Peerings (networking/v1) + - Transit Gateway Attachments (networking/v1) + - Private Link Accesses (networking/v1) + - Network Link Services (networking/v1) + - Network Link Endpoints (networking/v1) + - Network Link Service Associations (networking/v1) + - IP Addresses (networking/v1) + - Private Link Attachments (networking/v1) + - Private Link Attachment Connections (networking/v1) + - DNS Forwarders (networking/v1) + - Access Points (networking/v1) + - DNS Records (networking/v1) + - Gateways (networking/v1) + - name: Security Token Service (v1) + tags: + - OAuth Tokens (sts/v1) + - name: Kafka Quota (v1) + tags: + - Client Quotas (kafka-quotas/v1) + - name: Bring Your Own Key (BYOK) Management (v1) + tags: + - Keys (byok/v1) + - name: Billing API (v1) + tags: + - Costs (billing/v1) + - name: Compute Pool Mgmt for Flink (v2) + tags: + - Compute Pools (fcpm/v2) + - Regions (fcpm/v2) + - Org Compute Pool Configs (fcpm/v2) + - name: SQL API (v1) + tags: + - Statements (sql/v1) + - Statement Results (sql/v1) + - Statement Exceptions (sql/v1) + - Connections (sql/v1) + - Agents (sql/v1) + - Tools (sql/v1) + - Materialized Tables (sql/v1) + - Materialized Table Versions (sql/v1) + - name: Provider Integration Management (v1) + tags: + - Integrations (pim/v1) + - name: Provider Integration Management (v2) + tags: + - Integrations (pim/v2) + - name: Artifact API (v1) + tags: + - Flink Artifacts (artifact/v1) + - Presigned Urls (artifact/v1) + - Flink Artifact Versions (artifact/v1) + - name: Custom Code Logging API (v1) + tags: + - Custom Code Loggings (ccl/v1) + - name: Tableflow (v1) + tags: + - Regions (tableflow/v1) + - Tableflow Topics (tableflow/v1) + - Catalog Integrations (tableflow/v1) + - name: Custom Connect Plugin Management (v1) + tags: + - Custom Connect Plugins (ccpm/v1) + - Presigned Urls (ccpm/v1) + - Custom Connect Plugin Versions (ccpm/v1) + - name: Unified Stream Manager (v1) + tags: + - Kafka Clusters (usm/v1) + - Connect Clusters (usm/v1) + - name: Endpoint (v1) + tags: + - Endpoints (endpoint/v1) +paths: + /iam/v2/api-keys: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2ApiKeys + summary: List of API Keys + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all API keys. + + This can show all keys for a single owner (across resources - Kafka clusters), or all keys for a single + resource (across owners). If no `owner` or `resource` filters are specified, returns all API Keys in the + organization. You will only see the keys that are accessible to the account making the API request. + parameters: + - name: spec.owner + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + description: Filter the results by exact match for spec.owner. + - name: spec.resource + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + description: Filter the results by exact match for spec.resource. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - API Keys (iam/v2) + security: + - cloud-api-key: [] + responses: + '200': + description: API Key. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.ApiKeyList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + owner: + example: + id: u-a83k9b + related: https://api.confluent.cloud/iam/v2/users/u-a83k9b + resource_name: https://api.confluent.cloud/user=u-a83k9b + resource: + nullable: true + example: + id: lkc-c29js0 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-c29js0 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-c29js0 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2ApiKey + summary: Create an API Key + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an API key. + tags: + - API Keys (iam/v2) + security: + - cloud-api-key: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.ApiKey' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - owner + - type: object + properties: + spec: + type: object + properties: + owner: + example: + id: u-a83k9b + resource: + nullable: true + example: + id: lkc-c29js0 + responses: + '202': + description: An API Key is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/api-keys/{id} + description: ApiKey resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.ApiKey' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - owner + - type: object + properties: + spec: + type: object + properties: + owner: + example: + id: u-a83k9b + related: https://api.confluent.cloud/iam/v2/users/u-a83k9b + resource_name: https://api.confluent.cloud/user=u-a83k9b + resource: + nullable: true + example: + id: lkc-c29js0 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-c29js0 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-c29js0 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/api-keys/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2ApiKey + summary: Read an API Key + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an API key. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the API key. + tags: + - API Keys (iam/v2) + security: + - cloud-api-key: [] + responses: + '200': + description: API Key. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.ApiKey' + - type: object + required: + - api_version + - kind + - id + - spec + properties: + spec: + type: object + required: + - owner + - type: object + properties: + spec: + type: object + properties: + owner: + example: + id: u-a83k9b + related: https://api.confluent.cloud/iam/v2/users/u-a83k9b + resource_name: https://api.confluent.cloud/user=u-a83k9b + resource: + nullable: true + example: + id: lkc-c29js0 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-c29js0 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-c29js0 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2ApiKey + summary: Update an API Key + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an API key. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the API key. + tags: + - API Keys (iam/v2) + security: + - cloud-api-key: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.ApiKey' + responses: + '200': + description: API Key. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.ApiKey' + - type: object + required: + - api_version + - kind + - id + - spec + properties: + spec: + type: object + required: + - owner + - type: object + properties: + spec: + type: object + properties: + owner: + example: + id: u-a83k9b + related: https://api.confluent.cloud/iam/v2/users/u-a83k9b + resource_name: https://api.confluent.cloud/user=u-a83k9b + resource: + nullable: true + example: + id: lkc-c29js0 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-c29js0 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-c29js0 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2ApiKey + summary: Delete an API Key + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an API key. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the API key. + tags: + - API Keys (iam/v2) + security: + - cloud-api-key: [] + responses: + '204': + description: An API Key is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /org/v2/environments: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listOrgV2Environments + summary: List of Environments + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all environments. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Environments (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Environment. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/org.v2.EnvironmentList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createOrgV2Environment + summary: Create an Environment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an environment. + tags: + - Environments (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/org.v2.Environment' + - type: object + required: + - display_name + responses: + '201': + description: An Environment was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/org/v2/environments/{id} + description: Environment resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/org.v2.Environment' + - type: object + required: + - display_name + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /org/v2/environments/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getOrgV2Environment + summary: Read an Environment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an environment. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the environment. + tags: + - Environments (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Environment. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/org.v2.Environment' + - type: object + required: + - api_version + - kind + - id + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateOrgV2Environment + summary: Update an Environment + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an environment. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the environment. + tags: + - Environments (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/org.v2.Environment' + responses: + '200': + description: Environment. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/org.v2.Environment' + - type: object + required: + - api_version + - kind + - id + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteOrgV2Environment + summary: Delete an Environment + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an environment. + + If successful, this request will also recursively delete all of the environment's associated resources, + including all Kafka clusters, connectors, etc. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the environment. + tags: + - Environments (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Environment is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /org/v2/organizations: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listOrgV2Organizations + summary: List of Organizations + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all organizations. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Organizations (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Organization. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/org.v2.OrganizationList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /org/v2/organizations/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getOrgV2Organization + summary: Read an Organization + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an organization. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the organization. + tags: + - Organizations (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Organization. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/org.v2.Organization' + - type: object + required: + - api_version + - kind + - id + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateOrgV2Organization + summary: Update an Organization + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an organization. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the organization. + tags: + - Organizations (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/org.v2.Organization' + responses: + '200': + description: Organization. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/org.v2.Organization' + - type: object + required: + - api_version + - kind + - id + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/users: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2Users + summary: List of Users + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all users. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Users (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: User. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.UserList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/users/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2User + summary: Read a User + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a user. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the user. + tags: + - Users (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: User. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.User' + - type: object + required: + - api_version + - kind + - id + - email + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2User + summary: Update a User + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a user. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the user. + tags: + - Users (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.User' + responses: + '200': + description: User. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.User' + - type: object + required: + - api_version + - kind + - id + - email + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2User + summary: Delete a User + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a user. + + If successful, this request will also recursively delete all of the user's associated resources, + including its cloud and cluster API keys. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the user. + tags: + - Users (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A User is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/users/{id}/auth: + x-lifecycle-stage: General Availability + x-self-access: true + patch: + summary: Update Auth Type of a User + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Update the auth type of a user + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.User.ConfigureUserAuthRequest' + x-lifecycle-stage: General Availability + x-self-access: true + x-name: iam.v2.User + operationId: update_auth_typeIamV2User + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the user. + tags: + - Users (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/service-accounts: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2ServiceAccounts + summary: List of Service Accounts + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all service accounts. + parameters: + - name: display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [tf_runner_sa, mySA] + description: Filter the results by exact match for display_name. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Service Accounts (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Service Account. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.ServiceAccountList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2ServiceAccount + summary: Create a Service Account + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a service account. + parameters: + - name: assigned_resource_owner + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: u-a83k9b + description: The resource_id of the principal who will be assigned resource + owner on the created service account. Principal can be group-mapping (group-xxx), + user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx). + tags: + - Service Accounts (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.ServiceAccount' + - type: object + required: + - display_name + responses: + '201': + description: A Service Account was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/service-accounts/{id} + description: ServiceAccount resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.ServiceAccount' + - type: object + required: + - display_name + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/service-accounts/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2ServiceAccount + summary: Read a Service Account + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a service account. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the service account. + tags: + - Service Accounts (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Service Account. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.ServiceAccount' + - type: object + required: + - api_version + - kind + - id + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2ServiceAccount + summary: Update a Service Account + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a service account. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the service account. + tags: + - Service Accounts (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.ServiceAccount' + responses: + '200': + description: Service Account. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.ServiceAccount' + - type: object + required: + - api_version + - kind + - id + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2ServiceAccount + summary: Delete a Service Account + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a service account. + + If successful, this request will also recursively delete all of the service account's associated resources, + including its cloud and cluster API keys. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the service account. + tags: + - Service Accounts (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Service Account is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/invitations: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2Invitations + summary: List of Invitations + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all invitations. + parameters: + - name: email + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: johndoe@confluent.io + description: Filter the results by exact match for email. + - name: status + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: INVITE_STATUS_SENT + description: Filter the results by exact match for status. + - name: user + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: u-j93dy8 + description: Filter the results by exact match for user. + - name: creator + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: u-m2r9o7 + description: Filter the results by exact match for creator. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Invitations (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Invitation. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.InvitationList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2Invitation + summary: Create an Invitation + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an invitation. + + The newly invited user will not have any permissions. Give the user permission by assigning them to one or + more roles by creating + [role bindings](https://docs.confluent.io/cloud/current/api.html#tag/Role-Bindings-(iamv2)) + for the created `user`. + tags: + - Invitations (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.Invitation' + - type: object + required: + - email + responses: + '201': + description: An Invitation was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/invitations/{id} + description: Invitation resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.Invitation' + - type: object + required: + - email + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/invitations/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2Invitation + summary: Read an Invitation + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an invitation. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the invitation. + tags: + - Invitations (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Invitation. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.Invitation' + - type: object + required: + - api_version + - kind + - id + - email + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2Invitation + summary: Delete an Invitation + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an invitation. + + Delete will deactivate the user if the user didn't accept the invitation yet. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the invitation. + tags: + - Invitations (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Invitation is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/ip-groups: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + get: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + operationId: listIamV2IpGroups + summary: List of IP Groups + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all IP groups. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 25 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - IP Groups (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: IP Group. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IpGroupList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-page-first-available: true + x-page-last-available: true + x-page-from-start: true + x-page-from-end: true + post: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + operationId: createIamV2IpGroup + summary: Create an IP Group + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an IP group. + tags: + - IP Groups (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IpGroup' + - type: object + required: + - group_name + - cidr_blocks + responses: + '201': + description: An IP Group was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/ip-groups/{id} + description: IpGroup resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IpGroup' + - type: object + required: + - group_name + - cidr_blocks + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/ip-groups/{id}: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + get: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + operationId: getIamV2IpGroup + summary: Read an IP Group + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an IP group. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP group. + tags: + - IP Groups (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: IP Group. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IpGroup' + - type: object + required: + - api_version + - kind + - id + - group_name + - cidr_blocks + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + operationId: updateIamV2IpGroup + summary: Update an IP Group + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an IP group. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP group. + tags: + - IP Groups (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.IpGroup' + responses: + '200': + description: IP Group. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IpGroup' + - type: object + required: + - api_version + - kind + - id + - group_name + - cidr_blocks + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + operationId: deleteIamV2IpGroup + summary: Delete an IP Group + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an IP group. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP group. + tags: + - IP Groups (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An IP Group is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/ip-filters: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + get: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + operationId: listIamV2IpFilters + summary: List of IP Filters + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all IP filters. + parameters: + - name: resource_scope + in: query + required: false + schema: + type: string + description: Lists all filters belonging to the specified resource scope. + - name: include_parent_scopes + in: query + required: false + schema: + type: string + description: If set to true, this includes filters defined at the organization + level. The resource scope must also be set to use this parameter. + - name: page_size + in: query + required: false + schema: + type: integer + default: 25 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - IP Filters (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: IP Filter. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IpFilterList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-page-first-available: true + x-page-last-available: true + x-page-from-start: true + x-page-from-end: true + post: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + operationId: createIamV2IpFilter + summary: Create an IP Filter + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an IP filter. + tags: + - IP Filters (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IpFilter' + - type: object + required: + - filter_name + - resource_group + - ip_groups + responses: + '201': + description: An IP Filter was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/ip-filters/{id} + description: IpFilter resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IpFilter' + - type: object + required: + - filter_name + - resource_group + - ip_groups + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/ip-filters/{id}: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + get: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + operationId: getIamV2IpFilter + summary: Read an IP Filter + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an IP filter. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP filter. + tags: + - IP Filters (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: IP Filter. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IpFilter' + - type: object + required: + - api_version + - kind + - id + - filter_name + - resource_group + - ip_groups + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + operationId: updateIamV2IpFilter + summary: Update an IP Filter + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an IP filter. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP filter. + tags: + - IP Filters (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.IpFilter' + responses: + '200': + description: IP Filter. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IpFilter' + - type: object + required: + - api_version + - kind + - id + - filter_name + - resource_group + - ip_groups + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + operationId: deleteIamV2IpFilter + summary: Delete an IP Filter + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an IP filter. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP filter. + tags: + - IP Filters (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An IP Filter is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/ip-filter-summary: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filter Summary API + get: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filter Summary API + operationId: getIamV2IpFilterSummary + summary: Read an IP Filter Summary + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an IP filter summary. + parameters: + - name: scope + in: query + required: true + schema: + type: string + example: crn://confluent.cloud/organization=org-123/environment=env-abc + description: Scope the operation to the given scope. + tags: + - IP Filter Summaries (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: IP Filter Summary. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IpFilterSummary' + - type: object + required: + - api_version + - kind + - categories + - scope + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/role-bindings: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2RoleBindings + summary: List of Role Bindings + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all role bindings. + parameters: + - name: principal + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: User:u-111aaa + description: Filter the results by exact match for principal. + - name: role_name + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: CloudClusterAdmin + description: Filter the results by exact match for role_name. + - name: crn_pattern + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + description: Filter the results by a partial search of crn_pattern. + - name: page_size + in: query + required: false + schema: + type: integer + default: 1000 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Role Bindings (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Role Binding. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.RoleBindingList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2RoleBinding + summary: Create a Role Binding + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a role binding. + tags: + - Role Bindings (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.RoleBinding' + - type: object + required: + - principal + - role_name + - crn_pattern + responses: + '201': + description: A Role Binding was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/role-bindings/{id} + description: RoleBinding resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.RoleBinding' + - type: object + required: + - principal + - role_name + - crn_pattern + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/role-bindings/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2RoleBinding + summary: Read a Role Binding + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a role binding. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the role binding. + tags: + - Role Bindings (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Role Binding. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.RoleBinding' + - type: object + required: + - api_version + - kind + - id + - principal + - role_name + - crn_pattern + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2RoleBinding + summary: Delete a Role Binding + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a role binding. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the role binding. + tags: + - Role Bindings (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: A Role Binding is being deleted. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.RoleBinding' + - type: object + required: + - api_version + - kind + - id + - principal + - role_name + - crn_pattern + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /notifications/v1/subscriptions: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNotificationsV1Subscriptions + summary: List of Subscriptions + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all subscriptions. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 250 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Subscription. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.SubscriptionList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNotificationsV1Subscription + summary: Create a Subscription + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a subscription. + tags: + - Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.Subscription' + - type: object + required: + - notification_type + - integrations + responses: + '201': + description: A Subscription was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/notifications/v1/subscriptions/{id} + description: Subscription resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.Subscription' + - type: object + required: + - notification_type + - integrations + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /notifications/v1/subscriptions/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNotificationsV1Subscription + summary: Read a Subscription + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a subscription. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the subscription. + tags: + - Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Subscription. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.Subscription' + - type: object + required: + - api_version + - kind + - id + - notification_type + - integrations + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNotificationsV1Subscription + summary: Update a Subscription + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a subscription. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the subscription. + tags: + - Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/notifications.v1.Subscription' + responses: + '200': + description: Subscription. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.Subscription' + - type: object + required: + - api_version + - kind + - id + - notification_type + - integrations + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNotificationsV1Subscription + summary: Delete a Subscription + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a subscription. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the subscription. + tags: + - Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Subscription is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /notifications/v1/integrations: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNotificationsV1Integrations + summary: List of Integrations + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all integrations. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 250 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.IntegrationList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNotificationsV1Integration + summary: Create an Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an integration. + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.Integration' + - type: object + required: + - display_name + - target + responses: + '201': + description: An Integration was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/notifications/v1/integrations/{id} + description: Integration resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.Integration' + - type: object + required: + - display_name + - target + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /notifications/v1/integrations/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNotificationsV1Integration + summary: Read an Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an integration. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.Integration' + - type: object + required: + - api_version + - kind + - id + - display_name + - target + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNotificationsV1Integration + summary: Update an Integration + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an integration. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/notifications.v1.Integration' + responses: + '200': + description: Integration. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.Integration' + - type: object + required: + - api_version + - kind + - id + - display_name + - target + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNotificationsV1Integration + summary: Delete an Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an integration. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Integration is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /notifications/v1/integrations:test: + x-lifecycle-stage: General Availability + x-self-access: true + post: + summary: Test a Webhook, Slack or Microsoft Teams integration + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Sends a test notification to validate the integration. This is supported only for Webhook, Slack + and MsTeams targets + # This requestBody is copy-paste from POST /integrations endpoint + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.Integration' + - type: object + required: + - display_name + - target + x-lifecycle-stage: General Availability + x-self-access: true + x-name: notifications.v1.Integration + operationId: testNotificationsV1Integration + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: Notification sent to test integration. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /notifications/v1/notification-types/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNotificationsV1NotificationType + summary: Read a Notification Type + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a notification type. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the notification type. + tags: + - Notification Types (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Notification Type. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.NotificationType' + - type: object + required: + - api_version + - kind + - id + - display_name + - category + - description + - subscription_priority + - is_included_in_plan + - severity + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /notifications/v1/notification-types: + x-lifecycle-stage: General Availability + x-self-access: true + get: + summary: Retrieve a list of all notification types for the resource type. + parameters: + - name: resource_type + description: Confluent Cloud resource type + in: query + required: false + schema: + type: string + x-extensible-enum: [ENVIRONMENT, CLUSTER, CONNECTOR, FLINK_COMPUTE_POOL, + FLINK_STATEMENT] + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 250 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNotificationsV1NotificationTypes + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to list_by_resource_type a notification type. + tags: + - Notification Types (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: List of Notification Type. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.NotificationTypeList' + # All attributes here are also a part of the Admin API. If you introduce a change to + # any of the fields, make sure to change it in both the places (notifications/minispec.yaml and + # notifications-admin/minispec.yaml). + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /notifications/v1/resource-preferences: + x-lifecycle-stage: General Availability + x-self-access: true + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNotificationsV1ResourcePreference + summary: Create a Resource Preference + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a resource preference. + tags: + - Resource Preferences (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.ResourcePreference' + - type: object + required: + - resource + - resource_type + responses: + '201': + description: A Resource Preference was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/notifications/v1/resource-preferences/{id} + description: ResourcePreference resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.ResourcePreference' + - type: object + required: + - resource + - resource_type + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /notifications/v1/resource-preferences/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNotificationsV1ResourcePreference + summary: Read a Resource Preference + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a resource preference. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource preference. + tags: + - Resource Preferences (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Resource Preference. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.ResourcePreference' + - type: object + required: + - api_version + - kind + - id + - resource + - resource_type + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNotificationsV1ResourcePreference + summary: Update a Resource Preference + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a resource preference. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource preference. + tags: + - Resource Preferences (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/notifications.v1.ResourcePreference' + responses: + '200': + description: Resource Preference. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.ResourcePreference' + - type: object + required: + - api_version + - kind + - id + - resource + - resource_type + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNotificationsV1ResourcePreference + summary: Delete a Resource Preference + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a resource preference. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource preference. + tags: + - Resource Preferences (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Resource Preference is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /notifications/v1/resource-preferences:lookup: + x-lifecycle-stage: General Availability + x-self-access: true + get: + summary: Lookup a resource preference by filter (returns one) + parameters: + - name: resource + description: Confluent Cloud resource definition + in: query + required: true + schema: + type: string + - name: resource_type + description: Confluent Cloud resource type + in: query + required: true + schema: + type: string + x-extensible-enum: [ORGANIZATION, ENVIRONMENT, CLUSTER, CONNECTOR, FLINK_COMPUTE_POOL, + FLINK_STATEMENT] + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 250 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + x-lifecycle-stage: General Availability + x-self-access: true + x-name: notifications.v1.ResourcePreference + operationId: getNotificationsV1ResourcePreferenceByFilter + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read_by_filter a resource preference. + tags: + - Resource Preferences (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Resource Preference. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.ResourcePreference' + - type: object + required: + - api_version + - kind + - id + - resource + - resource_type + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /notifications/v1/resource-subscriptions: + x-lifecycle-stage: General Availability + x-self-access: true + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNotificationsV1ResourceSubscription + summary: Create a Resource Subscription + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a resource subscription. + tags: + - Resource Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.ResourceSubscription' + - type: object + required: + - resource + - resource_type + - notification_type + - integrations + responses: + '201': + description: A Resource Subscription was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/notifications/v1/resource-subscriptions/{id} + description: ResourceSubscription resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.ResourceSubscription' + - type: object + required: + - resource + - resource_type + - notification_type + - integrations + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /notifications/v1/resource-subscriptions/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNotificationsV1ResourceSubscription + summary: Read a Resource Subscription + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a resource subscription. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource subscription. + tags: + - Resource Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Resource Subscription. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.ResourceSubscription' + - type: object + required: + - api_version + - kind + - id + - resource + - resource_type + - notification_type + - integrations + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNotificationsV1ResourceSubscription + summary: Update a Resource Subscription + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a resource subscription. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource subscription. + tags: + - Resource Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/notifications.v1.ResourceSubscription' + responses: + '200': + description: Resource Subscription. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.ResourceSubscription' + - type: object + required: + - api_version + - kind + - id + - resource + - resource_type + - notification_type + - integrations + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNotificationsV1ResourceSubscription + summary: Delete a Resource Subscription + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a resource subscription. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource subscription. + tags: + - Resource Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Resource Subscription is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /notifications/v1/resource-subscriptions:lookup: + x-lifecycle-stage: General Availability + x-self-access: true + get: + summary: Lookup a list of resource subscription by filter + parameters: + - name: resource + description: Confluent Cloud resource definition + in: query + required: true + schema: + type: string + - name: resource_type + description: Confluent Cloud resource type + in: query + required: true + schema: + type: string + x-extensible-enum: [ENVIRONMENT, CLUSTER, CONNECTOR, FLINK_COMPUTE_POOL, + FLINK_STATEMENT] + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 250 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNotificationsV1ResourceSubscriptionsByFilter + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to list_by_filter a resource subscription. + tags: + - Resource Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: List of ResourceSubscriptions + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/notifications.v1.ResourceSubscriptionList' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cmk/v2/clusters: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCmkV2Clusters + summary: List of Clusters + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [n-00000, n-00001] + description: Filter the results by exact match for spec.network. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Clusters (cmk/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cmk.v2.ClusterList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + byok: + example: + id: cck-00000 + related: https://api.confluent.cloud/byok/v1/keys/cck-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/key=cck-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createCmkV2Cluster + summary: Create a Cluster + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a cluster. + tags: + - Clusters (cmk/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cmk.v2.Cluster' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - display_name + - availability + - cloud + - region + - config + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + network: + example: + id: n-00000 + byok: + example: + id: cck-00000 + responses: + '202': + description: A Cluster is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/cmk/v2/clusters/{id} + description: Cluster resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cmk.v2.Cluster' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - display_name + - availability + - cloud + - region + - config + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + byok: + example: + id: cck-00000 + related: https://api.confluent.cloud/byok/v1/keys/cck-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/key=cck-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cmk/v2/clusters/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCmkV2Cluster + summary: Read a Cluster + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (cmk/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cmk.v2.Cluster' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - display_name + - availability + - cloud + - region + - config + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + byok: + example: + id: cck-00000 + related: https://api.confluent.cloud/byok/v1/keys/cck-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/key=cck-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateCmkV2Cluster + summary: Update a Cluster + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a cluster. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (cmk/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cmk.v2.Cluster' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Cluster. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cmk.v2.Cluster' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - display_name + - availability + - cloud + - region + - config + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + byok: + example: + id: cck-00000 + related: https://api.confluent.cloud/byok/v1/keys/cck-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/key=cck-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteCmkV2Cluster + summary: Delete a Cluster + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (cmk/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Cluster is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /ksqldbcm/v2/clusters: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listKsqldbcmV2Clusters + summary: List of Clusters + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Clusters (ksqldbcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ksqldbcm.v2.ClusterList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + kafka_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + credential_identity: + example: + id: u-a83k9b + related: https://api.confluent.cloud/iam/v2/users/u-a83k9b + resource_name: https://api.confluent.cloud/user=u-a83k9b + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createKsqldbcmV2Cluster + summary: Create a Cluster + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a cluster. + tags: + - Clusters (ksqldbcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ksqldbcm.v2.Cluster' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - display_name + - csu + - kafka_cluster + - credential_identity + - environment + - type: object + properties: + spec: + type: object + properties: + kafka_cluster: + example: + id: lkc-00000 + credential_identity: + example: + id: u-a83k9b + environment: + example: + id: env-00000 + responses: + '202': + description: A Cluster is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/ksqldbcm/v2/clusters/{id} + description: Cluster resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ksqldbcm.v2.Cluster' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - display_name + - csu + - kafka_cluster + - credential_identity + - environment + - type: object + properties: + spec: + type: object + properties: + kafka_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + credential_identity: + example: + id: u-a83k9b + related: https://api.confluent.cloud/iam/v2/users/u-a83k9b + resource_name: https://api.confluent.cloud/user=u-a83k9b + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /ksqldbcm/v2/clusters/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getKsqldbcmV2Cluster + summary: Read a Cluster + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (ksqldbcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ksqldbcm.v2.Cluster' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - display_name + - csu + - kafka_cluster + - credential_identity + - environment + - type: object + properties: + spec: + type: object + properties: + kafka_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + credential_identity: + example: + id: u-a83k9b + related: https://api.confluent.cloud/iam/v2/users/u-a83k9b + resource_name: https://api.confluent.cloud/user=u-a83k9b + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteKsqldbcmV2Cluster + summary: Delete a Cluster + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (ksqldbcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Cluster is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors: + x-lifecycle-stage: General Availability + get: + x-lifecycle-stage: General Availability + operationId: listConnectv1Connectors + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a list of "names" of the active connectors. You can then make a [read request](#operation/readConnectv1Connector) for a specific connector by name. + summary: List of Connectors + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + parameters: [] + responses: + '200': + description: Connector. + content: + application/json: + schema: + type: array + description: List of connector names + items: + type: string + description: Connector name + example: + - MyGcsLogsBucketConnector + - MyS3BucketConnector + - MyDatagenConnector + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + post: + x-lifecycle-stage: General Availability + operationId: createConnectv1Connector + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Create a new connector. Returns the new connector information if successful. + summary: Create a Connector + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorWithOffsets' + example: + name: MyGcsLogsBucketConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '1' + time.interval: DAILY + topics: APILogsTopic + tasks: + - connector: MyGcsLogsBucketConnector + task: 0 + type: sink + offsets: + - partition: + kafka_partition: 0 + kafka_topic: APILogsTopic + offset: + kafka_offset: 1000 + headers: {} + '400': + description: Bad Request + content: + application/json: + schema: + type: object + properties: + code: + type: integer + message: + type: string + example: + error: + code: 400 + message: Unauthorized + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error + content: + application/json: + schema: + type: object + properties: + error_code: + type: integer + message: + type: string + example: + error_code: 500 + message: Failed to find any class that implements Connector and which + name matches io.confluent.connect.... + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: Name of the connector to create. + config: + type: object + description: Configuration parameters for the connector. All values + should be strings. + # Connectors support additionalProperties which may be secrets, so we should just redact it all. + # TODO: openapi-generator doesn't support generating Redact() for fields with additionalProperties + # (x-redact on the top-level 'config' or on a specific field within 'config', e.g., kafka.api.secret) + # However, Connect doesn't actually use any generated SDKs from this openapi... so not a big deal for now + x-redact: true + required: + - connector.class + - name + - kafka.api.key + - kafka.api.secret + properties: + connector.class: + type: string + description: \[Required for Managed Connector, Ignored for Custom + Connector\] The connector class name, e.g., BigQuerySink, + GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + For custom connector, it must be the same as the name of the + connector to create. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + confluent.connector.type: + type: string + description: | + \[Required for Custom Connector\] The connector type. + example: CUSTOM + default: MANAGED + x-extensible-enum: + - CUSTOM + - MANAGED + confluent.custom.plugin.id: + type: string + example: ccp-lq5m06 + description: | + \[Required for Custom Connector\] The custom plugin id of custom connector, e.g., `ccp-lq5m06` + confluent.custom.connection.endpoints: + type: string + description: | + \[Optional for Custom Connector\] Egress endpoint(s) for the connector to use when attaching to the sink or source data system. + confluent.custom.schema.registry.auto: + type: string + description: | + \[Optional for Custom Connector\] Automatically add the required schema registry properties in a custom connector config if schema registry is enabled. + example: 'FALSE' + default: 'FALSE' + x-extensible-enum: + - 'TRUE' + - 'FALSE' + confluent.custom.connect.plugin.runtime: + type: string + description: | + \[Optional for Custom Connector\] The runtime of the custom connector plugin. + example: 3.9.0 + confluent.custom.connect.java.version: + type: string + description: | + \[Optional for Custom Connector\] The Java version of the custom connector plugin. + example: '17' + additionalProperties: + type: string + description: Other configuration parameters for the connector. + All values should be strings. See the connector's docs for details. + offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + examples: + sink: + value: + name: MyGcsLogsBucketConnector + config: + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + offsets: + - partition: + kafka_partition: 0 + kafka_topic: APILogsTopic + offset: + kafka_offset: 1000 + source: + value: + name: MySqlCdcSourceV2Connector_0 + config: + connector.class: MySqlCdcSourceV2 + output.data.format: JSON + flush.size: '1000' + database.hostname: 12.34.567.98 + database.password: '****************' + database.port: '1234' + database.user: '****' + kafka.api.key: '****************' + kafka.api.secret: '****************' + name: MySqlCdcSourceV2Connector_0 + tasks.max: '1' + time.interval: DAILY + topic.prefix: test + offsets: + - partition: + server: test + offset: + file: mysql-bin.000123 + pos: 154 + ts_sec: 1712907333 + description: '' + parameters: + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs + to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id: + x-lifecycle-stage: General Availability + get: + x-lifecycle-stage: General Availability + operationId: listConnectv1ConnectorsWithExpansions + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve an object with the queried expansions of all connectors. Without `expand` query parameter, this list connector’s endpoint will return a [list of only the connector names](#operation/listConnectv1Connectors). + summary: List of Connectors with Expansions + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector. + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorExpansionMap' + example: + MyGcsLogsBucketConnector: + id: + id: lcc-xxxxx + id_type: ID + info: + name: MyGcsLogsBucketConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '1' + time.interval: DAILY + topics: APILogsTopic + type: sink + status: + name: MyGcsLogsBucketConnector + connector: + state: PROVISIONING + worker_id: MyGcsLogsBucketConnector + trace: '' + tasks: [] + type: sink + MyS3BucketConnector: + id: + id: lcc-xxxxx + id_type: ID + info: + name: MyS3BucketConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: S3Sink + data.format: BYTES + flush.size: '1000' + s3.bucket: APILogsBucket + aws.access.key.id: '************' + aws.secret.access.key: '**********' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyS3BucketConnector + tasks.max: '1' + time.interval: DAILY + topics: APILogsTopic + type: source + status: + name: MyS3BucketConnector + connector: + state: FAILED + worker_id: MyS3BucketConnector + trace: "There were some errors with your configuration:\ntopics:\ + \ Provided Kafka ApiKey is invalid\nkafka.api.secret: Provided\ + \ Kafka ApiKey is invalid\n" + tasks: [] + type: sink + MyDatagenConnector: + id: + id: lcc-xxxxx + id_type: ID + info: + name: MyDatagenConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: DatagenSource + data.format: BYTES + flush.size: '1000' + quickstart: ORDERS + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyDatagenConnector + tasks.max: '1' + time.interval: DAILY + topics: APILogsTopic + type: source + status: + name: MyDatagenConnector + connector: + state: RUNNING + worker_id: MyDatagenConnector + trace: '' + tasks: + - id: 0 + msg: '' + state: RUNNING + worker_id: MyDatagenConnector + type: source + + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs + to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + - name: expand + in: query + description: |- + - id : Returns metadata of each connector such as id and id type. + - info : Returns metadata of each connector such as the configuration, task + information, and type of connector. + - status : Returns additional state information of each connector including their status and tasks. + schema: + type: string + enum: + - id + - info + - status + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config: + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs + to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + get: + x-lifecycle-stage: General Availability + operationId: getConnectv1ConnectorConfig + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get the configuration for the connector. + summary: Read a Connector Configuration + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector. + content: + application/json: + schema: + type: object + description: Configuration parameters for the connector. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: [aws, azure, gcp] + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, + etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + For Custom Connector, it must be the same as connector_name. + kafka.endpoint: + type: string + description: The kafka cluster endpoint. + kafka.region: + type: string + description: The kafka cluster region. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + additionalProperties: + type: string + description: Other configuration parameters for the connector. See + the connector's docs for the list of options. + example: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + put: + x-lifecycle-stage: General Availability + operationId: createOrUpdateConnectv1ConnectorConfig + description: Create a new connector using the given configuration, or update + the configuration for an existing connector. Returns information about the + connector after the change has been made. + summary: Create or Update a Connector Configuration + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: Configuration parameters for the connector. + required: + - connector.class + - name + - kafka.api.key + - kafka.api.secret + properties: + connector.class: + type: string + description: \[Required for Managed Connector, Ignored for Custom + Connector\] The connector class name. E.g. BigQuerySink, GcsSink, + etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + confluent.connector.type: + type: string + description: | + \[Required for Custom Connector\] The connector type. + example: CUSTOM + default: MANAGED + x-extensible-enum: + - CUSTOM + - MANAGED + confluent.custom.plugin.id: + type: string + example: ccp-lq5m06 + description: | + \[Required for Custom Connector\] The custom plugin id of custom connector, e.g., `ccp-lq5m06` + confluent.custom.connection.endpoints: + type: string + description: | + \[Optional for Custom Connector\] Egress endpoint(s) for the connector to use when attaching to the sink or source data system. + confluent.custom.schema.registry.auto: + type: string + description: | + \[Optional for Custom Connector\] Automatically add the required schema registry properties in a custom connector config if schema registry is enabled. + example: 'FALSE' + default: 'FALSE' + x-extensible-enum: + - 'TRUE' + - 'FALSE' + confluent.custom.connect.plugin.runtime: + type: string + description: | + \[Optional for Custom Connector\] The runtime of the custom connector plugin. By default this is the latest version available. If not provided this config is updated internally to reflect the version used. + example: 3.9.0 + confluent.custom.connect.java.version: + type: string + description: | + \[Optional for Custom Connector\] The Java version of the custom connector plugin. By default this is the latest version supported by the latest runtime. If not provided this config is updated internally to reflect the version used. + example: '17' + additionalProperties: + type: string + description: Other configuration parameters for the connector. All + values should be strings. See the connector's docs for details. + example: + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + description: Configuration parameters for the connector. All values should + be strings. + responses: + '200': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.Connector' + example: + name: MyGcsLogsBucketConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + tasks: + - connector: MyGcsLogsBucketConnector + task: 0 + - connector: MyGcsLogsBucketConnector + task: 1 + type: sink + '400': + $ref: '#/components/responses/connect.v1.BadRequestError' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error + content: + application/json: + schema: + type: object + properties: + error_code: + type: integer + message: + type: string + example: + error_code: 500 + message: Failed to find any class that implements Connector and which + name matches io.confluent.connect.... + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}: + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs + to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + get: + x-lifecycle-stage: General Availability + operationId: readConnectv1Connector + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get information about the connector. + summary: Read a Connector + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector. + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.Connector' + example: + name: MyGcsLogsBucketConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '1' + time.interval: DAILY + topics: APILogsTopic + tasks: + - connector: MyGcsLogsBucketConnector + task: 0 + type: sink + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + operationId: deleteConnectv1Connector + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete a connector. Halts all tasks and deletes the connector configuration. + summary: Delete a Connector + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + $ref: '#/components/responses/connect.v1.OK' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause: + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs + to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + put: + x-lifecycle-stage: General Availability + operationId: pauseConnectv1Connector + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Pause the connector and its tasks. Stops message processing until the connector is resumed. This call is asynchronous and the tasks will not transition to PAUSED state at the same time. + summary: Pause a Connector + tags: + - Lifecycle (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '202': + description: Accepted + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume: + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs + to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + put: + x-lifecycle-stage: General Availability + operationId: resumeConnectv1Connector + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Resume a paused connector or do nothing if the connector is not paused. This call is asynchronous and the tasks will not transition to RUNNING state at the same time. + summary: Resume a Connector + tags: + - Lifecycle (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '202': + description: Accepted + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart: + x-lifecycle-stage: Preview + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs + to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + post: + x-lifecycle-stage: Preview + operationId: restartConnectv1Connector + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + Restart the connector and its tasks. Stops message processing until the connector and tasks are restart. This call is asynchronous and the connector will not transition to another state at the same time. + summary: Restart a Connector + tags: + - Lifecycle (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '202': + description: Accepted + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '403': + $ref: '#/components/responses/connect.v1.ForbiddenError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status: + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs + to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + get: + x-lifecycle-stage: General Availability + operationId: readConnectv1ConnectorStatus + description: Get current status of the connector. This includes whether it is + running, failed, or paused. Also includes which worker it is assigned to, + error information if it has failed, and the state of all its tasks. + summary: Read a Connector Status + tags: + - Status (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the connector. + type: + type: string + description: Type of connector, sink or source. + enum: [sink, source] + connector: + type: object + description: The map containing connector status. + required: + - state + - worker_id + properties: + state: + type: string + description: The state of the connector. + enum: + - NONE + - PROVISIONING + - RUNNING + - DEGRADED + - FAILED + - PAUSED + - DELETED + worker_id: + type: string + description: The worker ID of the connector. + trace: + type: string + description: The exception name in case of error. + tasks: + type: array + description: The map containing the task status. + items: + type: object + properties: + id: + type: integer + description: The ID of task. + state: + type: string + description: The state of the task. + worker_id: + type: string + description: The worker ID of the task. + msg: + type: string + required: + - id + - state + - worker_id + required: + - name + - type + - connector + example: + name: MyGcsLogsBucketConnector + connector: + state: PROVISIONING + worker_id: MyGcsLogsBucketConnector + trace: '' + tasks: [] + type: source + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks: + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs + to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + get: + x-lifecycle-stage: General Availability + operationId: listConnectv1ConnectorTasks + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get a list of tasks currently running for the connector. + summary: List of Connector Tasks + tags: + - Status (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector Task. + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.Connectors' + example: + - id: + connector: MyGcsLogsBucketConnector + task: 2 + config: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins: + x-lifecycle-stage: General Availability + get: + x-lifecycle-stage: General Availability + operationId: listConnectv1ConnectorPlugins + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return a list of Managed Connector plugins installed in the Kafka Connect cluster. + summary: List of Managed Connector plugins + tags: + - Managed Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector Plugin. + content: + application/json: + schema: + type: array + items: + type: object + properties: + class: + type: string + description: The connector class name. E.g. BigQuerySink. + type: + type: string + description: Type of connector, sink or source. + enum: [sink, source] + version: + type: string + description: The version string for the connector available. + required: + - class + - type + example: + - class: BigQuerySink + type: sink + - class: KinesisSource + type: source + version: 0.1.0 + - class: PostgresSource + type: source + version: 0.1.0 + - class: S3_SINK + type: sink + - class: GcsSink + type: sink + version: 0.2.0 + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: [] + parameters: + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs + to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate: + x-lifecycle-stage: General Availability + parameters: + - name: plugin_name + in: path + schema: + type: string + required: true + description: The unique name of the connector plugin. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs + to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + put: + x-lifecycle-stage: General Availability + operationId: validateConnectv1ConnectorPlugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Validate the provided configuration values against the configuration definition. This API performs per config validation and returns suggested values and validation error messages. + summary: Validate a Managed Connector Plugin + tags: + - Managed Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector Plugin. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The class name of the connector plugin. + groups: + type: array + description: The list of groups used in configuration definitions. + items: + type: string + error_count: + type: integer + description: The total number of errors encountered during configuration + validation. + configs: + type: array + items: + type: object + properties: + definition: + type: object + description: The definition for a config in the connector + plugin, which includes the name, type, importance, etc. + properties: + name: + type: string + description: The name of the configuration + type: + type: string + enum: + - NONE + - BOOLEAN + - INT + - SHORT + - LONG + - DOUBLE + - STRING + - LIST + - ENUM + - PASSWORD + description: The config types + required: + type: boolean + description: Whether this configuration is required + default_value: + type: string + description: Default value for this configuration + importance: + type: string + enum: + - NONE + - HIGH + - MEDIUM + - LOW + description: The importance level for a configuration + documentation: + type: string + description: The documentation for the configuration + group: + type: string + description: The UI group to which the configuration + belongs to + width: + type: string + enum: + - NONE + - SHORT + - MEDIUM + - LONG + description: The width of a configuration value + display_name: + type: string + dependents: + type: array + description: Other configurations on which this configuration + is dependent + items: + type: string + order: + type: integer + description: The order of configuration in specified + group + alias: + type: string + value: + type: object + description: The current value for a config, which includes + the name, value, recommended values, etc. + properties: + name: + type: string + description: The name of the configuration + value: + type: string + description: The value for the configuration + recommended_values: + type: array + description: The list of valid values for the configuration + items: + type: string + errors: + type: array + description: Errors, if any, in the configuration value + items: + type: string + visible: + type: boolean + description: |- + The visibility of the configuration. Based on the values of other configuration + fields, this visibility boolean value points out if the current field should be + visible or not. + metadata: + type: object + description: |- + Map of metadata details about the connector configuration, such as type of + input, etc. + example: + name: io.confluent.connect.gcs.GcsSinkConnector + groups: + - Organize my data by... + - Which topics do you want to get data from? + - Messages + - How should we connect to your data? + - Google Cloud Storage details + - Kafka Cluster credentials + - Number of tasks for this connector + error_count: 1 + configs: + - definition: + name: name + type: STRING + required: true + default_value: '' + importance: HIGH + documentation: Sets a name for your connector. + group: How should we connect to your data? + width: NONE + display_name: Connector name + dependents: [] + order: 2 + alias: '' + value: + name: name + value: '{{.logicalClusterId}}' + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: connector.class + type: STRING + required: true + default_value: '' + importance: HIGH + documentation: '' + group: How should we connect to your data? + width: NONE + display_name: Connector class + dependents: [] + order: 1 + alias: '' + value: + name: connector.class + value: io.confluent.connect.gcs.GcsSinkConnector + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: kafka.api.key + type: PASSWORD + required: true + default_value: '' + importance: HIGH + documentation: '' + group: Kafka Cluster credentials + width: NONE + display_name: Kafka API Key + dependents: [] + order: 1 + alias: '' + value: + name: kafka.api.key + value: '' + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: kafka.api.secret + type: PASSWORD + required: true + default_value: '' + importance: HIGH + documentation: '' + group: Kafka Cluster credentials + width: NONE + display_name: Kafka API Secret + dependents: + - kafka.api.key + order: 2 + alias: '' + value: + name: kafka.api.secret + value: '' + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: topics + type: LIST + required: true + default_value: '' + importance: HIGH + documentation: Identifies the topic name or a comma-separated + list of topic names. + group: Which topics do you want to get data from? + width: NONE + display_name: Topic names + dependents: [] + order: 1 + alias: '' + value: + name: topics + value: test1 + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: data.format + type: STRING + required: true + default_value: '' + importance: HIGH + documentation: Sets the input/output message format. Valid entries + are AVRO, JSON, or BYTES + group: Messages + width: NONE + display_name: Message format + dependents: [] + order: 1 + alias: '' + value: + name: data.format + value: BYTES + recommended_values: + - BYTES + - JSON + - AVRO + errors: [] + visible: true + metadata: {} + - definition: + name: gcs.credentials.config + type: PASSWORD + required: true + default_value: '' + importance: HIGH + documentation: Contents of the downloaded GCP service account + JSON file. + group: Google Cloud Storage details + width: NONE + display_name: Google Cloud Storage credentials. + dependents: [] + order: 1 + alias: '' + value: + name: gcs.credentials.config + value: '' + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: gcs.bucket.name + type: STRING + required: true + default_value: '' + importance: HIGH + documentation: A Google Cloud Storage bucket must be in the + same region as your Confluent Cloud cluster. + group: Google Cloud Storage details + width: NONE + display_name: Bucket name. + dependents: [] + order: 2 + alias: '' + value: + name: gcs.bucket.name + value: gmagare + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: time.interval + type: STRING + required: true + default_value: '' + importance: HIGH + documentation: Sets how your messages grouped in storage. Valid + entries are DAILY or HOURLY. + group: Organize my data by... + width: NONE + display_name: Time interval + dependents: [] + order: 1 + alias: '' + value: + name: time.interval + value: DAILY + recommended_values: + - DAILY + - HOURLY + errors: [] + visible: true + metadata: {} + - definition: + name: tasks.max + type: INT + required: true + default_value: '' + importance: HIGH + documentation: '' + group: Number of tasks for this connector + width: NONE + display_name: Tasks + dependents: [] + order: 1 + alias: '' + value: + name: tasks.max + value: '1' + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: flush.size + type: INT + required: true + default_value: '1000' + importance: HIGH + documentation: This value defaults to 1000. For example, if + you use the default setting of 1000 and your topic has six + partitions, files start to be created in the storage bucket + after more than 1000 records exist in each partition. Note + that the default value of 1000 can be increased if needed. + group: Organize my data by... + width: NONE + display_name: Flush size + dependents: [] + order: 2 + alias: '' + value: + name: flush.size + value: '1' + recommended_values: [] + errors: + - '"flush.size" should be greater than or equal to 1000' + visible: true + metadata: {} + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + requestBody: + content: + application/json: + schema: + type: object + description: Configuration parameters for the connector. All values + should be strings. + additionalProperties: + type: string + description: Other configuration parameters for the connector. All + values should be strings. See the connector's docs for the list + of options. + example: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '500' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + description: Configuration parameters for the connector. All values should + be strings. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/translate?mask_sensitive=true: + x-lifecycle-stage: General Availability + parameters: + - name: plugin_name + in: path + schema: + type: string + required: true + description: The unique name of the connector plugin. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs + to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + - name: mask_sensitive + in: query + required: false + schema: + type: string + maxLength: 255 + description: Indicates whether to redact sensitive config values in response. + put: + x-lifecycle-stage: General Availability + operationId: translateConnectv1ConnectorPlugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Translate the provided Self Managed configuration values. This API performs configuration translation + and returns the translated fully managed configuration along with any errors or warnings. + Query Parameter `mask_sensitive=true` redacts sensitive config values in response. + summary: Translate Self Managed Connector Plugin Configurations to Fully Managed + Connector Plugin Configurations + tags: + - Managed Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: Configuration parameters for the self managed connector. + All values should be strings. + additionalProperties: + type: string + description: Configuration parameters for the self managed connector. + All values should be strings. See the self managed connector's docs + for the list of options. + example: + topics: nidhi_topic + input.data.format: JSON + connector.class: io.confluent.connect.datadog.metrics.DatadogMetricsSinkConnector + name: DatadogMetricsSinkConnector_87 + datadog.api.key: 535069c094cdfd1a55fb3e80eba09241 + datadog.domain: COM + max.retry.time.ms: '5000' + behavior.on.error: log + tasks.max: '1' + errors.tolerance: all + errors.deadletterqueue.context.headers.enable: 'true' + errors.log.include.messages: 'true' + errors.log.enable: 'true' + reporter.bootstrap.servers: localhost:9092 + reporter.error.topic.replication.factor: '1' + confluent.topic.bootstrap.servers: localhost:9092 + confluent.topic.replication.factor: '1' + description: Configuration parameters for the connector. All values should + be strings. + responses: + '200': + description: Connector Plugin translation result. + content: + application/json: + schema: + type: object + properties: + config: + type: object + description: The translated configuration + additionalProperties: + type: string + errors: + type: array + description: List of configuration errors + items: + type: object + properties: + field: + type: string + description: The field name that has an error + message: + type: string + description: The error message + required: + - field + - message + warnings: + type: array + description: List of configuration warnings + items: + type: object + properties: + field: + type: string + description: The field name that has a warning + message: + type: string + description: The warning message + required: + - field + - message + example: + config: + connector.class: DatadogMetricsSink + name: DatadogMetricsSinkConnector_87 + topics: nidhi_topic + datadog.api.key: '****************' + datadog.domain: COM + max.retry.time.ms: '5000' + behavior.on.error: log + tasks.max: '1' + errors.tolerance: all + errors.deadletterqueue.context.headers.enable: 'true' + errors.log.include.messages: 'true' + errors.log.enable: 'true' + confluent.topic.bootstrap.servers: localhost:9092 + input.data.format: JSON + max.poll.interval.ms: '300000' + max.poll.records: '500' + errors: + - field: datadog.site + message: Required config is missing. + warnings: + - field: confluent.topic.bootstrap.servers + message: Customer given value is ignored. Default value is used. + - field: reporter.error.topic.replication.factor + message: Customer given value is ignored. Default value is used. + - field: confluent.topic.replication.factor + message: Customer given value is ignored. Default value is used. + '400': + $ref: '#/components/responses/connect.v1.BadRequestError' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '403': + $ref: '#/components/responses/connect.v1.ForbiddenError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets: + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs + to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + get: + x-lifecycle-stage: General Availability + operationId: getConnectv1ConnectorOffsets + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get the current offsets for the connector. The offsets provide information on the point in the source system, + from which the connector is pulling in data. The offsets of a connector are continuously observed periodically and are queryable via this API. + summary: Get a Connector Offsets + tags: + - Offsets (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector Offsets. + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorOffsets' + examples: + sink: + value: + id: lcc-as341 + name: MysqlSinkConnector + offsets: + - partition: + kafka_partition: 0 + kafka_topic: topic_A + offset: + kafka_offset: 20032323 + - partition: + kafka_partition: 1 + kafka_topic: topic_B + offset: + kafka_offset: 20032322 + metadata: + observed_at: 2024-02-20T15:14:19Z + source: + value: + id: lcc-21sdda + name: MysqlSourceConnector + offsets: + - partition: + protocol: 1 + table: sourcedb.sourcetable + offset: + timestamp_nanos: 0 + incrementing: 3 + timestamp: 1699142400000 + metadata: + observed_at: 2024-02-20T15:14:19Z + '400': + $ref: '#/components/responses/connect.v1.BadRequestError' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '403': + $ref: '#/components/responses/connect.v1.ForbiddenError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request: + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs + to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + post: + x-lifecycle-stage: General Availability + operationId: alterConnectv1ConnectorOffsetsRequest + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Request to alter the offsets of a connector. This supports the ability to PATCH/DELETE the offsets of a connector. + Note, you will see momentary downtime as this will internally stop the connector, while the offsets are being altered. + You can only make one alter offsets request at a time for a connector. + summary: Request to Alter the Connector Offsets + tags: + - Offsets (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '202': + description: Accepted + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.AlterOffsetRequestInfo' + examples: + patch: + value: + id: lcc-sa32er + name: MySinkConnector + offsets: + - partition: + kafka_partition: 0 + kafka_topic: topic_A + offset: + kafka_offset: 1000 + requested_at: 2024-02-20T15:14:19Z + type: PATCH + delete: + value: + id: lcc-234ds + name: MySourceConnector + offsets: [] + requested_at: 2024-02-20T15:14:19Z + type: DELETE + '400': + $ref: '#/components/responses/connect.v1.BadRequestError' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '403': + $ref: '#/components/responses/connect.v1.ForbiddenError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.AlterOffsetRequest' + examples: + patch sink: + value: + type: PATCH + offsets: + - partition: + kafka_partition: 0 + kafka_topic: topic_A + offset: + kafka_offset: 1000 + patch source: + value: + type: PATCH + offsets: + - partition: + protocol: 1 + table: sourcedb.sourcetable + offset: + timestamp_nanos: 0 + incrementing: 3 + timestamp: 1699000000000 + delete: + value: + type: DELETE + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status: + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs + to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + get: + x-lifecycle-stage: General Availability + operationId: getConnectv1ConnectorOffsetsRequestStatus + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get the status of the previous alter offset request. + summary: Get the Status of Alter Offset Request + tags: + - Offsets (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector Offsets Request Status. + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.AlterOffsetStatus' + examples: + sink - pending patch operation: + value: + request: + id: lcc-sa32er + name: MySinkConnector + offsets: + - partition: + kafka_partition: 0 + kafka_topic: topic_A + offset: + kafka_offset: 1000 + requested_at: 2024-02-20T15:14:19Z + type: PATCH + status: + phase: PENDING + applied_at: + source - applied patch operation: + value: + request: + id: lcc-x1sdfs + name: MySourceConnector + offsets: + - partition: + protocol: 1 + table: sourcedb.sourcetable + offset: + timestamp_nanos: 0 + incrementing: 3 + timestamp: 1699000000000 + requested_at: 2024-02-20T15:14:19Z + type: PATCH + status: + phase: APPLIED + message: |- + The Connect framework-managed offsets for this connector have been altered successfully. However, if this connector manages offsets externally, they will need to be altered manually in the system that the connector uses. + previous_offsets: + - partition: + protocol: 1 + table: sourcedb.sourcetable + offset: + timestamp_nanos: 0 + incrementing: 2 + timestamp: 1698329479943 + applied_at: 2024-02-20T15:14:20+0000 + delete: + value: + request: + id: lcc-234ds + name: MySourceConnector + offsets: [] + requested_at: 2024-02-20T15:14:19Z + type: DELETE + status: + phase: APPLIED + message: |- + The Connect framework-managed offsets for this connector have been reset successfully. However, if this connector manages offsets externally, they will need to be reset manually in the system that the connector uses. + previous_offsets: + - partition: + protocol: 1 + table: sourcedb.sourcetable + offset: + timestamp_nanos: 0 + incrementing: 2 + timestamp: 1698329479943 + applied_at: 2024-02-20T15:14:20Z + '400': + $ref: '#/components/responses/connect.v1.BadRequestError' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '403': + $ref: '#/components/responses/connect.v1.ForbiddenError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + /connect/v1/custom-connector-plugins: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listConnectV1CustomConnectorPlugins + summary: List of Custom Connector Plugins + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all custom connector plugins. + + If no `cloud` filter is specified, returns custom connector plugins from all clouds. + parameters: + - name: cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for cloud. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Custom Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Connector Plugin. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/connect.v1.CustomConnectorPluginList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createConnectV1CustomConnectorPlugin + summary: Create a Custom Connector Plugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a custom connector plugin. + tags: + - Custom Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/connect.v1.CustomConnectorPlugin' + - type: object + required: + - display_name + - connector_class + - connector_type + - upload_source + responses: + '201': + description: A Custom Connector Plugin was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/connect/v1/custom-connector-plugins/{id} + description: CustomConnectorPlugin resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/connect.v1.CustomConnectorPlugin' + - type: object + required: + - display_name + - connector_class + - connector_type + - upload_source + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /connect/v1/custom-connector-plugins/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getConnectV1CustomConnectorPlugin + summary: Read a Custom Connector Plugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a custom connector plugin. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connector plugin. + tags: + - Custom Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Connector Plugin. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/connect.v1.CustomConnectorPlugin' + - type: object + required: + - api_version + - kind + - id + - display_name + - connector_class + - connector_type + - upload_source + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateConnectV1CustomConnectorPlugin + summary: Update a Custom Connector Plugin + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a custom connector plugin. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connector plugin. + tags: + - Custom Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.CustomConnectorPlugin' + responses: + '200': + description: Custom Connector Plugin. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/connect.v1.CustomConnectorPlugin' + - type: object + required: + - api_version + - kind + - id + - display_name + - connector_class + - connector_type + - upload_source + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteConnectV1CustomConnectorPlugin + summary: Delete a Custom Connector Plugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a custom connector plugin. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connector plugin. + tags: + - Custom Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Custom Connector Plugin is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /connect/v1/presigned-upload-url: + x-lifecycle-stage: General Availability + x-self-access: true + post: + summary: Request a presigned upload URL for a new Custom Connector Plugin. + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Request a presigned upload URL to upload a Custom Connector Plugin archive. + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/connect.v1.PresignedUrlRequest' + - type: object + required: + - content_format + x-lifecycle-stage: General Availability + x-self-access: true + x-name: connect.v1.PresignedUrl + operationId: presigned-upload-urlConnectV1PresignedUrl + tags: + - Presigned Urls (connect/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Presigned Url. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/connect.v1.PresignedUrl' + - type: object + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /connect/v1/custom-connector-runtimes: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listConnectV1CustomConnectorRuntimes + summary: List of Custom Connector Runtimes + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all custom connector runtimes. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Custom Connector Runtimes (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Connector Runtime. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/connect.v1.CustomConnectorRuntimeList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /kafka/v3/clusters/{cluster_id}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + + get: + summary: Get Cluster + operationId: getKafkaCluster + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the Kafka cluster with the specified ``cluster_id``. + tags: + - Cluster (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetClusterResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/acls:batch: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + + post: + summary: Batch Create ACLs + operationId: batchCreateKafkaAcls + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Create ACLs. + tags: + - ACL (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/BatchCreateAclRequest' + responses: + '201': + description: Created + '400': + $ref: '#/components/responses/BadRequestErrorResponse_CreateAcls' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/acls: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + + get: + summary: List ACLs + operationId: getKafkaAcls + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + - When calling `/acls` without the `principal` parameter, service + accounts are returned in numeric ID format (e.g., `User:12345`). + - To retrieve service accounts in the `sa-xxx` format, use + `/acls?principal=UserV2:*`. + - The `principal` parameter supports both legacy `User:` format and + new `UserV2:` format for service accounts. + Return a list of ACLs that match the search criteria. + tags: + - ACL (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/AclResourceType' + - $ref: '#/components/parameters/AclResourceName' + - $ref: '#/components/parameters/AclPatternType' + - $ref: '#/components/parameters/AclPrincipal' + - $ref: '#/components/parameters/AclHost' + - $ref: '#/components/parameters/AclOperation' + - $ref: '#/components/parameters/AclPermission' + responses: + '200': + $ref: '#/components/responses/SearchAclsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + post: + summary: Create an ACL + operationId: createKafkaAcls + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Create an ACL. + tags: + - ACL (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/CreateAclRequest' + responses: + '201': + description: Created + '400': + $ref: '#/components/responses/BadRequestErrorResponse_CreateAcls' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + delete: + summary: Delete ACLs + operationId: deleteKafkaAcls + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete the ACLs that match the search criteria. + tags: + - ACL (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/AclResourceTypeRequired' + - $ref: '#/components/parameters/AclResourceName' + - $ref: '#/components/parameters/AclPatternTypeRequired' + - $ref: '#/components/parameters/AclPrincipal' + - $ref: '#/components/parameters/AclHost' + - $ref: '#/components/parameters/AclOperationRequired' + - $ref: '#/components/parameters/AclPermissionRequired' + responses: + '200': + $ref: '#/components/responses/DeleteAclsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse_DeleteAcls' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/broker-configs: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + + get: + summary: List Dynamic Broker Configs + operationId: listKafkaClusterConfigs + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return a list of dynamic cluster-wide broker configuration parameters for the specified Kafka + cluster. Returns an empty list if there are no dynamic cluster-wide broker configuration parameters. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListClusterConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/broker-configs:alter: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + + post: + summary: Batch Alter Dynamic Broker Configs + operationId: updateKafkaClusterConfigs + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Update or delete a set of dynamic cluster-wide broker configuration parameters. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterClusterConfigBatchRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/broker-configs/{name}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConfigName' + + get: + summary: Get Dynamic Broker Config + operationId: getKafkaClusterConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the dynamic cluster-wide broker configuration parameter specified by ``name``. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetClusterConfigResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + put: + summary: Update Dynamic Broker Config + operationId: updateKafkaClusterConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Update the dynamic cluster-wide broker configuration parameter specified by ``name``. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/UpdateClusterConfigRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + delete: + summary: Reset Dynamic Broker Config + operationId: deleteKafkaClusterConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Reset the configuration parameter specified by ``name`` to its + default value by deleting a dynamic cluster-wide configuration. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/consumer-groups: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + + get: + summary: List Consumer Groups + operationId: listKafkaConsumerGroups + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the list of consumer groups that belong to the specified + Kafka cluster. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListConsumerGroupsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + + get: + summary: Get Consumer Group + operationId: getKafkaConsumerGroup + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the consumer group specified by the ``consumer_group_id``. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetConsumerGroupResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + + get: + summary: List Consumers + operationId: listKafkaConsumers + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return a list of consumers that belong to the specified consumer + group. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListConsumersResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + + get: + summary: Get Consumer Group Lag Summary + operationId: getKafkaConsumerGroupLagSummary + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Available in dedicated clusters only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) + + Return the maximum and total lag of the consumers belonging to the + specified consumer group. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetConsumerGroupLagSummaryResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + + get: + summary: List Consumer Lags + operationId: listKafkaConsumerLags + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Available in dedicated clusters only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) + + Return a list of consumer lags of the consumers belonging to the + specified consumer group. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListConsumerLagsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/PartitionId' + + get: + summary: Get Consumer Lag + operationId: getKafkaConsumerLag + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Available in dedicated clusters only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) + + Return the consumer lag on a partition with the given `partition_id`. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetConsumerLagResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + - $ref: '#/components/parameters/ConsumerId' + + get: + summary: Get Consumer + operationId: getKafkaConsumer + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the consumer specified by the ``consumer_id``. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetConsumerResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/topics: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + + get: + summary: List Topics + operationId: listKafkaTopics + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the list of topics that belong to the specified Kafka cluster. + tags: + - Topic (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListTopicsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + post: + summary: Create Topic + operationId: createKafkaTopic + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Create a topic. + Also supports a dry-run mode that only validates whether the topic creation would succeed + if the ``validate_only`` request property is explicitly specified and set to true. Note that + when dry-run mode is being used the response status would be 200 OK instead of 201 Created. + tags: + - Topic (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/CreateTopicRequest' + responses: + # returned when dry-run mode is being used and a topic has not been created + '200': + $ref: '#/components/responses/CreateTopicResponse' + # returned in regular mode when a topic has been created + '201': + $ref: '#/components/responses/CreateTopicResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse_CreateTopic' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + + get: + summary: Get Topic + operationId: getKafkaTopic + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the topic with the given `topic_name`. + tags: + - Topic (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/IncludeAuthorizedOperations' + responses: + '200': + $ref: '#/components/responses/GetTopicResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + patch: + summary: Update Partition Count + operationId: updatePartitionCountKafkaTopic + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Increase the number of partitions for a topic. To update other topic + configurations, see https://docs.confluent.io/cloud/current/api.html#tag/Configs-(v3)/operation/updateKafkaTopicConfig. + tags: + - Topic (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePartitionCountRequestData' + # $ref: '#/components/requestBodies/UpdatePartitionCountRequest' + responses: + '200': + $ref: '#/components/responses/GetTopicResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse_UpdatePartitionCountTopic' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + delete: + summary: Delete Topic + operationId: deleteKafkaTopic + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete the topic with the given `topic_name`. + tags: + - Topic (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + + get: + summary: List Topic Configs + operationId: listKafkaTopicConfigs + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the list of configuration parameters that belong to the specified topic. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListTopicConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs:alter: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + + post: + summary: Batch Alter Topic Configs + operationId: updateKafkaTopicConfigBatch + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Update or delete a set of topic configuration parameters. + Also supports a dry-run mode that only validates whether the operation would succeed if the + ``validate_only`` request property is explicitly specified and set to true. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterTopicConfigBatchRequest' + responses: + # returned in both regular and dry-run modes + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/ConfigName' + + get: + summary: Get Topic Config + operationId: getKafkaTopicConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the configuration parameter with the given `name`. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetTopicConfigResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + put: + summary: Update Topic Config + operationId: updateKafkaTopicConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Update the configuration parameter with given `name`. To update the + number of partitions, see + https://docs.confluent.io/cloud/current/api.html#tag/Topic-(v3)/operation/updatePartitionCountKafkaTopic. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/UpdateTopicConfigRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + delete: + summary: Reset Topic Config + operationId: deleteKafkaTopicConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Reset the configuration parameter with given `name` to its default value. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + + get: + summary: List Partitions + operationId: listKafkaPartitions + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the list of partitions that belong to the specified topic. + tags: + - Partition (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListPartitionsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/PartitionId' + + get: + summary: Get Partition + operationId: getKafkaPartition + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the partition with the given `partition_id`. + tags: + - Partition (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetPartitionResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/topics/-/configs: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + + get: + summary: List All Topic Configs + operationId: listKafkaAllTopicConfigs + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the list of configuration parameters for all topics hosted by the specified + cluster. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListTopicConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/records: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + + post: + summary: Produce Records + operationId: produceRecord + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Produce records to the given topic, returning delivery reports for each + record produced. This API can be used in streaming mode by setting + "Transfer-Encoding: chunked" header. For as long as the connection is + kept open, the server will keep accepting records. Records are streamed + to and from the server as Concatenated JSON. For each record sent to the + server, the server will asynchronously send back a delivery report, in + the same order, each with its own error_code. An error_code of 200 + indicates success. The HTTP status code will be HTTP 200 OK as long as + the connection is successfully established. To identify records that + have encountered an error, check the error_code of each delivery report. + + Note that the cluster_id is validated only when running in Confluent Cloud. + + This API currently does not support Schema Registry integration. Sending + schemas is not supported. Only BINARY, JSON, and STRING formats are + supported. + + + tags: + - Records (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/ProduceRequest' + responses: + '200': + $ref: '#/components/responses/ProduceResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse_ProduceRecords' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '413': + $ref: '#/components/responses/RequestEntityTooLargeErrorResponse' + '415': + $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse' + '422': + $ref: '#/components/responses/UnprocessableEntity_ProduceRecord' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/links: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + + get: + summary: List all cluster links in the dest cluster + operationId: listKafkaLinks + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead. + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListLinksResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + post: + summary: Create a cluster link + operationId: createKafkaLink + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Cluster link creation requires source cluster security configurations in + the configs JSON section of the data request payload. + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/QueryParamLinkName' + - $ref: '#/components/parameters/ValidateOnly' + - $ref: '#/components/parameters/ValidateLink' + requestBody: + $ref: '#/components/requestBodies/CreateLinkRequest' + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/links/{link_name}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + + get: + summary: Describe the cluster link + operationId: getKafkaLink + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead. + tags: + - Cluster Linking (v3) + parameters: + - $ref: '#/components/parameters/IncludeTasks' + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetLinkResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + delete: + summary: Delete the cluster link + operationId: deleteKafkaLink + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/Force' + - $ref: '#/components/parameters/ValidateOnly' + responses: + '200': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/default-configs: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + + get: + summary: List New Topic Default Configs + operationId: listKafkaDefaultTopicConfigs + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + List the default configuration parameters used if the topic were to be newly created. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListTopicConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + + get: + summary: List all configs of the cluster link + operationId: listKafkaLinkConfigs + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListLinkConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/LinkConfigName' + + get: + summary: Describe the config under the cluster link + operationId: getKafkaLinkConfigs + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetLinkConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + put: + summary: Alter the config under the cluster link + operationId: updateKafkaLinkConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/UpdateLinkConfigRequest' + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + delete: + summary: Reset the given config to default value + operationId: deleteKafkaLinkConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs:alter: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + + put: + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Batch Alter Cluster Link Configs + operationId: updateKafkaLinkConfigBatch + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/ValidateOnly' + requestBody: + $ref: '#/components/requestBodies/AlterLinkConfigBatchRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + summary: Batch Alter Cluster Link Configs + + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + + post: + summary: Create a mirror topic + operationId: createKafkaMirrorTopic + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Create a topic in the destination cluster mirroring a topic in + the source cluster + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/CreateMirrorTopicRequest' + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + get: + summary: List mirror topics + operationId: listKafkaMirrorTopicsUnderLink + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + List all mirror topics under the link + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/MirrorTopicStatus' + responses: + '200': + $ref: '#/components/responses/ListMirrorTopicsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/links/-/mirrors: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + + get: + summary: List mirror topics + operationId: listKafkaMirrorTopics + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + List all mirror topics in the cluster + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/MirrorTopicStatus' + responses: + '200': + $ref: '#/components/responses/ListMirrorTopicsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors/{mirror_topic_name}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/MirrorTopicName' + + get: + summary: Describe the mirror topic + operationId: readKafkaMirrorTopic + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + parameters: + - $ref: '#/components/parameters/IncludeStateTransitionErrors' + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/DescribeMirrorTopicResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:promote: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + + post: + summary: Promote the mirror topics + operationId: updateKafkaMirrorTopicsPromote + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:failover: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + + post: + summary: Failover the mirror topics + operationId: updateKafkaMirrorTopicsFailover + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:pause: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + + post: + summary: Pause the mirror topics + operationId: updateKafkaMirrorTopicsPause + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:resume: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + + post: + summary: Resume the mirror topics + operationId: updateKafkaMirrorTopicsResume + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-start-mirror: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + + post: + summary: Reverse the local mirror topic and start the remote mirror topic + operationId: updateKafkaMirrorTopicsReverseAndStartMirror + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-pause-mirror: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + + post: + summary: Reverse the local mirror topic and Pause the remote mirror topic + operationId: updateKafkaMirrorTopicsReverseAndPauseMirror + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:truncate-and-restore: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/IncludePartitionLevelTruncationData' + - $ref: '#/components/parameters/ValidateOnly' + + post: + summary: Truncates the local topic to the remote stopped mirror log end offsets + and restores mirroring to the local topic to mirror from the remote topic + operationId: updateKafkaMirrorTopicsTruncateAndRestoreMirror + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/share-groups: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + + get: + summary: List Share Groups + operationId: listKafkaShareGroups + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the list of share groups that belong to the specified + Kafka cluster. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListShareGroupsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + + get: + summary: Get Share Group + operationId: getKafkaShareGroup + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the share group specified by the ``group_id``. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetShareGroupResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + delete: + summary: Delete Share Group + operationId: deleteKafkaShareGroup + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete the share group specified by the ``group_id``. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + + get: + summary: List Share Group Consumers + operationId: listKafkaShareGroupConsumers + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return a list of consumers that belong to the specified share + group. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListShareGroupConsumersResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConsumerId' + + get: + summary: Get Share Group Consumer + operationId: getKafkaShareGroupConsumer + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the consumer specified by the ``consumer_id``. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetShareGroupConsumerResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}/assignments: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConsumerId' + + get: + summary: List Share Group Consumer Assignments + operationId: listKafkaShareGroupConsumerAssignments + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the consumer assignments specified by the ``consumer_id``. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListShareGroupConsumerAssignmentsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + + get: + summary: List all configs of the group + operationId: listKafkaGroupConfigs + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + List all configurations for the specified group. This API supports consumer groups, share groups, and streams groups. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListGroupConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConfigName' + + get: + summary: Get group config + operationId: getKafkaGroupConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetGroupConfigResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + put: + summary: Update group config + operationId: updateKafkaGroupConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Update the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/UpdateGroupConfigRequest' + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + delete: + summary: Delete group config + operationId: deleteKafkaGroupConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete the dynamic configuration override with the specified name for the specified group. After deletion, the default group configuration will be applied. This API supports consumer groups, share groups, and streams groups. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs:alter: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + + post: + summary: Batch Alter Group Configs + operationId: updateKafkaGroupConfigBatch + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Batch alter configurations for the specified group. This API supports consumer groups, share groups, and streams groups. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/ValidateOnly' + requestBody: + $ref: '#/components/requestBodies/AlterGroupConfigBatchRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/streams-groups: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + get: + summary: List Streams Groups + operationId: listKafkaStreamsGroups + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the list of streams groups that belong to the specified Kafka cluster + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListStreamsGroupsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + + get: + summary: Get Streams Group + operationId: getKafkaStreamsGroup + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the streams group specified by the ``group_id``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsGroupResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/subtopologies: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + + get: + summary: List Streams Group Subtopologies + operationId: listKafkaStreamsGroupSubtopologies + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return a list of subtopologies that belong to the specified streams group. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListStreamsGroupSubtopologiesResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/subtopologies/{subtopology_id}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/SubtopologyId' + get: + summary: Get Streams Group Subtopology + operationId: getKafkaStreamsGroupSubtopology + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the subtopology specified by the ``subtopology_id``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsGroupSubtopologyResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + + get: + summary: List Streams Group Members + operationId: listKafkaStreamsGroupMembers + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return a list of members that belong to the specified streams group. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListStreamsGroupMembersResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + get: + summary: Get Streams Group Member + operationId: getKafkaStreamsGroupMember + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the members specified by the ``member_id``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsGroupMemberResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + + get: + summary: Get Streams Group Member Assignments + operationId: getKafkaStreamsGroupMemberAssignments + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the assignments of the member specified by the ``member_id``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsGroupMemberAssignmentsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + + get: + summary: Get Streams Group Member Target Assignments + operationId: getKafkaStreamsGroupMemberTargetAssignments + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the target assignments of the member specified by the ``member_id``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsGroupMemberAssignmentsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + + get: + summary: List Streams Group Assignments of a Specific Type + operationId: listKafkaStreamsGroupMemberAssignmentTasks + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the tasks of the member specified by the ``member_id``, and the type ``assignments_type``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListStreamsTasksResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + + get: + summary: List Streams Group Target Assignments of a Specific Type + operationId: listKafkaStreamsGroupMemberTargetAssignmentTasks + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the target tasks of the member specified by the ``member_id``, and the type ``assignments_type``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListStreamsTasksResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}/subtopologies/{subtopology_id}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + - $ref: '#/components/parameters/SubtopologyId' + + get: + summary: List Streams Group Assignments Task Partitions of a Specific Type and + Subtopology + operationId: getKafkaStreamsGroupMemberAssignmentTaskPartitions + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the tasks of the member specified by the ``member_id``, and the type ``assignments_type``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsTaskResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}/subtopologies/{subtopology_id}: + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + - $ref: '#/components/parameters/SubtopologyId' + + get: + summary: List Streams Group Target Assignments Task Partitions of a Specific + Type and Subtopology + operationId: getKafkaStreamsGroupMemberTargetAssignmentTaskPartitions + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the tasks of the member specified by the ``member_id``, and the type ``assignments_type``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsTaskResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + + /service-quota/v1/applied-quotas: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listServiceQuotaV1AppliedQuotas + summary: List of Applied Quotas + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all applied quotas. + + Shows all quotas for a given scope. + parameters: + - name: scope + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: ORGANIZATION + description: | + The applied scope the quota belongs to. + - name: environment + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: | + The environment ID the quota is associated with. + - name: network + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: n-12034 + description: | + The network ID the quota is associated with. + - name: kafka_cluster + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: | + The kafka cluster ID the quota is associated with. + - name: id + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: iam.max_environments.per_org + description: | + The id (quota code) that this quota belongs to. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 200 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Applied Quotas (service-quota/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Applied Quota. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/service-quota.v1.AppliedQuotaList' + - type: object + properties: + data: + type: array + items: + properties: + user: + example: + id: u-4voj5e + related: https://api.confluent.cloud/v2/users/u-4voj5e + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/user=u-4voj5e + organization: + nullable: true + example: + id: b3a17773-05cc-4431-9560-433fb4613da8 + related: https://api.confluent.cloud/partner/v2/organizations/b3a17773-05cc-4431-9560-433fb4613da8 + resource_name: https://api.confluent.cloud/organization=b3a17773-05cc-4431-9560-433fb4613da8 + environment: + nullable: true + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + nullable: true + example: + id: n-12034 + related: https://api.confluent.cloud/networking/v1/networks/n-12034 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-12034 + kafka_cluster: + nullable: true + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /service-quota/v1/applied-quotas/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getServiceQuotaV1AppliedQuota + summary: Read an Applied Quota + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an applied quota. + parameters: + - name: environment + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: | + The environment ID the quota is associated with. + This field is only required when retrieving a single quota and + the scope of quota is "ENVIRONMENT" or "NETWORK" or "KAFKA_CLUSTER". + - name: network + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: n-12034 + description: | + The network ID the quota is associated with. + This field is only required when retrieving a single quota and + the scope of quota is "NETWORK". + - name: kafka_cluster + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: | + The kafka cluster ID the quota is associated with. + This field is required only when the scope of quota is "KAFKA_CLUSTER". + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the applied quota. + tags: + - Applied Quotas (service-quota/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Applied Quota. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/service-quota.v1.AppliedQuota' + - type: object + required: + - api_version + - kind + - id + - scope + - display_name + - default_limit + - applied_limit + - type: object + properties: + user: + example: + id: u-4voj5e + related: https://api.confluent.cloud/v2/users/u-4voj5e + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/user=u-4voj5e + organization: + nullable: true + example: + id: b3a17773-05cc-4431-9560-433fb4613da8 + related: https://api.confluent.cloud/partner/v2/organizations/b3a17773-05cc-4431-9560-433fb4613da8 + resource_name: https://api.confluent.cloud/organization=b3a17773-05cc-4431-9560-433fb4613da8 + environment: + nullable: true + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + nullable: true + example: + id: n-12034 + related: https://api.confluent.cloud/networking/v1/networks/n-12034 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-12034 + kafka_cluster: + nullable: true + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /service-quota/v1/scopes: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listServiceQuotaV1Scopes + summary: List of Scopes + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all scopes. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 200 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Scopes (service-quota/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Scope. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/service-quota.v1.ScopeList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /service-quota/v1/scopes/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getServiceQuotaV1Scope + summary: Read a Scope + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a scope. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the scope. + tags: + - Scopes (service-quota/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Scope. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/service-quota.v1.Scope' + - type: object + required: + - api_version + - kind + - id + - description + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /partner/v2/entitlements: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + get: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + operationId: listPartnerV2Entitlements + summary: List of Entitlements + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Retrieve a sorted, filtered, paginated list of all entitlements. + parameters: + - name: organization.id + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: Filter the results by exact match for organization.id. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + description: An opaque pagination token for collection requests. + tags: + - Entitlements (partner/v2) + security: + - oauth: + - partner:describe + responses: + '200': + description: Entitlement. + content: + application/json: + schema: + $ref: '#/components/schemas/partner.v2.EntitlementList' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-codeSamples: + - lang: Shell + source: |- + curl --request GET \ + --url 'https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE' \ + --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' + - lang: Java + source: |- + OkHttpClient client = new OkHttpClient(); + + Request request = new Request.Builder() + .url("https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE") + .get() + .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN") + .build(); + + Response response = client.newCall(request).execute(); + - lang: Go + source: |- + package main + + import ( + "fmt" + "net/http" + "io/ioutil" + ) + + func main() { + + url := "https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE" + + req, _ := http.NewRequest("GET", url, nil) + + req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN") + + res, _ := http.DefaultClient.Do(req) + + defer res.Body.Close() + body, _ := ioutil.ReadAll(res.Body) + + fmt.Println(res) + fmt.Println(string(body)) + + } + - lang: Python + source: |- + import http.client + + conn = http.client.HTTPSConnection("api.confluent.cloud") + + headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" } + + conn.request("GET", "/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE", headers=headers) + + res = conn.getresponse() + data = res.read() + + print(data.decode("utf-8")) + - lang: Node + source: |- + const http = require("https"); + + const options = { + "method": "GET", + "hostname": "api.confluent.cloud", + "port": null, + "path": "/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE", + "headers": { + "Authorization": "Bearer REPLACE_BEARER_TOKEN" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.end(); + - lang: C + source: |- + CURL *hnd = curl_easy_init(); + + curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); + curl_easy_setopt(hnd, CURLOPT_URL, "https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE"); + + struct curl_slist *headers = NULL; + headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); + curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); + + CURLcode ret = curl_easy_perform(hnd); + - lang: C# + source: |- + var client = new RestClient("https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE"); + var request = new RestRequest(Method.GET); + request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); + IRestResponse response = client.Execute(request); + post: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + operationId: createPartnerV2Entitlement + summary: Create an Entitlement + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to create an entitlement. + tags: + - Entitlements (partner/v2) + security: + - oauth: + - partner:create + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/partner.v2.Entitlement' + - type: object + required: + - external_id + - name + - plan_id + - product_id + responses: + '201': + description: An Entitlement is being created. + headers: + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/partner/v2/entitlements/{id} + description: Entitlement resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/partner.v2.Entitlement' + - type: object + required: + - external_id + - name + - plan_id + - product_id + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-codeSamples: + - lang: Shell + source: |- + curl --request POST \ + --url https://api.confluent.cloud/partner/v2/entitlements \ + --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \ + --header 'content-type: application/json' \ + --data '{"external_id":"1111-2222-3333-4444","name":"Acme Prod Entitlement","plan_id":"confluent-cloud-payg-prod","product_id":"confluent-cloud-kafka-service-azure","usage_reporting_id":"1111-2222-3333-4444","resource_id":"1111-2222-3333-4444","organization":{"related":"string"}}' + - lang: Java + source: |- + OkHttpClient client = new OkHttpClient(); + + MediaType mediaType = MediaType.parse("application/json"); + RequestBody body = RequestBody.create(mediaType, "{\"external_id\":\"1111-2222-3333-4444\",\"name\":\"Acme Prod Entitlement\",\"plan_id\":\"confluent-cloud-payg-prod\",\"product_id\":\"confluent-cloud-kafka-service-azure\",\"usage_reporting_id\":\"1111-2222-3333-4444\",\"resource_id\":\"1111-2222-3333-4444\",\"organization\":{\"related\":\"string\"}}"); + Request request = new Request.Builder() + .url("https://api.confluent.cloud/partner/v2/entitlements") + .post(body) + .addHeader("content-type", "application/json") + .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN") + .build(); + + Response response = client.newCall(request).execute(); + - lang: Go + source: |- + package main + + import ( + "fmt" + "strings" + "net/http" + "io/ioutil" + ) + + func main() { + + url := "https://api.confluent.cloud/partner/v2/entitlements" + + payload := strings.NewReader("{\"external_id\":\"1111-2222-3333-4444\",\"name\":\"Acme Prod Entitlement\",\"plan_id\":\"confluent-cloud-payg-prod\",\"product_id\":\"confluent-cloud-kafka-service-azure\",\"usage_reporting_id\":\"1111-2222-3333-4444\",\"resource_id\":\"1111-2222-3333-4444\",\"organization\":{\"related\":\"string\"}}") + + req, _ := http.NewRequest("POST", url, payload) + + req.Header.Add("content-type", "application/json") + req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN") + + res, _ := http.DefaultClient.Do(req) + + defer res.Body.Close() + body, _ := ioutil.ReadAll(res.Body) + + fmt.Println(res) + fmt.Println(string(body)) + + } + - lang: Python + source: |- + import http.client + + conn = http.client.HTTPSConnection("api.confluent.cloud") + + payload = "{\"external_id\":\"1111-2222-3333-4444\",\"name\":\"Acme Prod Entitlement\",\"plan_id\":\"confluent-cloud-payg-prod\",\"product_id\":\"confluent-cloud-kafka-service-azure\",\"usage_reporting_id\":\"1111-2222-3333-4444\",\"resource_id\":\"1111-2222-3333-4444\",\"organization\":{\"related\":\"string\"}}" + + headers = { + 'content-type': "application/json", + 'Authorization': "Bearer REPLACE_BEARER_TOKEN" + } + + conn.request("POST", "/partner/v2/entitlements", payload, headers) + + res = conn.getresponse() + data = res.read() + + print(data.decode("utf-8")) + - lang: Node + source: |- + const http = require("https"); + + const options = { + "method": "POST", + "hostname": "api.confluent.cloud", + "port": null, + "path": "/partner/v2/entitlements", + "headers": { + "content-type": "application/json", + "Authorization": "Bearer REPLACE_BEARER_TOKEN" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.write(JSON.stringify({ + external_id: '1111-2222-3333-4444', + name: 'Acme Prod Entitlement', + plan_id: 'confluent-cloud-payg-prod', + product_id: 'confluent-cloud-kafka-service-azure', + usage_reporting_id: '1111-2222-3333-4444', + resource_id: '1111-2222-3333-4444', + organization: {related: 'string'} + })); + req.end(); + - lang: C + source: |- + CURL *hnd = curl_easy_init(); + + curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST"); + curl_easy_setopt(hnd, CURLOPT_URL, "https://api.confluent.cloud/partner/v2/entitlements"); + + struct curl_slist *headers = NULL; + headers = curl_slist_append(headers, "content-type: application/json"); + headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); + curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); + + curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"external_id\":\"1111-2222-3333-4444\",\"name\":\"Acme Prod Entitlement\",\"plan_id\":\"confluent-cloud-payg-prod\",\"product_id\":\"confluent-cloud-kafka-service-azure\",\"usage_reporting_id\":\"1111-2222-3333-4444\",\"resource_id\":\"1111-2222-3333-4444\",\"organization\":{\"related\":\"string\"}}"); + + CURLcode ret = curl_easy_perform(hnd); + - lang: C# + source: |- + var client = new RestClient("https://api.confluent.cloud/partner/v2/entitlements"); + var request = new RestRequest(Method.POST); + request.AddHeader("content-type", "application/json"); + request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); + request.AddParameter("application/json", "{\"external_id\":\"1111-2222-3333-4444\",\"name\":\"Acme Prod Entitlement\",\"plan_id\":\"confluent-cloud-payg-prod\",\"product_id\":\"confluent-cloud-kafka-service-azure\",\"usage_reporting_id\":\"1111-2222-3333-4444\",\"resource_id\":\"1111-2222-3333-4444\",\"organization\":{\"related\":\"string\"}}", ParameterType.RequestBody); + IRestResponse response = client.Execute(request); + /partner/v2/entitlements/{id}: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + get: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + operationId: getPartnerV2Entitlement + summary: Read an Entitlement + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to read an entitlement. + parameters: + - name: organization.id + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: Scope the operation to the given organization.id. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the entitlement. + tags: + - Entitlements (partner/v2) + security: + - oauth: + - partner:describe + responses: + '200': + description: Entitlement. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/partner.v2.Entitlement' + - type: object + required: + - external_id + - name + - plan_id + - product_id + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-codeSamples: + - lang: Shell + source: |- + curl --request GET \ + --url 'https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE' \ + --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' + - lang: Java + source: |- + OkHttpClient client = new OkHttpClient(); + + Request request = new Request.Builder() + .url("https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE") + .get() + .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN") + .build(); + + Response response = client.newCall(request).execute(); + - lang: Go + source: |- + package main + + import ( + "fmt" + "net/http" + "io/ioutil" + ) + + func main() { + + url := "https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE" + + req, _ := http.NewRequest("GET", url, nil) + + req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN") + + res, _ := http.DefaultClient.Do(req) + + defer res.Body.Close() + body, _ := ioutil.ReadAll(res.Body) + + fmt.Println(res) + fmt.Println(string(body)) + + } + - lang: Python + source: |- + import http.client + + conn = http.client.HTTPSConnection("api.confluent.cloud") + + headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" } + + conn.request("GET", "/partner/v2/entitlements/%7Bid%7D?organization.id=SOME_STRING_VALUE", headers=headers) + + res = conn.getresponse() + data = res.read() + + print(data.decode("utf-8")) + - lang: Node + source: |- + const http = require("https"); + + const options = { + "method": "GET", + "hostname": "api.confluent.cloud", + "port": null, + "path": "/partner/v2/entitlements/%7Bid%7D?organization.id=SOME_STRING_VALUE", + "headers": { + "Authorization": "Bearer REPLACE_BEARER_TOKEN" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.end(); + - lang: C + source: |- + CURL *hnd = curl_easy_init(); + + curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); + curl_easy_setopt(hnd, CURLOPT_URL, "https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE"); + + struct curl_slist *headers = NULL; + headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); + curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); + + CURLcode ret = curl_easy_perform(hnd); + - lang: C# + source: |- + var client = new RestClient("https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE"); + var request = new RestRequest(Method.GET); + request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); + IRestResponse response = client.Execute(request); + /srcm/v2/regions: + x-lifecycle-stage: Deprecated + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + get: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: listSrcmV2Regions + summary: List of Regions + description: |- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all regions. + parameters: + - name: spec.cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for spec.cloud. + - name: spec.region_name + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-2 + description: Filter the results by exact match for spec.region_name. + - name: spec.packages + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [ESSENTIALS, ADVANCED] + description: Filter the results by exact match for spec.packages. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Regions (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Region. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/srcm.v2.RegionList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /srcm/v2/regions/{id}: + x-lifecycle-stage: Deprecated + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + get: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: getSrcmV2Region + summary: Read a Region + description: |- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a region. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the region. + tags: + - Regions (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Region. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/srcm.v2.Region' + - type: object + required: + - api_version + - kind + - id + - spec + properties: + spec: + type: object + required: + - display_name + - cloud + - region_name + - packages + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /srcm/v2/clusters: + x-lifecycle-stage: Deprecated + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + get: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: listSrcmV2Clusters + summary: List of Clusters + description: |- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Clusters (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/srcm.v2.ClusterList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + region: + example: + id: sgreg-00000 + related: https://api.confluent.cloud/srcm/v2/regions/sgreg-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/region=sgreg-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: createSrcmV2Cluster + summary: Create a Cluster + description: |- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a cluster. + tags: + - Clusters (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/srcm.v2.Cluster' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - package + - environment + - region + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + region: + example: + id: sgreg-00000 + responses: + '202': + description: A Cluster is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/srcm/v2/clusters/{id} + description: Cluster resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/srcm.v2.Cluster' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - package + - environment + - region + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + region: + example: + id: sgreg-00000 + related: https://api.confluent.cloud/srcm/v2/regions/sgreg-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/region=sgreg-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /srcm/v2/clusters/{id}: + x-lifecycle-stage: Deprecated + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + get: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: getSrcmV2Cluster + summary: Read a Cluster + description: |- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/srcm.v2.Cluster' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - package + - environment + - region + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + region: + example: + id: sgreg-00000 + related: https://api.confluent.cloud/srcm/v2/regions/sgreg-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/region=sgreg-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: updateSrcmV2Cluster + summary: Update a Cluster + description: |+ + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a cluster. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/srcm.v2.Cluster' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Cluster. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/srcm.v2.Cluster' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - package + - environment + - region + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + region: + example: + id: sgreg-00000 + related: https://api.confluent.cloud/srcm/v2/regions/sgreg-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/region=sgreg-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: deleteSrcmV2Cluster + summary: Delete a Cluster + description: |- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Cluster is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /srcm/v3/clusters: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listSrcmV3Clusters + summary: List of Clusters + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Clusters (srcm/v3) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/srcm.v3.ClusterList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /srcm/v3/clusters/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getSrcmV3Cluster + summary: Read a Cluster + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (srcm/v3) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/srcm.v3.Cluster' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - package + - cloud + - region + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /clusterconfig: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Config (v1) + summary: Get cluster config + description: Retrieves cluster config information. + operationId: getClusterConfig + responses: + '200': + description: The cluster config + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ClusterConfig' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ClusterConfig' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ClusterConfig' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + /compatibility/subjects/{subject}/versions/{version}: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + post: + tags: + - Compatibility (v1) + summary: Test schema compatibility against a particular schema subject-version + description: "Test input schema against a particular version of a subject's\ + \ schema for compatibility. The compatibility level applied for the check\ + \ is the configured compatibility level for the subject (http:get:: /config/(string:\ + \ subject)). If this subject's compatibility level was never changed, then\ + \ the global compatibility level applies (http:get:: /config)." + operationId: testCompatibilityBySubjectName + parameters: + - name: subject + in: path + description: Subject of the schema version against which compatibility is + to be tested + required: true + schema: + type: string + - name: version + in: path + description: Version of the subject's schema against which compatibility + is to be tested. Valid values for versionId are between [1,2^31-1] or + the string "latest"."latest" checks compatibility of the input schema + with the last registered schema under the specified subject + required: true + schema: + type: string + - name: normalize + in: query + description: Whether to normalize the given schema + schema: + type: boolean + - name: verbose + in: query + description: Whether to return detailed error messages + schema: + type: boolean + requestBody: + description: Schema + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + required: true + responses: + '200': + description: Compatibility check result. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + '404': + description: Not Found. Error code 40401 indicates subject not found. Error + code 40402 indicates version not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: Unprocessable entity. Error code 42201 indicates an invalid + schema or schema type. Error code 42202 indicates an invalid version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /compatibility/subjects/{subject}/versions: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + post: + tags: + - Compatibility (v1) + summary: Test schema compatibility against all schemas under a subject + description: "Test input schema against a subject's schemas for compatibility,\ + \ based on the configured compatibility level of the subject. In other words,\ + \ it will perform the same compatibility check as register for that subject.\ + \ The compatibility level applied for the check is the configured compatibility\ + \ level for the subject (http:get:: /config/(string: subject)). If this subject's\ + \ compatibility level was never changed, then the global compatibility level\ + \ applies (http:get:: /config)." + operationId: testCompatibilityForSubject + parameters: + - name: subject + in: path + description: Subject of the schema version against which compatibility is + to be tested + required: true + schema: + type: string + - name: verbose + in: query + description: Whether to return detailed error messages + schema: + type: boolean + requestBody: + description: Schema + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + required: true + responses: + '200': + description: Compatibility check result. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + '422': + description: Unprocessable Entity. Error code 42201 indicates an invalid + schema or schema type. Error code 42202 indicates an invalid version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /config/{subject}: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Config (v1) + summary: Get subject compatibility level + description: |- + Retrieves compatibility level, compatibility group, normalization, + default metadata, and rule set for a subject. + operationId: getSubjectLevelConfig + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: defaultToGlobal + in: query + description: Whether to return the global compatibility level if subject + compatibility level not found + schema: + type: boolean + responses: + '200': + description: The subject compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Config' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Config' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Config' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Config (v1) + summary: Update subject compatibility level + description: |- + Update compatibility level, compatibility group, normalization, + default metadata, and rule set for the specified subject. On success, + echoes the original request back to the client. + operationId: updateSubjectLevelConfig + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + requestBody: + description: Config Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + '422': + description: Unprocessable Entity. Error code 42203 indicates invalid compatibility + level. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. Error code 50003 indicates a failure forwarding + the request to the primary. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Config (v1) + summary: Delete subject compatibility level + description: Deletes the specified subject-level compatibility level config + and reverts to the global default. + operationId: deleteSubjectConfig + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + responses: + '200': + description: Operation succeeded. Returns old compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + application/json; qs=0.5: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /config: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Config (v1) + summary: Get global compatibility level + description: |- + Retrieves the global compatibility level, compatibility group, + normalization, default metadata, and rule set. + operationId: getTopLevelConfig + responses: + '200': + description: The global compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Config' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Config' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Config' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Config (v1) + summary: Update global compatibility level + description: |- + Updates the global compatibility level, compatibility group, + schema normalization, default metadata, and rule set. On success, echoes the + original request back to the client. + operationId: updateTopLevelConfig + requestBody: + description: Config Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + '422': + description: Unprocessable Entity. Error code 42203 indicates invalid compatibility + level. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. Error code 50003 indicates a failure forwarding + the request to the primary. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Config (v1) + summary: Delete global compatibility level + description: Deletes the global compatibility level config and reverts to the + default. + operationId: deleteTopLevelConfig + responses: + '200': + description: Operation succeeded. Returns old global compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + application/json; qs=0.5: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /exporters: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Exporters (v1) + summary: Gets all schema exporters + description: Retrieves a list of schema exporters that have been created. + operationId: listExporters + responses: + '200': + description: Name of the exporter + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: string + example: '["exporter1", "exporter2"]' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + post: + tags: + - Exporters (v1) + summary: Creates a new schema exporter + description: Creates a new schema exporter. All attributes in request body are + optional except config. + operationId: registerExporter + requestBody: + description: Schema + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterReference' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ExporterReference' + application/json: + schema: + $ref: '#/components/schemas/ExporterReference' + required: true + responses: + '200': + description: Schema successfully registered. + content: + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ExporterResponse' + '409': + description: Conflict. Error code 40950 – Missing or invalid exporter name + \ Error code 40951 – Missing or invalid exporter config \ Error code 40952 + – Invalid exporter subjects \ Error code 40960 – Exporter already exists + \ Error code 40964 – Too many exporters + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + /exporters/{name}: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Exporters (v1) + summary: Gets schema exporter by name + description: Retrieves the information of the schema exporter. + operationId: getExporterInfoByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterReference' + '404': + description: Not Found. Error code 40450 – Exporter not found + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Exporters (v1) + summary: Update schema exporter by name + description: Updates the information or configurations of the schema exporter. + All attributes in request body are optional. + operationId: updateExporterInfo + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + requestBody: + description: Exporter Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterUpdateRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ExporterUpdateRequest' + application/json: + schema: + $ref: '#/components/schemas/ExporterUpdateRequest' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterResponse' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '409': + description: Invalid. Error code 40952 – Invalid exporter subjects. Error + code 40963 – Exporter not paused. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Exporters (v1) + summary: Delete schema exporter by name + description: Deletes the schema exporter. + operationId: deleteExporter + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '204': + description: No content. + '404': + $ref: '#/components/responses/schemaregistry.v1.AccountNotFoundError' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + /exporters/{name}/status: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Exporters (v1) + summary: Gets schema exporter status by name + description: Retrieves the status of the schema exporter. + operationId: getExporterStatusByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterStatusResponse' + + '404': + description: Not Found. Error code 40450 – Exporter not found + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + /exporters/{name}/config: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Exporters (v1) + summary: Gets schema exporter config by name + description: Retrieves the config of the schema exporter. + operationId: getExporterConfigByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterConfigResponse' + '404': + description: Not Found. Error code 40450 – Exporter not found + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Exporters (v1) + summary: Update schema exporter config by name + description: Updates the configuration of the schema exporter. + operationId: updateExporterConfigByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + requestBody: + description: Exporter Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterConfigResponse' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ExporterConfigResponse' + application/json: + schema: + $ref: '#/components/schemas/ExporterConfigResponse' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterResponse' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '409': + description: Invalid. Error code 40952 – Invalid exporter subjects. Error + code 40963 – Exporter not paused. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + /exporters/{name}/pause: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + put: + tags: + - Exporters (v1) + summary: Pause schema exporter by name + description: Pauses the state of the schema exporter. + operationId: pauseExporterByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterResponse' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '409': + description: Invalid. Error code 40952 – Invalid exporter subjects. Error + code 40963 – Exporter not paused. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + /exporters/{name}/reset: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + put: + tags: + - Exporters (v1) + summary: Reset schema exporter by name + description: Reset the state of the schema exporter. + operationId: resetExporterByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterResponse' + '404': + description: Not Found. Error code 40450 – Exporter not found + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '409': + description: Invalid. Error code 40963 – Exporter not paused. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + /exporters/{name}/resume: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + put: + tags: + - Exporters (v1) + summary: Resume schema exporter by name + description: Resume running of the schema exporter. + operationId: resumeExporterByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterResponse' + '404': + description: Not Found. Error code 40450 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '409': + description: Invalid. Error code 40961 – Exporter already running. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + /contexts: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Contexts (v1) + summary: List contexts + description: Retrieves a list of contexts. + operationId: listContexts + parameters: + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: The contexts. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: string + example: . + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: string + example: . + application/json; qs=0.5: + schema: + type: array + items: + type: string + example: . + '500': + description: 'Internal Server Error. Error code 50001 indicates a failure + in the backend data store. ' + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /mode/{subject}: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Modes (v1) + summary: Get subject mode + description: Retrieves the subject mode. + operationId: getMode + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: defaultToGlobal + in: query + description: Whether to return the global mode if subject mode not found + schema: + type: boolean + responses: + '200': + description: The subject mode. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Mode' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Mode' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Mode' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Modes (v1) + summary: Update subject mode + description: Update mode for the specified subject. On success, echoes the original + request back to the client. + operationId: updateMode + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: force + in: query + description: Whether to force update if setting mode to IMPORT and schemas + currently exist + schema: + type: boolean + requestBody: + description: Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + '422': + description: Unprocessable Entity. Error code 42204 indicates an invalid + mode. Error code 42205 indicates operation not permitted. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. Error code 50003 indicates a failure forwarding + the request to the primary. Error code 50004 indicates unknown leader. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Modes (v1) + summary: Delete subject mode + description: Deletes the specified subject-level mode and reverts to the global + default. + operationId: deleteSubjectMode + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + responses: + '200': + description: Operation succeeded. Returns old mode. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Mode' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Mode' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Mode' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /mode: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Modes (v1) + summary: Get global mode + description: Retrieves global mode. + operationId: getTopLevelMode + responses: + '200': + description: The global mode + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Mode' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Mode' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Mode' + '500': + description: Error code 50001 -- Error in the backend data store + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Modes (v1) + summary: Update global mode + description: Update global mode. On success, echoes the original request back + to the client. + operationId: updateTopLevelMode + parameters: + - name: force + in: query + description: Whether to force update if setting mode to IMPORT and schemas + currently exist + schema: + type: boolean + requestBody: + description: Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + '422': + description: Unprocessable Entity. Error code 42204 indicates an invalid + mode. Error code 42205 indicates operation not permitted. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. Error code 50003 indicates a failure forwarding + the request to the primary. Error code 50004 indicates unknown leader. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /schemas/ids/{id}: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Schemas (v1) + summary: Get schema string by ID + description: Retrieves the schema string identified by the input ID. + operationId: getSchema + parameters: + - name: id + in: path + description: Globally unique identifier of the schema + required: true + schema: + type: integer + format: int32 + - name: subject + in: query + description: Name of the subject + schema: + type: string + - name: format + in: query + description: 'Desired output format, dependent on schema type. For AVRO + schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, + valid values are: " " (default), "ignore_extensions", or "serialized" + (The parameter does not apply to JSON schemas.)' + schema: + type: string + default: '' + responses: + '200': + description: The schema string. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/SchemaString' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/SchemaString' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/SchemaString' + '404': + description: Not Found. Error code 40403 indicates schema not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /schemas/ids/{id}/schema: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Schemas (v1) + summary: Get schema by ID + description: Retrieves the schema identified by the input ID. + operationId: getSchemaOnly + parameters: + - name: id + in: path + description: Globally unique identifier of the schema + required: true + schema: + type: integer + format: int32 + - name: subject + in: query + description: Name of the subject + schema: + type: string + - name: format + in: query + description: 'Desired output format, dependent on schema type. For AVRO + schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, + valid values are: " " (default), "ignore_extensions", or "serialized" + (The parameter does not apply to JSON schemas.)' + schema: + type: string + default: '' + responses: + '200': + description: Raw schema string. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + application/json; qs=0.5: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + '404': + description: Not Found. Error code 40403 indicates schema not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /schemas/types: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Schemas (v1) + summary: List supported schema types + description: Retrieve the schema types supported by this registry. + operationId: getSchemaTypes + responses: + '200': + description: List of supported schema types. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: string + example: AVRO + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: string + example: AVRO + application/json; qs=0.5: + schema: + type: array + items: + type: string + example: AVRO + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /schemas: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Schemas (v1) + summary: List schemas + description: Get the schemas matching the specified parameters. + operationId: getSchemas + parameters: + - name: subjectPrefix + in: query + description: Filters results by the respective subject prefix + schema: + type: string + default: '' + - name: aliases + in: query + description: Whether to include aliases in the search + schema: + type: boolean + default: false + - name: deleted + in: query + description: Whether to return soft deleted schemas + schema: + type: boolean + default: false + - name: latestOnly + in: query + description: Whether to return latest schema versions only for each matching + subject + schema: + type: boolean + default: false + - name: ruleType + in: query + description: Filters results by the given rule type + schema: + type: string + default: '' + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of schemas matching the specified parameters. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + $ref: '#/components/schemas/Schema' + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + $ref: '#/components/schemas/Schema' + application/json; qs=0.5: + schema: + type: array + items: + $ref: '#/components/schemas/Schema' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /schemas/ids/{id}/subjects: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Schemas (v1) + summary: List subjects associated to schema ID + description: Retrieves all the subjects associated with a particular schema + ID. + operationId: getSubjects + parameters: + - name: id + in: path + description: Globally unique identifier of the schema + required: true + schema: + type: integer + format: int32 + - name: subject + in: query + description: Filters results by the respective subject + schema: + type: string + - name: format + in: query + description: 'Desired output format, dependent on schema type. For AVRO + schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, + valid values are: " " (default), "ignore_extensions", or "serialized" + (The parameter does not apply to JSON schemas.)' + schema: + type: string + default: '' + - name: deleted + in: query + description: Whether to include subjects where the schema was deleted + schema: + type: boolean + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of subjects matching the specified parameters. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: string + example: User + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: string + example: User + application/json; qs=0.5: + schema: + type: array + items: + type: string + example: User + '404': + description: Not Found. Error code 40403 indicates schema not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /schemas/ids/{id}/versions: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Schemas (v1) + summary: List subject-versions associated to schema ID + description: Get all the subject-version pairs associated with the input ID. + operationId: getVersions + parameters: + - name: id + in: path + description: Globally unique identifier of the schema + required: true + schema: + type: integer + format: int32 + - name: subject + in: query + description: Filters results by the respective subject + schema: + type: string + - name: deleted + in: query + description: Whether to include subject versions where the schema was deleted + schema: + type: boolean + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of subject versions matching the specified parameters. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + $ref: '#/components/schemas/SubjectVersion' + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + $ref: '#/components/schemas/SubjectVersion' + application/json; qs=0.5: + schema: + type: array + items: + $ref: '#/components/schemas/SubjectVersion' + '404': + description: Not Found. Error code 40403 indicates schema not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /subjects/{subject}/versions/{version}: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Subjects (v1) + summary: Get schema by version + description: Retrieves a specific version of the schema registered under this + subject. + operationId: getSchemaByVersion + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: version + in: path + description: Version of the schema to be returned. Valid values for versionId + are between [1,2^31-1] or the string "latest". "latest" returns the last + registered schema under the specified subject. Note that there may be + a new latest schema that gets registered right after this request is served. + required: true + schema: + type: string + - name: format + in: query + description: 'Desired output format, dependent on schema type. For AVRO + schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, + valid values are: " " (default), "ignore_extensions", or "serialized" + (The parameter does not apply to JSON schemas.)' + schema: + type: string + default: '' + - name: deleted + in: query + description: Whether to include deleted schema + schema: + type: boolean + responses: + '200': + description: The schema. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Schema' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Schema' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Schema' + '404': + description: Not Found. Error code 40401 indicates subject not found. Error + code 40402 indicates version not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: Unprocessable Entity. Error code 42202 indicates an invalid + version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Subjects (v1) + summary: Delete schema version + description: Deletes a specific version of the schema registered under this + subject. This only deletes the version and the schema ID remains intact making + it still possible to decode data using the schema ID. This API is recommended + to be used only in development environments or under extreme circumstances + where-in, its required to delete a previously registered schema for compatibility + purposes or re-register previously registered schema. + operationId: deleteSchemaVersion + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: version + in: path + description: Version of the schema to be returned. Valid values for versionId + are between [1,2^31-1] or the string "latest". "latest" returns the last + registered schema under the specified subject. Note that there may be + a new latest schema that gets registered right after this request is served. + required: true + schema: + type: string + - name: permanent + in: query + description: Whether to perform a permanent delete + schema: + type: boolean + responses: + '200': + description: Operation succeeded. Returns the schema version. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: integer + format: int32 + example: 1 + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: integer + format: int32 + example: 1 + application/json; qs=0.5: + schema: + type: integer + format: int32 + example: 1 + '404': + description: Not Found. Error code 40401 indicates subject not found. Error + code 40402 indicates version not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: Unprocessable Entity. Error code 42202 indicates an invalid + version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /subjects/{subject}/versions/{version}/referencedby: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Subjects (v1) + summary: List schemas referencing a schema + description: Retrieves the IDs of schemas that reference the specified schema. + operationId: getReferencedBy + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: version + in: path + description: Version of the schema to be returned. Valid values for versionId + are between [1,2^31-1] or the string "latest". "latest" returns the last + registered schema under the specified subject. Note that there may be + a new latest schema that gets registered right after this request is served. + required: true + schema: + type: string + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of IDs for schemas that reference the specified schema. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: integer + format: int32 + example: 100001 + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: integer + format: int32 + example: 100001 + application/json; qs=0.5: + schema: + type: array + items: + type: integer + format: int32 + example: 100001 + '404': + description: Not Found. Error code 40401 indicates subject not found. Error + code 40402 indicates version not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: Unprocessable Entity. Error code 42202 indicates an invalid + version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /subjects/{subject}/versions/{version}/schema: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Subjects (v1) + summary: Get schema string by version + description: Retrieves the schema for the specified version of this subject. + Only the unescaped schema string is returned. + operationId: getSchemaOnly_1 + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: version + in: path + description: Version of the schema to be returned. Valid values for versionId + are between [1,2^31-1] or the string "latest". "latest" returns the last + registered schema under the specified subject. Note that there may be + a new latest schema that gets registered right after this request is served. + required: true + schema: + type: string + - name: deleted + in: query + description: Whether to include deleted schema + schema: + type: boolean + responses: + '200': + description: The schema string. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + application/json; qs=0.5: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + '404': + description: Not Found. Error code 40401 indicates subject not found. Error + code 40402 indicates version not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: Unprocessable Entity. Error code 42202 indicates an invalid + version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /subjects/{subject}/versions: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Subjects (v1) + summary: List versions under subject + description: Retrieves a list of versions registered under the specified subject. + operationId: listVersions + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: deleted + in: query + description: Whether to include deleted schemas + schema: + type: boolean + - name: deletedOnly + in: query + description: Whether to return deleted schemas only + schema: + type: boolean + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of version numbers matching the specified parameters. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + application/json; qs=0.5: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + '404': + description: 'Not Found. Error code 40401 indicates subject not found. ' + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + post: + tags: + - Subjects (v1) + summary: Register schema under a subject + description: |- + Register a new schema under the specified subject. If successfully registered, this returns the unique identifier of this schema in the registry. The returned identifier should be used to retrieve this schema from the schemas resource and is different from the schema's version which is associated with the subject. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects. + A schema should be compatible with the previously registered schema or schemas (if there are any) as per the configured compatibility level. The configured compatibility level can be obtained by issuing a GET http:get:: /config/(string: subject). If that returns null, then GET http:get:: /config + When there are multiple instances of Schema Registry running in the same cluster, the schema registration request will be forwarded to one of the instances designated as the primary. If the primary is not available, the client will get an error code indicating that the forwarding has failed. + operationId: register + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: normalize + in: query + description: Whether to register the normalized schema + schema: + type: boolean + - name: format + in: query + description: 'Desired output format, dependent on schema type. For AVRO + schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, + valid values are: " " (default), "ignore_extensions", or "serialized" + (The parameter does not apply to JSON schemas.)' + schema: + type: string + default: '' + requestBody: + description: Schema + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + required: true + responses: + '200': + description: Schema successfully registered. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/RegisterSchemaResponse' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/RegisterSchemaResponse' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/RegisterSchemaResponse' + '409': + description: Conflict. Incompatible schema. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: 'Unprocessable entity. Error code 42201 indicates an invalid + schema or schema type. ' + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. Error code 50002 indicates operation timed + out. Error code 50003 indicates a failure forwarding the request to the + primary. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /subjects/{subject}: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + post: + tags: + - Subjects (v1) + summary: Lookup schema under subject + description: Check if a schema has already been registered under the specified + subject. If so, this returns the schema string along with its globally unique + identifier, its version under this subject and the subject name. + operationId: lookUpSchemaUnderSubject + parameters: + - name: subject + in: path + description: Subject under which the schema will be registered + required: true + schema: + type: string + - name: normalize + in: query + description: Whether to lookup the normalized schema + schema: + type: boolean + - name: format + in: query + description: 'Desired output format, dependent on schema type. For AVRO + schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, + valid values are: " " (default), "ignore_extensions", or "serialized" + (The parameter does not apply to JSON schemas.)' + schema: + type: string + default: '' + - name: deleted + in: query + description: Whether to lookup deleted schemas + schema: + type: boolean + requestBody: + description: Schema + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + required: true + responses: + '200': + description: The schema. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Schema' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Schema' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Schema' + '404': + description: Not Found. Error code 40401 indicates subject not found. Error + code 40403 indicates schema not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Subjects (v1) + summary: Delete subject + description: Deletes the specified subject and its associated compatibility + level if registered. It is recommended to use this API only when a topic needs + to be recycled or in development environment. + operationId: deleteSubject + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: permanent + in: query + description: Whether to perform a permanent delete + schema: + type: boolean + responses: + '200': + description: Operation succeeded. Returns list of schema versions deleted + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + application/json; qs=0.5: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /subjects: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Subjects (v1) + summary: List subjects + description: Retrieves a list of registered subjects matching specified parameters. + operationId: list + parameters: + - name: subjectPrefix + in: query + description: Subject name prefix + schema: + type: string + default: ':*:' + - name: deleted + in: query + description: Whether to look up deleted subjects + schema: + type: boolean + - name: deletedOnly + in: query + description: Whether to return deleted subjects only + schema: + type: boolean + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of subjects matching the specified parameters. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: string + example: User + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: string + example: User + application/json; qs=0.5: + schema: + type: array + items: + type: string + example: User + '500': + description: Internal Server Error. Error code 50001 indicates a failure + in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + security: + - resource-api-key: [] + - external-access-token: [] + /subjects/{subject}/metadata: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Subjects (v1) + summary: Retrieve the latest version with the given metadata. + description: Retrieve the latest version with the given metadata. + operationId: getLatestWithMetadata + parameters: + - name: subject + in: path + description: Subject under which the schema will be registered + required: true + schema: + type: string + - name: key + in: query + description: The metadata key. Add "?key=key" at the end of the request + to match a metadata key. This query parameter can appear multiple times. + Each instance is matched with a corresponding value query parameter, in + order. + schema: + type: string + - name: value + in: query + description: The metadata value. Add "?value=value" at the end of the request + to match a metadata value. This query parameter can appear multiple times. + Each instance is matched with a corresponding key query parameter, in + order. + schema: + type: string + - name: format + in: query + description: 'Desired output format, dependent on schema type. For AVRO + schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, + valid values are: " " (default), "ignore_extensions", or "serialized" + (The parameter does not apply to JSON schemas.)' + schema: + type: string + default: '' + - name: deleted + in: query + description: Whether to lookup deleted schemas + schema: + type: boolean + responses: + '200': + description: The schema. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Schema' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Schema' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Schema' + '404': + description: |- + Error code 40401 -- Subject not found + Error code 40403 -- Schema not found + '500': + description: Internal Server Error. + security: + - resource-api-key: [] + - external-access-token: [] + /dek-registry/v1/keks: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Key Encryption Keys (v1) + operationId: getKekNames + parameters: + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + items: + example: mykek + type: string + type: array + application/vnd.schemaregistry+json; qs=0.9: + schema: + items: + example: mykek + type: string + type: array + application/json; qs=0.5: + schema: + items: + example: mykek + type: string + type: array + description: List of kek names + summary: Get a list of kek names + security: + - resource-api-key: [] + - external-access-token: [] + post: + tags: + - Key Encryption Keys (v1) + operationId: createKek + parameters: + - description: Whether to test kek sharing + explode: true + in: query + name: testSharing + required: false + schema: + type: boolean + default: false + style: form + requestBody: + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/CreateKekRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/CreateKekRequest' + application/json: + schema: + $ref: '#/components/schemas/CreateKekRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/CreateKekRequest' + description: The create request + required: true + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Kek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Kek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Kek' + description: The create response + '409': + description: Conflict. Error code 40971 -- Key already exists. Error code + 40972 -- Too many keys. + '422': + description: Error code 42271 -- Invalid key + summary: Create a kek + security: + - resource-api-key: [] + - external-access-token: [] + /dek-registry/v1/keks/{name}: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + delete: + tags: + - Key Encryption Keys (v1) + operationId: deleteKek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Whether to perform a permanent delete + explode: true + in: query + name: permanent + required: false + schema: + type: boolean + style: form + responses: + '204': + description: No Content + '404': + description: Not found. Error code 40470 -- Key not found. Error code 40471 + -- Key not soft-deleted. + '422': + description: Unprocessable entity. Error code 42271 -- Invalid key. Error + code 42272 -- References to key exist. + summary: Delete a kek + security: + - resource-api-key: [] + - external-access-token: [] + get: + tags: + - Key Encryption Keys (v1) + operationId: getKek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Kek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Kek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Kek' + description: The kek info + '404': + description: Error code 40470 -- Key not found + '422': + description: Error code 42271 -- Invalid key + summary: Get a kek by name + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Key Encryption Keys (v1) + operationId: putKek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Whether to test kek sharing + explode: true + in: query + name: testSharing + required: false + schema: + type: boolean + default: false + style: form + requestBody: + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/UpdateKekRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/UpdateKekRequest' + application/json: + schema: + $ref: '#/components/schemas/UpdateKekRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/UpdateKekRequest' + description: The update request + required: true + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Kek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Kek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Kek' + description: The update response + '404': + description: Error code 40470 -- Key not found + '409': + description: Error code 40971 -- Key already exists + '422': + description: Error code 42271 -- Invalid key + summary: Alters a kek + security: + - resource-api-key: [] + - external-access-token: [] + /dek-registry/v1/keks/{name}/undelete: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + post: + tags: + - Key Encryption Keys (v1) + operationId: undeleteKek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + responses: + '204': + description: No Content + '404': + description: Error code 40470 -- Key not found + '422': + description: Unprocessable entity. Error code 42271 -- Invalid key. Error + code 42272 -- References to key exist. + summary: Undelete a kek + security: + - resource-api-key: [] + - external-access-token: [] + /dek-registry/v1/keks/{name}/test: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + post: + tags: + - Key Encryption Keys (v1) + operationId: testKek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Kek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Kek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Kek' + description: The test response + '422': + description: Error code 42271 -- Invalid key + '500': + description: Error code 50070 -- Dek generation error + summary: Test a kek + security: + - resource-api-key: [] + - external-access-token: [] + /dek-registry/v1/keks/{name}/deks: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Data Encryption Keys (v1) + operationId: getDekSubjects + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + - description: Pagination offset for results + explode: true + in: query + name: offset + required: false + schema: + type: integer + default: 0 + style: form + - description: Pagination size for results. Ignored if negative + explode: true + in: query + name: limit + required: false + schema: + type: integer + default: -1 + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + items: + example: User + type: string + type: array + application/vnd.schemaregistry+json; qs=0.9: + schema: + items: + example: User + type: string + type: array + application/json; qs=0.5: + schema: + items: + example: User + type: string + type: array + description: List of dek subjects + '404': + description: Error code 40470 -- Key not found + '422': + description: Error code 42271 -- Invalid key + summary: Get a list of dek subjects + security: + - resource-api-key: [] + - external-access-token: [] + post: + tags: + - Data Encryption Keys (v1) + operationId: createDek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + requestBody: + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/CreateDekRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/CreateDekRequest' + application/json: + schema: + $ref: '#/components/schemas/CreateDekRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/CreateDekRequest' + description: The create request + required: true + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Dek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Dek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Dek' + description: The create response + '409': + description: Conflict. Error code 40971 -- Key already exists. Error code + 40972 -- Too many keys. + '422': + description: Error code 42271 -- Invalid key + '500': + description: Error code 50070 -- Dek generation error + summary: Create a dek + security: + - resource-api-key: [] + - external-access-token: [] + /dek-registry/v1/keks/{name}/deks/{subject}: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + delete: + tags: + - Data Encryption Keys (v1) + operationId: deleteDekVersions + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + - description: Whether to perform a permanent delete + explode: true + in: query + name: permanent + required: false + schema: + type: boolean + style: form + responses: + '204': + description: No Content + '404': + description: Not found. Error code 40470 -- Key not found. Error code 40471 + -- Key not soft-deleted. + '422': + description: Error code 42271 -- Invalid key + summary: Delete all versions of a dek + security: + - resource-api-key: [] + - external-access-token: [] + get: + tags: + - Data Encryption Keys (v1) + operationId: getDek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Dek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Dek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Dek' + description: The dek info + '404': + description: Error code 40470 -- Key not found + '422': + description: Error code 42271 -- Invalid key + '500': + description: Error code 50070 -- Dek generation error + summary: Get a dek by subject + security: + - resource-api-key: [] + - external-access-token: [] + /dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + delete: + tags: + - Data Encryption Keys (v1) + operationId: deleteDekVersion + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Version of the dek + explode: false + in: path + name: version + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + - description: Whether to perform a permanent delete + explode: true + in: query + name: permanent + required: false + schema: + type: boolean + style: form + responses: + '204': + description: No Content + '404': + description: Not found. Error code 40470 -- Key not found. Error code 40471 + -- Key not soft-deleted. + '422': + description: Unprocessable entity. Error code 42202 -- Invalid version. + Error code 42271 -- Invalid key. + summary: Delete a dek version + security: + - resource-api-key: [] + - external-access-token: [] + get: + tags: + - Data Encryption Keys (v1) + operationId: getDekByVersion + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Version of the dek + explode: false + in: path + name: version + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Dek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Dek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Dek' + description: The dek info + '404': + description: Error code 40470 -- Key not found + '422': + description: Unprocessable entity. Error code 42202 -- Invalid version. + Error code 42271 -- Invalid key. + '500': + description: Error code 50070 -- Dek generation error + summary: Get a dek by subject and version + security: + - resource-api-key: [] + - external-access-token: [] + /dek-registry/v1/keks/{name}/deks/{subject}/versions: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + get: + tags: + - Data Encryption Keys (v1) + operationId: getDekVersions + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + - description: Pagination offset for results + explode: true + in: query + name: offset + required: false + schema: + type: integer + default: 0 + style: form + - description: Pagination size for results. Ignored if negative + explode: true + in: query + name: limit + required: false + schema: + type: integer + default: -1 + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + items: + example: 1 + format: int32 + type: integer + type: array + application/vnd.schemaregistry+json; qs=0.9: + schema: + items: + example: 1 + format: int32 + type: integer + type: array + application/json; qs=0.5: + schema: + items: + example: 1 + format: int32 + type: integer + type: array + description: List of version numbers for dek + '404': + description: Error code 40470 -- Key not found + '422': + description: Error code 42271 -- Invalid key + summary: List versions of dek + security: + - resource-api-key: [] + - external-access-token: [] + /dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}/undelete: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + post: + tags: + - Data Encryption Keys (v1) + operationId: undeleteDekVersion + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Version of the dek + explode: false + in: path + name: version + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + responses: + '204': + description: No Content + '404': + description: Not found. Error code 40470 -- Key not found. Error code 40472 + -- Key must be undeleted. + '422': + description: Unprocessable entity. Error code 42202 -- Invalid version. + Error code 42271 -- Invalid key. + summary: Undelete a dek version + security: + - resource-api-key: [] + - external-access-token: [] + /dek-registry/v1/keks/{name}/deks/{subject}/undelete: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + post: + tags: + - Data Encryption Keys (v1) + operationId: undeleteDekVersions + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + responses: + '204': + description: No Content + '404': + description: Not found. Error code 40470 -- Key not found. Error code 40472 + -- Key must be undeleted. + '422': + description: Error code 42271 -- Invalid key + summary: Undelete all versions of a dek + security: + - resource-api-key: [] + - external-access-token: [] + + /catalog/v1/types/businessmetadatadefs: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + get: + summary: Bulk Read Business Metadata Definitions + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk retrieval API for retrieving business metadata definitions. + operationId: getAllBusinessMetadataDefs + tags: + - Types (v1) + parameters: + - description: The prefix of a business metadata definition name + explode: true + in: query + name: prefix + required: false + schema: + type: string + style: form + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataDefResponse' + type: array + description: The business metadata definitions + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + post: + summary: Bulk Create Business Metadata Definitions + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk create API for business metadata definitions. + operationId: createBusinessMetadataDefs + tags: + - Types (v1) + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataDef' + type: array + description: The business metadata definitions to create + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataDefResponse' + type: array + description: The business metadata definitions. Errored business metadata + definitions will have an additional error property. + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + put: + summary: Bulk Update Business Metadata Definitions + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk update API for business metadata definitions. + operationId: updateBusinessMetadataDefs + tags: + - Types (v1) + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataDef' + type: array + description: The business metadata definitions to update + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataDefResponse' + type: array + description: The business metadata definitions. Errored business metadata + definitions will have an additional error property. + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + /catalog/v1/types/businessmetadatadefs/{bmName}: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + delete: + summary: Delete Business Metadata Definition + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete API for business metadata definition identified by its name. + operationId: deleteBusinessMetadataDef + tags: + - Types (v1) + parameters: + - description: The name of the business metadata definition + explode: false + in: path + name: bmName + required: true + schema: + type: string + style: simple + responses: + '204': + description: No Content + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + get: + summary: Read Business Metadata Definition + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get the business metadata definition with the given name. + operationId: getBusinessMetadataDefByName + tags: + - Types (v1) + parameters: + - description: The name of the business metadata definition + explode: false + in: path + name: bmName + required: true + schema: + type: string + style: simple + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BusinessMetadataDef' + description: The business metadata definition + '400': + description: Bad Request + '404': + description: Business metadata definition not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + /catalog/v1/entity/businessmetadata: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + post: + summary: Bulk Create Business Metadata + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk API to create multiple business metadata. + operationId: createBusinessMetadata + tags: + - Entity (v1) + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadata' + type: array + description: The business metadata + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataResponse' + type: array + description: The business metadata. Errored business metadata will have + an additional error property. + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + put: + summary: Bulk Update Business Metadata + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk API to update multiple business metadata. + operationId: updateBusinessMetadata + tags: + - Entity (v1) + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadata' + type: array + description: The business metadata + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataResponse' + type: array + description: The business metadata. Errored business metadata will have + an additional error property. + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + get: + summary: Read Business Metadata for an Entity + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Gets the list of business metadata for a given entity represented + by a qualified name. + operationId: getBusinessMetadata + tags: + - Entity (v1) + parameters: + - description: The type of the entity + explode: false + in: path + name: typeName + required: true + schema: + type: string + style: simple + - description: The qualified name of the entity + explode: false + in: path + name: qualifiedName + required: true + schema: + type: string + style: simple + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataResponse' + type: array + description: The business metadata + '400': + description: Bad Request + '404': + description: Entity not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + delete: + summary: Delete a Business Metadata for an Entity + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete a business metadata on an entity. + operationId: deleteBusinessMetadata + tags: + - Entity (v1) + parameters: + - description: The type of the entity + explode: false + in: path + name: typeName + required: true + schema: + type: string + style: simple + - description: The qualified name of the entity + explode: false + in: path + name: qualifiedName + required: true + schema: + type: string + style: simple + - description: The name of the business metadata + explode: false + in: path + name: bmName + required: true + schema: + type: string + style: simple + responses: + '204': + description: No Content + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + /catalog/v1/entity/tags: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + put: + summary: Bulk Update Tags + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk API to update multiple tags. + tags: + - Entity (v1) + operationId: updateTags + requestBody: + description: The tags + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tag' + responses: + '200': + description: The tags. Errored tags will have an additional error property. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagResponse' + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + post: + summary: Bulk Create Tags + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk API to create multiple tags. + tags: + - Entity (v1) + operationId: createTags + requestBody: + description: The tags + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tag' + responses: + '200': + description: The tags. Errored tags will have an additional error property. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagResponse' + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + /catalog/v1/entity/type/{typeName}/name/{qualifiedName}: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + get: + summary: Read an Entity + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Fetch complete definition of an entity given its type and unique attribute. + operationId: getByUniqueAttributes + parameters: + - name: typeName + in: path + description: The type of the entity + required: true + schema: + type: string + - name: qualifiedName + in: path + description: The qualified name of the entity + required: true + schema: + type: string + - name: minExtInfo + in: query + description: Whether to populate on header and schema attributes + schema: + type: boolean + default: false + - name: ignoreRelationships + in: query + description: Whether to ignore relationships + schema: + type: boolean + default: false + tags: + - Entity (v1) + responses: + '200': + description: The entity + content: + application/json: + schema: + $ref: '#/components/schemas/EntityWithExtInfo' + '400': + description: Bad Request + '404': + description: Entity not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + get: + summary: Read Tags for an Entity + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Gets the list of tags for a given entity represented by a qualified name. + operationId: getTags + parameters: + - name: typeName + in: path + description: The type of the entity + required: true + schema: + type: string + - name: qualifiedName + in: path + description: The qualified name of the entity + required: true + schema: + type: string + tags: + - Entity (v1) + responses: + '200': + description: The tags + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagResponse' + '400': + description: Bad Request + '404': + description: Entity not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + /catalog/v1/entity: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + put: + summary: Update an Entity Attribute + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Partially update an entity attribute. + operationId: partialEntityUpdate + requestBody: + description: The entity to update + content: + application/json: + schema: + $ref: '#/components/schemas/EntityWithExtInfo' + tags: + - Entity (v1) + responses: + '200': + description: The updated entity + content: + application/json: + schema: + $ref: '#/components/schemas/EntityPartialUpdateResponse' + '400': + description: Bad Request + '404': + description: Entity not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + delete: + summary: Delete a Tag for an Entity + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete a tag for an entity. + operationId: deleteTag + parameters: + - name: typeName + in: path + description: The type of the entity + required: true + schema: + type: string + - name: qualifiedName + in: path + description: The qualified name of the entity + required: true + schema: + type: string + - name: tagName + in: path + description: The name of the tag + required: true + schema: + type: string + tags: + - Entity (v1) + responses: + '204': + description: No Content + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + /catalog/v1/search/attribute: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + get: + summary: Search by Attribute + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve data for the specified attribute search query. + operationId: searchUsingAttribute + parameters: + - name: type + in: query + description: Limit the result to only entities of specified types + style: form + explode: true + schema: + type: array + items: + type: string + - name: attr + in: query + description: One of more additional attributes to return in the response + style: form + explode: true + schema: + type: array + items: + type: string + - name: attrName + in: query + description: The attribute to search + style: form + explode: true + schema: + type: array + items: + type: string + - name: attrValuePrefix + in: query + description: The prefix for the attribute value to search + style: form + explode: true + schema: + type: array + items: + type: string + - name: tag + in: query + description: Limit the result to only entities tagged with the given tag + schema: + type: string + - name: sortBy + in: query + description: An attribute to sort by + schema: + type: string + - name: sortOrder + in: query + description: Sort order, either ASCENDING (default) or DESCENDING + schema: + type: string + enum: + - ASCENDING + - DESCENDING + - name: deleted + in: query + description: Whether to include deleted entities + schema: + type: boolean + - name: limit + in: query + description: Limit the result set to only include the specified number of + entries + schema: + type: integer + format: int32 + - name: offset + in: query + description: Start offset of the result set (useful for pagination) + schema: + type: integer + format: int32 + tags: + - Search (v1) + responses: + '200': + description: On successful search query with some results, might return + an empty list if execution succeeded without any results + content: + application/json: + schema: + $ref: '#/components/schemas/SearchResult' + '400': + description: Invalid wildcard or query parameters + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + /catalog/v1/search/basic: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + get: + summary: Search by Fulltext Query + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve data for the specified fulltext query. + operationId: searchUsingBasic + parameters: + - name: query + in: query + description: The full-text query + schema: + type: string + - name: type + in: query + description: Limit the result to only entities of specified types + style: form + explode: true + schema: + type: array + items: + type: string + - name: attr + in: query + description: One of more additional attributes to return in the response + style: form + explode: true + schema: + type: array + items: + type: string + - name: tag + in: query + description: Limit the result to only entities tagged with the given tag + schema: + type: string + - name: sortBy + in: query + description: An attribute to sort by + schema: + type: string + - name: sortOrder + in: query + description: Sort order, either ASCENDING (default) or DESCENDING + schema: + type: string + enum: + - ASCENDING + - DESCENDING + - name: deleted + in: query + description: Whether to include deleted entities + schema: + type: boolean + - name: limit + in: query + description: Limit the result set to only include the specified number of + entries + schema: + type: integer + format: int32 + - name: offset + in: query + description: Start offset of the result set (useful for pagination) + schema: + type: integer + format: int32 + tags: + - Search (v1) + responses: + '200': + description: On successful fulltext query with some results, might return + an empty list if execution succeeded without any results + content: + application/json: + schema: + $ref: '#/components/schemas/SearchResult' + '400': + description: Invalid fulltext or query parameters + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + /catalog/v1/types/tagdefs: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + get: + summary: Bulk Read Tag Definitions + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk retrieval API for retrieving tag definitions. + operationId: getAllTagDefs + parameters: + - name: prefix + in: query + description: The prefix of a tag definition name + schema: + type: string + tags: + - Types (v1) + responses: + '200': + description: The tag definitions + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagDefResponse' + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + put: + summary: Bulk Update Tag Definitions + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk update API for tag definitions. + tags: + - Types (v1) + operationId: updateTagDefs + requestBody: + description: The tag definitions to update + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagDef' + responses: + '200': + description: The tag definitions. Errored tag definitions will have an additional + error property. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagDefResponse' + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + post: + summary: Bulk Create Tag Definitions + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk create API for tag definitions. + tags: + - Types (v1) + operationId: createTagDefs + requestBody: + description: The tag definitions to create + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagDef' + responses: + '200': + description: The tag definitions. Errored tag definitions will have an additional + error property. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagDefResponse' + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + /catalog/v1/types/tagdefs/{tagName}: + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + get: + summary: Read Tag Definition + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get the tag definition with the given name. + operationId: getTagDefByName + parameters: + - name: tagName + in: path + description: The name of the tag definiton + required: true + schema: + type: string + tags: + - Types (v1) + responses: + '200': + description: The tag definition + content: + application/json: + schema: + $ref: '#/components/schemas/TagDef' + '400': + description: Bad Request + '404': + description: Tag definition not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + delete: + summary: Delete Tag Definition + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete API for tag definition identified by its name. + operationId: deleteTagDef + parameters: + - name: tagName + in: path + description: The name of the tag definition + required: true + schema: + type: string + tags: + - Types (v1) + responses: + '204': + description: No Content + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + /cdx/v1/provider-shared-resources: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCdxV1ProviderSharedResources + summary: List of Provider Shared Resources + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all provider shared resources. + parameters: + - name: stream_share + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: ss-1234 + description: Filter the results by exact match for stream_share. + - name: crn + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + description: Filter the results by exact match for crn. + - name: include_deleted + in: query + required: false + schema: + $ref: '#/components/schemas/BooleanFilter' + description: Include deactivated shared resources + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Provider Shared Resource. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cdx.v1.ProviderSharedResourceList' + - type: object + properties: + data: + type: array + items: + properties: + cloud_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cdx/v1/provider-shared-resources/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCdxV1ProviderSharedResource + summary: Read a Provider Shared Resource + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a provider shared resource. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider shared resource. + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Provider Shared Resource. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cdx.v1.ProviderSharedResource' + - type: object + required: + - api_version + - kind + - id + - display_name + - organization_name + - environment_name + - cluster_name + - cloud_cluster + - type: object + properties: + cloud_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateCdxV1ProviderSharedResource + summary: Update a Provider Shared Resource + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a provider shared resource. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider shared resource. + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cdx.v1.ProviderSharedResource' + responses: + '200': + description: Provider Shared Resource. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cdx.v1.ProviderSharedResource' + - type: object + required: + - api_version + - kind + - id + - display_name + - organization_name + - environment_name + - cluster_name + - cloud_cluster + - type: object + properties: + cloud_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cdx/v1/provider-shared-resources/{id}/images/{file_name}: + x-lifecycle-stage: General Availability + x-self-access: true + post: + summary: Upload image for shared resource + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Upload the image file for the shared resource + requestBody: + content: + image/*: + schema: + type: string + format: base64 + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ProviderSharedResource + operationId: upload_imageCdxV1ProviderSharedResource + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider shared resource. + - name: file_name + in: path + required: true + schema: + type: string + description: The File Name + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '201': + description: image uploaded + headers: + Location: + schema: + type: string + format: uri + example: https://some-subdomain.confluent.cloud/path/to/resource + description: A URL that allows access to the image file + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + get: + summary: Get image for shared resource + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Returns the image file for the shared resource + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ProviderSharedResource + operationId: view_imageCdxV1ProviderSharedResource + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider shared resource. + - name: file_name + in: path + required: true + schema: + type: string + description: The File Name + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: returns the image file + content: + image/*: + schema: + type: string + format: binary + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + summary: Delete the shared resource's image + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Deletes the image file for the shared resource + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ProviderSharedResource + operationId: delete_imageCdxV1ProviderSharedResource + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider shared resource. + - name: file_name + in: path + required: true + schema: + type: string + description: The File Name + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cdx/v1/provider-shares: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCdxV1ProviderShares + summary: List of Provider Shares + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all provider shares. + parameters: + - name: shared_resource + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: sr-1234 + description: Filter the results by exact match for shared_resource. + - name: crn + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + description: Filter the results by exact match for crn. + - name: include_deleted + in: query + required: false + schema: + $ref: '#/components/schemas/BooleanFilter' + description: Include deactivated shares + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Provider Shares (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Provider Share. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cdx.v1.ProviderShareList' + - type: object + properties: + data: + type: array + items: + properties: + service_account: + example: + id: sa-4voj5e + related: https://api.confluent.cloud/iam/v2/service-accounts/sa-4voj5e + resource_name: https://api.confluent.cloud/service-account=sa-4voj5e + cloud_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + summary: Create a provider share + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Creates a share based on delivery method. + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cdx.v1.CreateProviderShareRequest' + - type: object + required: + - delivery_method + - consumer_restriction + - resources + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createCdxV1ProviderShare + tags: + - Provider Shares (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '201': + description: | + Response is the provider share + headers: + Location: + schema: + type: string + format: uri + example: https://some-subdomain.confluent.cloud/path/to/resource + description: A URL that allows access to the resourced named by the + crn + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/cdx.v1.ProviderShare' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cdx/v1/provider-shares/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCdxV1ProviderShare + summary: Read a Provider Share + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a provider share. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider share. + tags: + - Provider Shares (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Provider Share. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cdx.v1.ProviderShare' + - type: object + required: + - api_version + - kind + - id + - provider_user_name + - delivery_method + - invited_at + - invite_expires_at + - provider_user + - cloud_cluster + - status + - type: object + properties: + service_account: + example: + id: sa-4voj5e + related: https://api.confluent.cloud/iam/v2/service-accounts/sa-4voj5e + resource_name: https://api.confluent.cloud/service-account=sa-4voj5e + cloud_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteCdxV1ProviderShare + summary: Delete a Provider Share + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a provider share. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider share. + tags: + - Provider Shares (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Provider Share is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cdx/v1/provider-shares/{id}:resend: + x-lifecycle-stage: General Availability + x-self-access: true + post: + summary: Resend + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Resend provider share + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ProviderShare + operationId: resendCdxV1ProviderShare + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider share. + tags: + - Provider Shares (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cdx/v1/consumer-shared-resources: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCdxV1ConsumerSharedResources + summary: List of Consumer Shared Resources + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all consumer shared resources. + parameters: + - name: stream_share + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: ss-1234 + description: Filter the results by exact match for stream_share. + - name: include_deleted + in: query + required: false + schema: + $ref: '#/components/schemas/BooleanFilter' + description: Include deactivated shared resources + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Consumer Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Consumer Shared Resource. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cdx.v1.ConsumerSharedResourceList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cdx/v1/consumer-shared-resources/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCdxV1ConsumerSharedResource + summary: Read a Consumer Shared Resource + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a consumer shared resource. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the consumer shared resource. + tags: + - Consumer Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Consumer Shared Resource. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cdx.v1.ConsumerSharedResource' + - type: object + required: + - api_version + - kind + - id + - cloud + - display_name + - organization_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cdx/v1/consumer-shared-resources/{id}/images/{file_name}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + summary: Get image for shared resource + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Returns the image file for the shared resource + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ConsumerSharedResource + operationId: imageCdxV1ConsumerSharedResource + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the consumer shared resource. + - name: file_name + in: path + required: true + schema: + type: string + description: The File Name + tags: + - Consumer Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Returns the image file's binary content + content: + image/*: + schema: + type: string + format: binary + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cdx/v1/consumer-shared-resources/{id}:network: + x-lifecycle-stage: General Availability + x-self-access: true + get: + summary: Get shared resource's network configuration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Returns network information of the shared resource + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ConsumerSharedResource + operationId: networkCdxV1ConsumerSharedResource + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the consumer shared resource. + tags: + - Consumer Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: The network information of the shared resource + content: + application/json: + schema: + $ref: '#/components/schemas/cdx.v1.Network' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cdx/v1/consumer-shares: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCdxV1ConsumerShares + summary: List of Consumer Shares + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all consumer shares. + parameters: + - name: shared_resource + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: sr-1234 + description: Filter the results by exact match for shared_resource. + - name: include_deleted + in: query + required: false + schema: + $ref: '#/components/schemas/BooleanFilter' + description: Include deactivated shares + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Consumer Shares (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Consumer Share. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cdx.v1.ConsumerShareList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cdx/v1/consumer-shares/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCdxV1ConsumerShare + summary: Read a Consumer Share + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a consumer share. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the consumer share. + tags: + - Consumer Shares (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Consumer Share. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cdx.v1.ConsumerShare' + - type: object + required: + - api_version + - kind + - id + - provider_organization_name + - provider_user_name + - consumer_user + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteCdxV1ConsumerShare + summary: Delete a Consumer Share + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a consumer share. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the consumer share. + tags: + - Consumer Shares (cdx/v1) + security: + - cloud-api-key: [] + responses: + '204': + description: A Consumer Share is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cdx/v1/shared-tokens:resources: + x-lifecycle-stage: General Availability + x-self-access: true + post: + summary: Validate token to view shared resources + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Validate and decrypt the shared token and view token's shared resources + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cdx.v1.SharedToken' + - type: object + required: + - token + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.SharedToken + operationId: resourcesCdxV1SharedToken + tags: + - Shared Tokens (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: | + Consumer validates share token and view consumer resources before redeeming in the workflow + content: + application/json: + schema: + type: object + properties: + consumer_shared_resources: + type: array + items: + $ref: '#/components/schemas/cdx.v1.ConsumerSharedResource' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cdx/v1/shared-tokens:redeem: + x-lifecycle-stage: General Availability + x-self-access: true + post: + summary: Redeem token + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Redeem the shared token for shared topic and cluster access information + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cdx.v1.RedeemTokenRequest' + - type: object + required: + - token + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.SharedToken + operationId: redeemCdxV1SharedToken + tags: + - Shared Tokens (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: | + Consumer redeems shared token + content: + application/json: + schema: + $ref: '#/components/schemas/cdx.v1.RedeemTokenResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /cdx/v1/opt-in: + x-lifecycle-stage: General Availability + x-self-access: true + get: + summary: Read the organization's stream sharing opt-in settings + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Returns the organization's stream sharing opt-in settings. + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCdxV1OptIn + tags: + - Opt Ins (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Opt In. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cdx.v1.OptIn' + - type: object + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + summary: Set the organization's stream sharing opt-in settings + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Updates the organization's stream sharing opt-in settings. + + + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateCdxV1OptIn + tags: + - Opt Ins (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cdx.v1.OptIn' + responses: + '200': + description: Opt In. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/cdx.v1.OptIn' + - type: object + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /partner/v2/organizations/{id}: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + get: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + operationId: getPartnerV2Organization + summary: Read an Organization + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to read an organization. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the organization. + tags: + - Organizations (partner/v2) + security: + - oauth: + - marketplace::describe + responses: + '200': + description: Organization. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/partner.v2.Organization' + - type: object + required: + - api_version + - kind + - id + - metadata + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-codeSamples: + - lang: Shell + source: |- + curl --request GET \ + --url 'https://api.confluent.cloud/partner/v2/organizations/{id}' \ + --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' + - lang: Java + source: |- + OkHttpClient client = new OkHttpClient(); + + Request request = new Request.Builder() + .url("https://api.confluent.cloud/partner/v2/organizations/{id}") + .get() + .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN") + .build(); + + Response response = client.newCall(request).execute(); + - lang: Go + source: |- + package main + + import ( + "fmt" + "net/http" + "io/ioutil" + ) + + func main() { + + url := "https://api.confluent.cloud/partner/v2/organizations/{id}" + + req, _ := http.NewRequest("GET", url, nil) + + req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN") + + res, _ := http.DefaultClient.Do(req) + + defer res.Body.Close() + body, _ := ioutil.ReadAll(res.Body) + + fmt.Println(res) + fmt.Println(string(body)) + + } + - lang: Python + source: |- + import http.client + + conn = http.client.HTTPSConnection("api.confluent.cloud") + + headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" } + + conn.request("GET", "/partner/v2/organizations/{id}", headers=headers) + + res = conn.getresponse() + data = res.read() + + print(data.decode("utf-8")) + - lang: Node + source: |- + const http = require("https"); + + const options = { + "method": "GET", + "hostname": "api.confluent.cloud", + "port": null, + "path": "/partner/v2/organizations/{id}", + "headers": { + "Authorization": "Bearer REPLACE_BEARER_TOKEN" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.end(); + - lang: C + source: |- + CURL *hnd = curl_easy_init(); + + curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); + curl_easy_setopt(hnd, CURLOPT_URL, "https://api.confluent.cloud/partner/v2/organizations/{id}"); + + struct curl_slist *headers = NULL; + headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); + curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); + + CURLcode ret = curl_easy_perform(hnd); + - lang: C# + source: |- + var client = new RestClient("https://api.confluent.cloud/partner/v2/organizations/{id}"); + var request = new RestRequest(Method.GET); + request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); + IRestResponse response = client.Execute(request); + /partner/v2/organizations: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + get: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + operationId: listPartnerV2Organizations + summary: List of Organizations + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Retrieve a sorted, filtered, paginated list of all organizations. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + description: An opaque pagination token for collection requests. + tags: + - Organizations (partner/v2) + security: + - oauth: + - marketplace::describe + responses: + '200': + description: Organization. + content: + application/json: + schema: + $ref: '#/components/schemas/partner.v2.OrganizationList' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-codeSamples: + - lang: Shell + source: |- + curl --request GET \ + --url 'https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE' \ + --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' + - lang: Java + source: |- + OkHttpClient client = new OkHttpClient(); + + Request request = new Request.Builder() + .url("https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE") + .get() + .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN") + .build(); + + Response response = client.newCall(request).execute(); + - lang: Go + source: |- + package main + + import ( + "fmt" + "net/http" + "io/ioutil" + ) + + func main() { + + url := "https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE" + + req, _ := http.NewRequest("GET", url, nil) + + req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN") + + res, _ := http.DefaultClient.Do(req) + + defer res.Body.Close() + body, _ := ioutil.ReadAll(res.Body) + + fmt.Println(res) + fmt.Println(string(body)) + + } + - lang: Python + source: |- + import http.client + + conn = http.client.HTTPSConnection("api.confluent.cloud") + + headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" } + + conn.request("GET", "/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE", headers=headers) + + res = conn.getresponse() + data = res.read() + + print(data.decode("utf-8")) + - lang: Node + source: |- + const http = require("https"); + + const options = { + "method": "GET", + "hostname": "api.confluent.cloud", + "port": null, + "path": "/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE", + "headers": { + "Authorization": "Bearer REPLACE_BEARER_TOKEN" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.end(); + - lang: C + source: |- + CURL *hnd = curl_easy_init(); + + curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); + curl_easy_setopt(hnd, CURLOPT_URL, "https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE"); + + struct curl_slist *headers = NULL; + headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); + curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); + + CURLcode ret = curl_easy_perform(hnd); + - lang: C# + source: |- + var client = new RestClient("https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE"); + var request = new RestRequest(Method.GET); + request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); + IRestResponse response = client.Execute(request); + /partner/v2/signup: + post: + summary: Signup an Organization on behalf of a Customer + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Create an organization for a customer. You must pass in either an entitlement object reference (a url to + a previously created entitlement) or entitlement details. If you pass in an entitlement object reference, we will link with the + created entitlement. If you pass in the entitlement details, we will create the entitlement with the organization + in a single transaction. If you pass in user details (email, given name, and family name), we will + create a user as well. If you do not pass in user details, you MUST call `/partner/v2/signup/activate` + with user details to complete signup. + parameters: + - name: dry_run + in: query + required: false + schema: + type: boolean + description: If true, only perform validation of signup + requestBody: + description: A JSON object containing signup information + content: + application/json: + schema: + $ref: '#/components/schemas/PartnerSignupRequest' + x-lifecycle-stage: Early Access + operationId: signup + tags: + - Signup (partner/v2) + security: + - oauth: + - partner:create + responses: + '201': + description: Successful signup. + content: + application/json: + schema: + $ref: '#/components/schemas/PartnerSignupResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /partner/v2/signup/activate: + x-lifecycle-stage: Early Access + post: + summary: Activate an Incomplete Signup + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Creates a user in the organization previously created in `/partner/v2/signup`. This completes the signup + process if you did not pass in user details to `/partner/v2/signup`. Calling this endpoint if the signup + process has been completed will result in a `409 Conflict` error. + requestBody: + description: A JSON object containing signup information + content: + application/json: + schema: + $ref: '#/components/schemas/ActivatePartnerSignupRequest' + x-lifecycle-stage: Early Access + operationId: activateSignup + tags: + - Signup (partner/v2) + security: + - oauth: + - partner:create + responses: + '201': + description: Successful signup activation. User is being created. + content: + application/json: + schema: + $ref: '#/components/schemas/PartnerSignupResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /partner/v2/signup/link: + post: + summary: Signup a Customer by Linking to an Existing Organization + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Signup a customer by linking a new entitlement to an existing Confluent Cloud organization. + parameters: + - name: dry_run + in: query + required: false + schema: + type: boolean + description: If true, only perform validation of signup + requestBody: + description: A JSON object containing signup information + content: + application/json: + schema: + $ref: '#/components/schemas/PartnerLinkRequest' + x-lifecycle-stage: Early Access + operationId: signupPartnerV2Link + tags: + - Signup (partner/v2) + security: + - oauth: + - partner:create + responses: + '201': + description: Successful signup. + content: + application/json: + schema: + $ref: '#/components/schemas/PartnerSignupResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/networks: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1Networks + summary: List of Networks + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all networks. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [prod-gcp-us-central1, prod-aws-us-east1] + description: Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.cloud + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [GCP, AWS] + description: Filter the results by exact match for spec.cloud. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: spec.region + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [us-central1, us-east-1] + description: Filter the results by exact match for spec.region. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: spec.connection_types + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [peering, privatelink] + description: Filter the results by exact match for spec.connection_types. + Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.cidr + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [10.200.0.0/16] + description: Filter the results by exact match for spec.cidr. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [PROVISIONING, READY] + description: Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Networks (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1Network + summary: Create a Network + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a network. + tags: + - Networks (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.Network' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - cloud + - region + - connection_types + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + responses: + '202': + description: A Network is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/networks/{id} + description: Network resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.Network' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - cloud + - region + - connection_types + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/networks/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1Network + summary: Read a Network + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a network. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network. + tags: + - Networks (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.Network' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - cloud + - region + - connection_types + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1Network + summary: Update a Network + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a network. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network. + tags: + - Networks (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.Network' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Network. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.Network' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - cloud + - region + - connection_types + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1Network + summary: Delete a Network + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a network. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network. + tags: + - Networks (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Network is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/peerings: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1Peerings + summary: List of Peerings + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all peerings. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [prod-peering-uscentral1, prod-peering-use1] + description: Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [PROVISIONING, READY] + description: Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [n-00000, n-00001] + description: Filter the results by exact match for spec.network. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Peerings (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Peering. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PeeringList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1Peering + summary: Create a Peering + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a peering. + tags: + - Peerings (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.Peering' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - cloud + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + network: + example: + id: n-00000 + responses: + '202': + description: A Peering is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/peerings/{id} + description: Peering resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.Peering' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/peerings/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1Peering + summary: Read a Peering + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a peering. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the peering. + tags: + - Peerings (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Peering. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.Peering' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1Peering + summary: Update a Peering + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a peering. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the peering. + tags: + - Peerings (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.Peering' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Peering. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.Peering' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1Peering + summary: Delete a Peering + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a peering. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the peering. + tags: + - Peerings (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Peering is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/transit-gateway-attachments: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1TransitGatewayAttachments + summary: List of Transit Gateway Attachments + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all transit gateway attachments. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [prod-tgw-use1, prod-tgw-usw2] + description: Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [PROVISIONING, READY] + description: Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [n-00000, n-00001] + description: Filter the results by exact match for spec.network. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Transit Gateway Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Transit Gateway Attachment. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1TransitGatewayAttachment + summary: Create a Transit Gateway Attachment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a transit gateway attachment. + tags: + - Transit Gateway Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.TransitGatewayAttachment' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - cloud + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + network: + example: + id: n-00000 + responses: + '202': + description: A Transit Gateway Attachment is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/transit-gateway-attachments/{id} + description: TransitGatewayAttachment resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.TransitGatewayAttachment' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/transit-gateway-attachments/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1TransitGatewayAttachment + summary: Read a Transit Gateway Attachment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a transit gateway attachment. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the transit gateway attachment. + tags: + - Transit Gateway Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Transit Gateway Attachment. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.TransitGatewayAttachment' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1TransitGatewayAttachment + summary: Update a Transit Gateway Attachment + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a transit gateway attachment. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the transit gateway attachment. + tags: + - Transit Gateway Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.TransitGatewayAttachment' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Transit Gateway Attachment. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.TransitGatewayAttachment' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1TransitGatewayAttachment + summary: Delete a Transit Gateway Attachment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a transit gateway attachment. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the transit gateway attachment. + tags: + - Transit Gateway Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Transit Gateway Attachment is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/private-link-accesses: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1PrivateLinkAccesses + summary: List of Private Link Accesses + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all private link accesses. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [prod-pl-use1, prod-pl-usw2] + description: Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [PROVISIONING, READY] + description: Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [n-00000, n-00001] + description: Filter the results by exact match for spec.network. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Private Link Accesses (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Access. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAccessList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1PrivateLinkAccess + summary: Create a Private Link Access + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a private link access. + tags: + - Private Link Accesses (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAccess' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - cloud + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + network: + example: + id: n-00000 + responses: + '202': + description: A Private Link Access is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/private-link-accesses/{id} + description: PrivateLinkAccess resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAccess' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/private-link-accesses/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1PrivateLinkAccess + summary: Read a Private Link Access + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a private link access. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link access. + tags: + - Private Link Accesses (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Access. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAccess' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1PrivateLinkAccess + summary: Update a Private Link Access + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a private link access. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link access. + tags: + - Private Link Accesses (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAccess' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Private Link Access. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAccess' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1PrivateLinkAccess + summary: Delete a Private Link Access + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a private link access. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link access. + tags: + - Private Link Accesses (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Private Link Access is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/network-link-services: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1NetworkLinkServices + summary: List of Network Link Services + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all network link services. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [prod-net-1-nls, dev-net-1-nls] + description: Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [READY] + description: Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [n-00000, n-00001] + description: Filter the results by exact match for spec.network. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Network Link Services (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Service. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkServiceList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1NetworkLinkService + summary: Create a Network Link Service + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a network link service. + tags: + - Network Link Services (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkService' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + network: + example: + id: n-00000 + responses: + '202': + description: A Network Link Service is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/network-link-services/{id} + description: NetworkLinkService resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkService' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/network-link-services/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1NetworkLinkService + summary: Read a Network Link Service + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a network link service. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link service. + tags: + - Network Link Services (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Service. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkService' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1NetworkLinkService + summary: Update a Network Link Service + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a network link service. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link service. + tags: + - Network Link Services (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkService' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Network Link Service. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkService' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - environment + - network + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1NetworkLinkService + summary: Delete a Network Link Service + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a network link service. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link service. + tags: + - Network Link Services (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Network Link Service is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/network-link-endpoints: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1NetworkLinkEndpoints + summary: List of Network Link Endpoints + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all network link endpoints. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [prod-net-1-nle, dev-net-1-nle] + description: Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [READY, PENDING_ACCEPT] + description: Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [n-00000, n-00001] + description: Filter the results by exact match for spec.network. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: spec.network_link_service + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [nls-abcde, nls-00000] + description: Filter the results by exact match for spec.network_link_service. + Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Network Link Endpoints (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Endpoint. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + network_link_service: + example: + id: nls-abcde + related: https://api.confluent.cloud/networking/v1/network-link-services/nls-abcde + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/network-link-service=nls-abcde + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1NetworkLinkEndpoint + summary: Create a Network Link Endpoint + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a network link endpoint. + tags: + - Network Link Endpoints (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkEndpoint' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + - network + - network_link_service + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + network: + example: + id: n-00000 + network_link_service: + example: + id: nls-abcde + responses: + '202': + description: A Network Link Endpoint is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/network-link-endpoints/{id} + description: NetworkLinkEndpoint resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkEndpoint' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - environment + - network + - network_link_service + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + network_link_service: + example: + id: nls-abcde + related: https://api.confluent.cloud/networking/v1/network-link-services/nls-abcde + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/network-link-service=nls-abcde + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/network-link-endpoints/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1NetworkLinkEndpoint + summary: Read a Network Link Endpoint + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a network link endpoint. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link endpoint. + tags: + - Network Link Endpoints (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Endpoint. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkEndpoint' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - environment + - network + - network_link_service + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + network_link_service: + example: + id: nls-abcde + related: https://api.confluent.cloud/networking/v1/network-link-services/nls-abcde + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/network-link-service=nls-abcde + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1NetworkLinkEndpoint + summary: Update a Network Link Endpoint + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a network link endpoint. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link endpoint. + tags: + - Network Link Endpoints (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkEndpoint' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Network Link Endpoint. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkEndpoint' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - environment + - network + - network_link_service + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + network_link_service: + example: + id: nls-abcde + related: https://api.confluent.cloud/networking/v1/network-link-services/nls-abcde + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/network-link-service=nls-abcde + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1NetworkLinkEndpoint + summary: Delete a Network Link Endpoint + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a network link endpoint. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link endpoint. + tags: + - Network Link Endpoints (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Network Link Endpoint is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/network-link-service-associations: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1NetworkLinkServiceAssociations + summary: List of Network Link Service Associations + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all network link service associations. + parameters: + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [READY, PENDING_ACCEPT] + description: Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: spec.network_link_service + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: nls-abcde + description: Filter the results by exact match for spec.network_link_service. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Network Link Service Associations (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Service Association. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkServiceAssociationList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + network_link_service: + example: + id: nls-abcde + related: https://api.confluent.cloud/networking/v1/network-link-services/nls-abcde + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/network-link-service=nls-abcde + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/network-link-service-associations/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1NetworkLinkServiceAssociation + summary: Read a Network Link Service Association + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a network link service association. + parameters: + - name: spec.network_link_service + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: nls-abcde + description: Scope the operation to the given spec.network_link_service. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link service association. + tags: + - Network Link Service Associations (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Service Association. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkServiceAssociation' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - display_name + - network_link_endpoint + - network_link_service + - environment + - type: object + properties: + spec: + type: object + properties: + network_link_service: + example: + id: nls-abcde + related: https://api.confluent.cloud/networking/v1/network-link-services/nls-abcde + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/network-link-service=nls-abcde + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/ip-addresses: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1IpAddresses + summary: List of IP Addresses + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Related guide: [Use Public Egress IP addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + Retrieve a sorted, filtered, paginated list of all IP Addresses. + parameters: + - name: cloud + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [GCP, AWS] + description: Filter the results by exact match for cloud. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: region + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [us-central1, us-east-1] + description: Filter the results by exact match for region. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: services + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [KAFKA, CONNECT] + description: Filter the results by exact match for services. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: address_type + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [INGRESS, EGRESS] + description: Filter the results by exact match for address_type. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - IP Addresses (networking/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: IP Address. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.IpAddressList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/private-link-attachments: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1PrivateLinkAttachments + summary: List of Private Link Attachments + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all private link attachments. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [prod-gcp-us-central1, prod-aws-useast1] + description: Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.cloud + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [GCP, AWS] + description: Filter the results by exact match for spec.cloud. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: spec.region + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [us-central1, us-east-1] + description: Filter the results by exact match for spec.region. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [PROVISIONING, READY] + description: Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Private Link Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Attachment. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1PrivateLinkAttachment + summary: Create a Private Link Attachment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a private link attachment. + tags: + - Private Link Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAttachment' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - cloud + - region + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + responses: + '202': + description: A Private Link Attachment is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/private-link-attachments/{id} + description: PrivateLinkAttachment resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAttachment' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - cloud + - region + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/private-link-attachments/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1PrivateLinkAttachment + summary: Read a Private Link Attachment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a private link attachment. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment. + tags: + - Private Link Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Attachment. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAttachment' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - cloud + - region + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1PrivateLinkAttachment + summary: Update a Private Link Attachment + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a private link attachment. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment. + tags: + - Private Link Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAttachment' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Private Link Attachment. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAttachment' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - cloud + - region + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1PrivateLinkAttachment + summary: Delete a Private Link Attachment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a private link attachment. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment. + tags: + - Private Link Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Private Link Attachment is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/private-link-attachment-connections: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1PrivateLinkAttachmentConnections + summary: List of Private Link Attachment Connections + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all private link attachment connections. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.private_link_attachment + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: platt-00000 + description: Filter the results by exact match for spec.private_link_attachment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Private Link Attachment Connections (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Attachment Connection. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + private_link_attachment: + example: + id: platt-00000 + related: https://api.confluent.cloud/networking/v1/private-link-attachments/platt-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/private-link-attachment=platt-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1PrivateLinkAttachmentConnection + summary: Create a Private Link Attachment Connection + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a private link attachment connection. + tags: + - Private Link Attachment Connections (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnection' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - cloud + - environment + - private_link_attachment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + private_link_attachment: + example: + id: platt-00000 + responses: + '202': + description: A Private Link Attachment Connection is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/private-link-attachment-connections/{id} + description: PrivateLinkAttachmentConnection resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnection' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - private_link_attachment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + private_link_attachment: + example: + id: platt-00000 + related: https://api.confluent.cloud/networking/v1/private-link-attachments/platt-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/private-link-attachment=platt-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/private-link-attachment-connections/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1PrivateLinkAttachmentConnection + summary: Read a Private Link Attachment Connection + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a private link attachment connection. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment connection. + tags: + - Private Link Attachment Connections (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Attachment Connection. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnection' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - private_link_attachment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + private_link_attachment: + example: + id: platt-00000 + related: https://api.confluent.cloud/networking/v1/private-link-attachments/platt-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/private-link-attachment=platt-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1PrivateLinkAttachmentConnection + summary: Update a Private Link Attachment Connection + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a private link attachment connection. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment connection. + tags: + - Private Link Attachment Connections (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnection' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Private Link Attachment Connection. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnection' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - private_link_attachment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + private_link_attachment: + example: + id: platt-00000 + related: https://api.confluent.cloud/networking/v1/private-link-attachments/platt-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/private-link-attachment=platt-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1PrivateLinkAttachmentConnection + summary: Delete a Private Link Attachment Connection + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a private link attachment connection. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment connection. + tags: + - Private Link Attachment Connections (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Private Link Attachment Connection is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/identity-providers: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2IdentityProviders + summary: List of Identity Providers + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all identity providers. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 255 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Identity Providers (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Identity Provider. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IdentityProviderList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2IdentityProvider + summary: Create an Identity Provider + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an identity provider. + tags: + - Identity Providers (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IdentityProvider' + - type: object + required: + - display_name + - description + - issuer + - jwks_uri + responses: + '201': + description: An Identity Provider was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/identity-providers/{id} + description: IdentityProvider resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IdentityProvider' + - type: object + required: + - display_name + - description + - issuer + - jwks_uri + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/identity-providers/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2IdentityProvider + summary: Read an Identity Provider + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an identity provider. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity provider. + tags: + - Identity Providers (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Identity Provider. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IdentityProvider' + - type: object + required: + - api_version + - kind + - id + - display_name + - description + - state + - issuer + - jwks_uri + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2IdentityProvider + summary: Update an Identity Provider + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an identity provider. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity provider. + tags: + - Identity Providers (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.IdentityProvider' + responses: + '200': + description: Identity Provider. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IdentityProvider' + - type: object + required: + - api_version + - kind + - id + - display_name + - description + - state + - issuer + - jwks_uri + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2IdentityProvider + summary: Delete an Identity Provider + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an identity provider. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity provider. + tags: + - Identity Providers (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Identity Provider is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/identity-providers/{provider_id}/jwks: + x-lifecycle-stage: General Availability + x-self-access: true + patch: + summary: Refresh a provider's JWKS + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to refresh the provider's JWKS + + x-lifecycle-stage: General Availability + x-self-access: true + operationId: refreshIamV2JsonWebKeySet + parameters: + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + tags: + - Jwks (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.Jwks' + responses: + '200': + description: Jwks. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.Jwks' + - type: object + required: + - api_version + - kind + - spec + properties: + spec: + type: object + required: + - jwks_status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/identity-providers/{provider_id}/identity-pools: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2IdentityPools + summary: List of Identity Pools + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all identity pools. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 255 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + tags: + - Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Identity Pool. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IdentityPoolList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2IdentityPool + summary: Create an Identity Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an identity pool. + parameters: + - name: assigned_resource_owner + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: u-a83k9b + description: The resource_id of the principal who will be assigned resource + owner on the created identity pool. Principal can be group-mapping (group-xxx), + user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx). + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + tags: + - Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IdentityPool' + - type: object + required: + - display_name + - description + - identity_claim + - filter + responses: + '201': + description: An Identity Pool was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools/{id} + description: IdentityPool resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IdentityPool' + - type: object + required: + - display_name + - description + - identity_claim + - filter + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/identity-providers/{provider_id}/identity-pools/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2IdentityPool + summary: Read an Identity Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an identity pool. + parameters: + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity pool. + tags: + - Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Identity Pool. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IdentityPool' + - type: object + required: + - api_version + - kind + - id + - display_name + - description + - identity_claim + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2IdentityPool + summary: Update an Identity Pool + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an identity pool. + + parameters: + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity pool. + tags: + - Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.IdentityPool' + responses: + '200': + description: Identity Pool. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.IdentityPool' + - type: object + required: + - api_version + - kind + - id + - display_name + - description + - identity_claim + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2IdentityPool + summary: Delete an Identity Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an identity pool. + parameters: + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity pool. + tags: + - Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Identity Pool is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /sts/v1/oauth2/token: + x-lifecycle-stage: General Availability + x-self-access: true + post: + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Use this operation to exchange an access token (JWT) issued by an external identity provider for + an access token (JWT) issued by Confluent.This enables the use of external identities + to access Confluent Cloud APIs. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + allOf: + - $ref: '#/components/schemas/sts.v1.TokenExchangeRequest' + - type: object + required: + - subject_token + - grant_type + - identity_pool_id + - subject_token_type + - requested_token_type + x-lifecycle-stage: General Availability + x-self-access: true + x-name: sts.v1.OauthToken + operationId: exchangeStsV1OauthToken + summary: Exchange an OAuth Token + tags: + - OAuth Tokens (sts/v1) + responses: + '200': + description: | + access token used to access public control plane api + content: + application/json: + schema: + $ref: '#/components/schemas/sts.v1.TokenExchangeReply' + '400': + $ref: '#/components/responses/BadRequestError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /kafka-quotas/v1/client-quotas: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listKafkaQuotasV1ClientQuotas + summary: List of Client Quotas + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all client quotas. + parameters: + - name: spec.cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-xxxxx + description: Filter the results by exact match for spec.cluster. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-xxxxx + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Client Quotas (kafka-quotas/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Client Quota. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + cluster: + example: + id: lkc-xxxxx + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-xxxxx + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-xxxxx + environment: + example: + - id: env-xxxxx + related: https://api.confluent.cloud/v2/environments/env-xxxxx + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-xxxxx + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + requestBody: + required: true + content: + application/json: + schema: + example: + spec: + display_name: QuotaForSA1 + description: This quota defines limits on how much the target principals + can use cluster lkc-xxxxx + throughput: + ingress_byte_rate: '5' + egress_byte_rate: '5' + cluster: + id: lkc-xxxxx + principals: + - id: sa-xxxxx + environment: + id: env-xxxxx + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createKafkaQuotasV1ClientQuota + summary: Create a Client Quota + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a client quota. + tags: + - Client Quotas (kafka-quotas/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '202': + description: A Client Quota is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/kafka-quotas/v1/client-quotas/{id} + description: ClientQuota resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/kafka-quotas.v1.ClientQuota' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - display_name + - throughput + - cluster + - principals + - environment + - type: object + properties: + spec: + type: object + properties: + cluster: + example: + id: lkc-xxxxx + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-xxxxx + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-xxxxx + environment: + example: + - id: env-xxxxx + related: https://api.confluent.cloud/v2/environments/env-xxxxx + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-xxxxx + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /kafka-quotas/v1/client-quotas/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getKafkaQuotasV1ClientQuota + summary: Read a Client Quota + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a client quota. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the client quota. + tags: + - Client Quotas (kafka-quotas/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Client Quota. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/kafka-quotas.v1.ClientQuota' + - type: object + required: + - api_version + - kind + - id + - spec + properties: + spec: + type: object + required: + - display_name + - throughput + - cluster + - principals + - environment + - type: object + properties: + spec: + type: object + properties: + cluster: + example: + id: lkc-xxxxx + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-xxxxx + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-xxxxx + environment: + example: + - id: env-xxxxx + related: https://api.confluent.cloud/v2/environments/env-xxxxx + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-xxxxx + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateKafkaQuotasV1ClientQuota + summary: Update a Client Quota + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a client quota. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the client quota. + tags: + - Client Quotas (kafka-quotas/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/kafka-quotas.v1.ClientQuota' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Client Quota. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/kafka-quotas.v1.ClientQuota' + - type: object + required: + - api_version + - kind + - id + - spec + properties: + spec: + type: object + required: + - display_name + - throughput + - cluster + - principals + - environment + - type: object + properties: + spec: + type: object + properties: + cluster: + example: + id: lkc-xxxxx + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-xxxxx + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-xxxxx + environment: + example: + - id: env-xxxxx + related: https://api.confluent.cloud/v2/environments/env-xxxxx + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-xxxxx + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteKafkaQuotasV1ClientQuota + summary: Delete a Client Quota + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a client quota. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the client quota. + tags: + - Client Quotas (kafka-quotas/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Client Quota is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /byok/v1/keys: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listByokV1Keys + summary: List of Keys + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all keys. + parameters: + - name: display_name + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: Key for billing cluster + description: Filter the results by a partial search of display_name. + - name: provider + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for provider. + - name: state + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: IN_USE + description: Filter the results by exact match for state. + - name: validation_phase + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + description: Filter the results by exact match for validation_phase. + - name: validation_region + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-west-2 + description: | + Filter keys by the cloud region where they are deployed. + - name: key + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: vault-name + description: | + Filters results by a partial match on the key identifier: key_arn for AWS, key_id for Azure and GCP. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Keys (byok/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Key. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/byok.v1.KeyList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createByokV1Key + summary: Create a Key + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a key. + tags: + - Keys (byok/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/byok.v1.Key' + - type: object + required: + - key + responses: + '201': + description: A Key was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/byok/v1/keys/{id} + description: Key resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/byok.v1.Key' + - type: object + required: + - key + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /byok/v1/keys/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getByokV1Key + summary: Read a Key + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a key. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the key. + tags: + - Keys (byok/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Key. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/byok.v1.Key' + - type: object + required: + - api_version + - kind + - id + - key + - provider + - state + - validation + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateByokV1Key + summary: Update a Key + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a key. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the key. + tags: + - Keys (byok/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/byok.v1.Key' + responses: + '200': + description: Key. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/byok.v1.Key' + - type: object + required: + - api_version + - kind + - id + - key + - provider + - state + - validation + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteByokV1Key + summary: Delete a Key + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a key. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the key. + tags: + - Keys (byok/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Key is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /billing/v1/costs: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listBillingV1Costs + summary: List of Costs + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all costs. + parameters: + - name: start_date + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: '2022-10-12' + description: Filter the results by exact match for start_date. + - name: end_date + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: '2022-10-15' + description: Filter the results by exact match for end_date. + - name: page_size + in: query + required: false + schema: + type: integer + default: 5000 + maximum: 10000 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Costs (billing/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cost. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/billing.v1.CostList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/sso/group-mappings: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2SsoGroupMappings + summary: List of Group Mappings + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all group mappings. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 255 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Group Mappings (iam/v2/sso) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Group Mapping. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.sso.GroupMappingList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2SsoGroupMapping + summary: Create a Group Mapping + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a group mapping. + tags: + - Group Mappings (iam/v2/sso) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.sso.GroupMapping' + - type: object + required: + - display_name + - description + - filter + responses: + '201': + description: A Group Mapping was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/sso/group-mappings/{id} + description: GroupMapping resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.sso.GroupMapping' + - type: object + required: + - display_name + - description + - filter + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/sso/group-mappings/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2SsoGroupMapping + summary: Read a Group Mapping + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a group mapping. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the group mapping. + tags: + - Group Mappings (iam/v2/sso) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Group Mapping. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.sso.GroupMapping' + - type: object + required: + - api_version + - kind + - id + - display_name + - description + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2SsoGroupMapping + summary: Update a Group Mapping + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a group mapping. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the group mapping. + tags: + - Group Mappings (iam/v2/sso) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.sso.GroupMapping' + responses: + '200': + description: Group Mapping. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.sso.GroupMapping' + - type: object + required: + - api_version + - kind + - id + - display_name + - description + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2SsoGroupMapping + summary: Delete a Group Mapping + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a group mapping. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the group mapping. + tags: + - Group Mappings (iam/v2/sso) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Group Mapping is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /fcpm/v2/compute-pools: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listFcpmV2ComputePools + summary: List of Compute Pools + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all compute pools. + parameters: + - name: spec.region + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-west-1 + description: Filter the results by exact match for spec.region. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: n-00000 + description: Filter the results by exact match for spec.network. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Compute Pools (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Compute Pool. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/fcpm.v2.ComputePoolList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createFcpmV2ComputePool + summary: Create a Compute Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a compute pool. + tags: + - Compute Pools (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/fcpm.v2.ComputePool' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - display_name + - cloud + - region + - max_cfu + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + network: + example: + id: n-00000 + responses: + '202': + description: A Compute Pool is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/fcpm/v2/compute-pools/{id} + description: ComputePool resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/fcpm.v2.ComputePool' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - display_name + - cloud + - region + - max_cfu + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /fcpm/v2/compute-pools/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getFcpmV2ComputePool + summary: Read a Compute Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a compute pool. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the compute pool. + tags: + - Compute Pools (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Compute Pool. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/fcpm.v2.ComputePool' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - display_name + - cloud + - region + - max_cfu + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateFcpmV2ComputePool + summary: Update a Compute Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a compute pool. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the compute pool. + tags: + - Compute Pools (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/fcpm.v2.ComputePool' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Compute Pool. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/fcpm.v2.ComputePool' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - display_name + - cloud + - region + - max_cfu + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + network: + example: + id: n-00000 + related: https://api.confluent.cloud/networking/v1/networks/n-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteFcpmV2ComputePool + summary: Delete a Compute Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a compute pool. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the compute pool. + tags: + - Compute Pools (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Compute Pool is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /fcpm/v2/regions: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listFcpmV2Regions + summary: List of Regions + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all regions. + parameters: + - name: cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for cloud. + - name: region_name + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-2 + description: Filter the results by exact match for region_name. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Regions (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Region. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/fcpm.v2.RegionList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /fcpm/v2/compute-pool-config: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getFcpmV2OrgComputePoolConfig + summary: Read an Org Compute Pool Config + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an org compute pool config. + tags: + - Org Compute Pool Configs (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Org Compute Pool Config. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/fcpm.v2.OrgComputePoolConfig' + - type: object + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateFcpmV2OrgComputePoolConfig + summary: Update an Org Compute Pool Config + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an org compute pool config. + tags: + - Org Compute Pool Configs (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/fcpm.v2.OrgComputePoolConfig' + responses: + '200': + description: Org Compute Pool Config. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/fcpm.v2.OrgComputePoolConfig' + - type: object + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /sql/v1/organizations/{organization_id}/environments/{environment_id}/connections: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + get: + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1Connections + summary: List of Connections + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered and paginated list of all Connections. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: spec.connection_type + in: query + required: false + schema: + type: string + x-extensible-enum: [AZUREML, AZUREOPENAI, A2A, ANTHROPIC, BEDROCK, CONFLUENT_JDBC, + COSMOSDB, COUCHBASE, ELASTIC, FIREWORKSAI, GOOGLEAI, MCP_SERVER, MONGODB, + OPENAI, PINECONE, REST, S3VECTORS, SAGEMAKER, VERTEXAI] + description: Filter the results by exact match for spec.connection_type + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Connections (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Connections. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.ConnectionList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Preview + x-self-access: false + x-request-access-name: SQL API v1 + operationId: createSqlv1Connection + summary: Create a Connection + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a Connection. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + tags: + - Connections (sql/v1) + security: + - resource-api-key: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.Connection' + - type: object + required: + - spec + - name + properties: + spec: + type: object + required: + - endpoint + - connection_type + - auth_data + + responses: + '201': + description: A Connection has been successfully created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{name} + description: Connection resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.Connection' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - endpoint + - connection_type + - auth_data + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + + /sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + get: + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1Connection + summary: Read a Connection + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a Connection. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: connection_name + in: path + required: true + schema: + type: string + description: The user provided name of the Connection. Unique within a region + within an org and env. + tags: + - Connections (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Connection. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.Connection' + - type: object + required: + - api_version + - kind + - metadata + - spec + properties: + spec: + type: object + required: + - connection_type + - endpoint + - auth_data + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Preview + x-self-access: false + x-request-access-name: SQL API v1 + operationId: deleteSqlv1Connection + summary: Delete a Connection + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a statement. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: connection_name + in: path + required: true + schema: + type: string + description: The unique identifier for the connection. + tags: + - Connections (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: A Connection has been deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + x-lifecycle-stage: Preview + x-self-access: false + x-request-access-name: SQL API v1 + operationId: updateSqlv1Connection + summary: Update a Connection + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a connection. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: connection_name + in: path + required: true + schema: + type: string + description: The unique identifier for the connection. + tags: + - Connections (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: A Connection has been updated. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.Connection' + - type: object + required: + - spec + - name + - metadata + properties: + spec: + type: object + required: + - auth_data + metadata: + type: object + required: + - resource_version + + # Statement Results API + /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name}/results: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1StatementResult + summary: Read Statement Result + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Read Statement Result. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: It contains the field offset in the CollectSinkFunction protocol. + On the first request, it should be unset. The offset is assumed to start + at 0. + tags: + - Statement Results (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: Statement Result. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.StatementResult' + - type: object + required: + - api_version + - kind + - metadata + - results + properties: + results: + type: object + required: + - data + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + + # Statements API + /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1Statements + summary: List of Statements + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all statements. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: spec.compute_pool_id + in: query + required: false + schema: + type: string + example: lfcp-00000 + description: |- + Filter the results by exact match for spec.compute_pool_id. + When creating statements, if compute_pool_id is not specified, the statement will use the default compute pool. The default pool is automatically determined by the system. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + - name: label_selector + in: query + required: false + schema: + type: string + style: form + explode: false + description: A comma-separated label selector to filter the statements. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: Statements. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.StatementList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: createSqlv1Statement + summary: Create a Statement + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a statement. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.Statement' + - type: object + required: + - spec + - name + properties: + spec: + type: object + required: + - statement + + responses: + '201': + description: A Statement is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name} + description: Statement resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.Statement' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - statement_name + - statement + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1Statement + summary: Read a Statement + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a statement. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: statement_name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: Statement. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.Statement' + - type: object + required: + - api_version + - kind + - metadata + - spec + - status + properties: + spec: + type: object + required: + - statement_name + - statement + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: deleteSqlv1Statement + summary: Delete a Statement + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a statement. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: statement_name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '202': + description: A Statement is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: updateSqlv1Statement + summary: Update a Statement + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a statement. + The request will fail with a 409 Conflict error if the Statement has changed since it was fetched. + In this case, do a GET, reapply the modifications, and try the update again. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: statement_name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '202': + description: A Statement is being updated. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.Statement' + - type: object + required: + - spec + - name + - metadata + properties: + spec: + type: object + required: + - stopped + metadata: + type: object + required: + - resource_version + patch: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: patchSqlv1Statement + summary: Patch a Statement + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to patch a statement. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: statement_name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/PatchRequest' + responses: + '200': + description: Patched Statement. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.Statement' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - statement_name + - statement + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + + # Exceptions API + /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}/exceptions: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1StatementExceptions + summary: List of Statement Exceptions + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a list of the 10 most recent statement exceptions. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: statement_name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + tags: + - Statement Exceptions (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: Statement Exceptions. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.StatementExceptionList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + + # List Materialized Tables + /sql/v1/organizations/{organization_id}/environments/{environment_id}/materialized-tables: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1MaterializedTables + summary: List all materialized tables + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted and paginated list of all materialized tables. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: page_size + in: query + required: false + schema: + type: integer + format: int32 + default: 10 + maximum: 100 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Materialized Tables (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: A list of Materialized Tables. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.MaterializedTableList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + + # Create a materialized table + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + post: + x-lifecycle-stage: General Availability + operationId: createSqlv1MaterializedTable + summary: Create a materialized table + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Create a new Materialized Table. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + tags: + - Materialized Tables (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + required: true + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.MaterializedTable' + - type: object + required: + - name + - spec + properties: + spec: + type: object + required: + - query + - kafka_cluster_id + responses: + '201': + description: Materialized Table is being created + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name} + description: Materialized Table uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.MaterializedTable' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - query + - compute_pool_id + - principal + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + # Get, Update, and Delete a specific Materialized Table + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + get: + x-lifecycle-stage: General Availability + operationId: getSqlv1MaterializedTable + summary: Read a materialized table + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a specific Materialized Table by name. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: table_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Materialized Table + tags: + - Materialized Tables (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: The requested Materialized Table. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.MaterializedTable' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + x-lifecycle-stage: General Availability + operationId: updateSqlv1MaterializedTable + summary: Update/Evolve a materialized table + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a Materialized Table's mutable fields. + Mutable fields include: `query`, `stopped`, `compute_pool_id`, `principal`, `columns`, `watermark`, `constraints` and `table_options`. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: table_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Materialized Table + tags: + - Materialized Tables (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + description: The Materialized Table resource with updated spec fields. + required: true + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.MaterializedTable' + - type: object + required: + - spec + - name + - metadata + properties: + spec: + type: object + required: + - kafka_cluster_id + metadata: + type: object + required: + - resource_version + responses: + '200': + description: Materialized Table update accepted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.MaterializedTable' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + operationId: deleteSqlv1MaterializedTable + summary: Delete a materialized table + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete a specific Materialized Table by name. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: table_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Materialized Table + tags: + - Materialized Tables (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '202': + description: A Materialized Table is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + + # Materialized Table Versions API + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1MaterializedTableVersions + summary: List all the versions of a materialized table + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted and paginated list of all versions for a specific Materialized Table. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - in: path + name: table_name + required: true + schema: + type: string + description: The unique identifier for the Materialized Table. + - name: page_size + in: query + required: false + schema: + type: integer + format: int32 + default: 10 + maximum: 100 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Materialized Table Versions (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: A list of Materialized Table Versions. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.MaterializedTableVersionList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions/{version}: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1MaterializedTableVersion + summary: Read a materialized table version + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a specific version of a Materialized Table. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - in: path + name: table_name + required: true + schema: + type: string + description: The unique identifier for the Materialized Table. + - in: path + name: version + required: true + schema: + type: integer + format: int32 + minimum: 1 + description: The version number of the Materialized Table. + tags: + - Materialized Table Versions (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: The requested Materialized Table Version. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.MaterializedTableVersion' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + # List Agents + /sql/v1/organizations/{organization_id}/environments/{environment_id}/agents: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + get: + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1Agents + summary: List all agents + description: | + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted and paginated list of all agents. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: page_size + in: query + required: false + schema: + type: integer + format: int32 + default: 10 + maximum: 100 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Agents (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: A list of Agents. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.AgentList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + + # Create an agent + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + post: + x-lifecycle-stage: Preview + operationId: createSqlv1Agent + summary: Create an Agent + description: | + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an Agent. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + tags: + - Agents (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.Agent' + - type: object + required: + - name + - spec + properties: + spec: + type: object + required: + - model + - prompt + responses: + '200': + description: Agent. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name} + description: Agent uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.Agent' + - type: object + required: + - name + - spec + properties: + spec: + type: object + required: + - model + - prompt + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + # Get, Update, and Delete a specific Agent + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name}: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + get: + x-lifecycle-stage: Preview + operationId: getSqlv1Agent + summary: Read an Agent + description: | + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a specific Agent by name. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: agent_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Agent + tags: + - Agents (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: The requested Agent. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.Agent' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + x-lifecycle-stage: Preview + operationId: updateSqlv1Agent + summary: Alter an Agent + description: | + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an Agent's mutable fields. + Mutable fields include: `description`, `model`, `prompt`, and `properties`. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: agent_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Agent + tags: + - Agents (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + description: The Agent resource with updated spec fields. + required: true + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.Agent' + - type: object + required: + - spec + - name + - metadata + properties: + metadata: + type: object + required: + - resource_version + responses: + '200': + description: Agent has been updated. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.Agent' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Preview + operationId: deleteSqlv1Agent + summary: Delete an Agent + description: | + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91)](#section/Versioning/API-Lifecycle-Policy) + + Delete a specific Agent by name. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: agent_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Agent + tags: + - Agents (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: A Agent has been deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + + + # Tools API + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + post: + x-lifecycle-stage: Preview + x-self-access: false + x-request-access-name: SQL API v1 + operationId: createSqlv1Tool + summary: Create a Tool + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a Tool. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: database_name + required: true + schema: + type: string + description: The name of the database. + tags: + - Tools (sql/v1) + security: + - resource-api-key: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.Tool' + - type: object + required: + - name + - spec + + responses: + '200': + description: A Tool has been successfully created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools/{name} + description: Tool resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.Tool' + - type: object + required: + - name + - spec + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + get: + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1Tools + summary: List of Tools + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all Tools. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: database_name + required: true + schema: + type: string + description: The name of the database. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Tools (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Tools. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.ToolList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools/{tool_name}: + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + get: + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1Tool + summary: Read a Tool + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a Tool. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: database_name + in: path + required: true + schema: + type: string + description: The name of the database. + - name: tool_name + in: path + required: true + schema: + type: string + description: The user provided name of the Tool. + tags: + - Tools (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Tool. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/sql.v1.Tool' + - type: object + required: + - api_version + - kind + - metadata + - name + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Preview + x-self-access: false + x-request-access-name: SQL API v1 + operationId: deleteSqlv1Tool + summary: Delete a Tool + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a Tool. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: database_name + in: path + required: true + schema: + type: string + description: The name of the database. + - name: tool_name + in: path + required: true + schema: + type: string + description: The user provided name of the Tool. + tags: + - Tools (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: A Tool has been deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + + /networking/v1/dns-forwarders: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1DnsForwarders + summary: List of DNS Forwarders + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all DNS forwarders. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - DNS Forwarders (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: DNS Forwarder. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.DnsForwarderList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + gateway: + example: + id: gw-00000 + related: https://api.confluent.cloud/networking/v1/gateways/gw-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1DnsForwarder + summary: Create a DNS Forwarder + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a DNS forwarder. + tags: + - DNS Forwarders (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.DnsForwarder' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - domains + - config + - environment + - gateway + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + gateway: + example: + id: gw-00000 + responses: + '202': + description: A DNS Forwarder is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/dns-forwarders/{id} + description: DnsForwarder resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.DnsForwarder' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - domains + - config + - environment + - gateway + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + gateway: + example: + id: gw-00000 + related: https://api.confluent.cloud/networking/v1/gateways/gw-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/dns-forwarders/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1DnsForwarder + summary: Read a DNS Forwarder + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a DNS forwarder. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS forwarder. + tags: + - DNS Forwarders (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: DNS Forwarder. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.DnsForwarder' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - domains + - config + - environment + - gateway + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + gateway: + example: + id: gw-00000 + related: https://api.confluent.cloud/networking/v1/gateways/gw-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1DnsForwarder + summary: Update a DNS Forwarder + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a DNS forwarder. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS forwarder. + tags: + - DNS Forwarders (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.DnsForwarder' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: DNS Forwarder. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.DnsForwarder' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - domains + - config + - environment + - gateway + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + gateway: + example: + id: gw-00000 + related: https://api.confluent.cloud/networking/v1/gateways/gw-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1DnsForwarder + summary: Delete a DNS Forwarder + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a DNS forwarder. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS forwarder. + tags: + - DNS Forwarders (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A DNS Forwarder is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/access-points: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1AccessPoints + summary: List of Access Points + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all access points. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [prod-ap-egress-use1, prod-ap-egress-usw2] + description: Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.gateway + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [gw-00000, gw-00001] + description: Filter the results by exact match for spec.gateway. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: id + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [ap-1, ap-2] + description: Filter the results by exact match for id. Pass multiple times + to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Access Points (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Access Point. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.AccessPointList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + gateway: + example: + id: gw-00000 + related: https://api.confluent.cloud/networking/v1/gateways/gw-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1AccessPoint + summary: Create an Access Point + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an access point. + tags: + - Access Points (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.AccessPoint' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - config + - environment + - gateway + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + gateway: + example: + id: gw-00000 + responses: + '202': + description: An Access Point is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/access-points/{id} + description: AccessPoint resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.AccessPoint' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - config + - environment + - gateway + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + gateway: + example: + id: gw-00000 + related: https://api.confluent.cloud/networking/v1/gateways/gw-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/access-points/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1AccessPoint + summary: Read an Access Point + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an access point. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the access point. + tags: + - Access Points (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Access Point. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.AccessPoint' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - config + - environment + - gateway + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + gateway: + example: + id: gw-00000 + related: https://api.confluent.cloud/networking/v1/gateways/gw-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1AccessPoint + summary: Update an Access Point + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an access point. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the access point. + tags: + - Access Points (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.AccessPoint' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Access Point. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.AccessPoint' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - config + - environment + - gateway + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + gateway: + example: + id: gw-00000 + related: https://api.confluent.cloud/networking/v1/gateways/gw-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1AccessPoint + summary: Delete an Access Point + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an access point. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the access point. + tags: + - Access Points (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Access Point is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/dns-records: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1DnsRecords + summary: List of DNS Records + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all DNS records. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [prod-dnsrec-1, prod-dnsrec-2] + description: Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.domain + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [example.com, example2.com] + description: Filter the results by exact match for spec.domain. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.gateway + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [gw-00000, gw-00001] + description: Filter the results by exact match for spec.gateway. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: resource + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [ap-11111, ap-22222] + description: Filter the results by exact match for resource. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - DNS Records (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: DNS Record. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.DnsRecordList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + gateway: + example: + id: gw-00000 + related: https://api.confluent.cloud/networking/v1/gateways/gw-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1DnsRecord + summary: Create a DNS Record + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a DNS record. + tags: + - DNS Records (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.DnsRecord' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - domain + - config + - environment + - gateway + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + gateway: + example: + id: gw-00000 + responses: + '202': + description: A DNS Record is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/dns-records/{id} + description: DnsRecord resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.DnsRecord' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - domain + - config + - environment + - gateway + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + gateway: + example: + id: gw-00000 + related: https://api.confluent.cloud/networking/v1/gateways/gw-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/dns-records/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1DnsRecord + summary: Read a DNS Record + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a DNS record. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS record. + tags: + - DNS Records (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: DNS Record. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.DnsRecord' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - domain + - config + - environment + - gateway + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + gateway: + example: + id: gw-00000 + related: https://api.confluent.cloud/networking/v1/gateways/gw-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1DnsRecord + summary: Update a DNS Record + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a DNS record. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS record. + tags: + - DNS Records (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.DnsRecord' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: DNS Record. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.DnsRecord' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - domain + - config + - environment + - gateway + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + gateway: + example: + id: gw-00000 + related: https://api.confluent.cloud/networking/v1/gateways/gw-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1DnsRecord + summary: Delete a DNS Record + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a DNS record. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS record. + tags: + - DNS Records (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A DNS Record is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/certificate-authorities: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2CertificateAuthorities + summary: List of Certificate Authorities + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all certificate authorities. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 255 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Certificate Authorities (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Certificate Authority. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.CertificateAuthorityList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.CreateCertRequest' + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2CertificateAuthority + summary: Create a Certificate Authority + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a certificate authority. + tags: + - Certificate Authorities (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '201': + description: A Certificate Authority was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/certificate-authorities/{id} + description: CertificateAuthority resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.CertificateAuthority' + - type: object + required: + - display_name + - description + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/certificate-authorities/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2CertificateAuthority + summary: Read a Certificate Authority + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a certificate authority. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate authority. + tags: + - Certificate Authorities (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Certificate Authority. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.CertificateAuthority' + - type: object + required: + - api_version + - kind + - id + - display_name + - description + - fingerprints + - expiration_dates + - serial_numbers + - certificate_chain_filename + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.UpdateCertRequest' + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2CertificateAuthority + summary: Update a Certificate Authority + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a certificate authority. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate authority. + tags: + - Certificate Authorities (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Certificate Authority. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.CertificateAuthority' + - type: object + required: + - api_version + - kind + - id + - display_name + - description + - fingerprints + - expiration_dates + - serial_numbers + - certificate_chain_filename + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2CertificateAuthority + summary: Delete a Certificate Authority + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a certificate authority. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate authority. + tags: + - Certificate Authorities (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: A Certificate Authority is being deleted. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.CertificateAuthority' + - type: object + required: + - api_version + - kind + - id + - display_name + - description + - fingerprints + - expiration_dates + - serial_numbers + - certificate_chain_filename + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2CertificateIdentityPools + summary: List of Certificate Identity Pools + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all certificate identity pools. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 255 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + - name: certificate_authority_id + in: path + required: true + schema: + type: string + description: The Certificate Authority + tags: + - Certificate Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Certificate Identity Pool. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.CertificateIdentityPoolList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2CertificateIdentityPool + summary: Create a Certificate Identity Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a certificate identity pool. + parameters: + - name: assigned_resource_owner + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: u-a83k9b + description: The resource_id of the principal who will be assigned resource + owner on the created certificate identity pool. Principal can be group-mapping + (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx). + - name: certificate_authority_id + in: path + required: true + schema: + type: string + description: The Certificate Authority + tags: + - Certificate Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.CertificateIdentityPool' + - type: object + required: + - display_name + - description + - external_identifier + - filter + responses: + '201': + description: A Certificate Identity Pool was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id} + description: CertificateIdentityPool resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.CertificateIdentityPool' + - type: object + required: + - display_name + - description + - external_identifier + - filter + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2CertificateIdentityPool + summary: Read a Certificate Identity Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a certificate identity pool. + parameters: + - name: certificate_authority_id + in: path + required: true + schema: + type: string + description: The Certificate Authority + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate identity pool. + tags: + - Certificate Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Certificate Identity Pool. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.CertificateIdentityPool' + - type: object + required: + - api_version + - kind + - id + - display_name + - description + - external_identifier + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2CertificateIdentityPool + summary: Update a Certificate Identity Pool + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a certificate identity pool. + + parameters: + - name: certificate_authority_id + in: path + required: true + schema: + type: string + description: The Certificate Authority + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate identity pool. + tags: + - Certificate Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.CertificateIdentityPool' + responses: + '200': + description: Certificate Identity Pool. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.CertificateIdentityPool' + - type: object + required: + - api_version + - kind + - id + - display_name + - description + - external_identifier + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2CertificateIdentityPool + summary: Delete a Certificate Identity Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a certificate identity pool. + parameters: + - name: certificate_authority_id + in: path + required: true + schema: + type: string + description: The Certificate Authority + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate identity pool. + tags: + - Certificate Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: A Certificate Identity Pool is being deleted. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/iam.v2.CertificateIdentityPool' + - type: object + required: + - api_version + - kind + - id + - display_name + - description + - external_identifier + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /pim/v1/integrations: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listPimV1Integrations + summary: List of Integrations + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all integrations. + + If no `provider` filter is specified, returns provider integrations from all clouds. + parameters: + - name: provider + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for provider. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Integrations (pim/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/pim.v1.IntegrationList' + - type: object + properties: + data: + type: array + items: + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createPimV1Integration + summary: Create an Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an integration. + tags: + - Integrations (pim/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/pim.v1.Integration' + - type: object + required: + - config + - environment + - type: object + properties: + environment: + example: + id: env-00000 + responses: + '201': + description: An Integration was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/pim/v1/integrations/{id} + description: Integration resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/pim.v1.Integration' + - type: object + required: + - config + - environment + - type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /pim/v1/integrations/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getPimV1Integration + summary: Read an Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (pim/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/pim.v1.Integration' + - type: object + required: + - api_version + - kind + - id + - config + - environment + - type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deletePimV1Integration + summary: Delete an Integration + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an integration. + + This request fails if existing workloads are using this CSP integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (pim/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Integration is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /pim/v2/integrations: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + get: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + operationId: listPimV2Integrations + summary: List of Integrations + description: | + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Retrieve a sorted, filtered, paginated list of all integrations. + + If no `provider` filter is specified, returns provider integrations from all clouds. + parameters: + - name: display_name + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: bigquery_provider_integration + description: Filter the results by a partial search of display_name. + - name: provider + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: GCP + description: Filter the results by exact match for provider. + - name: status + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: CREATED + description: Filter the results by exact match for status. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/pim.v2.IntegrationList' + - type: object + properties: + data: + type: array + items: + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + operationId: createPimV2Integration + summary: Create an Integration + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to create an integration. + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/pim.v2.Integration' + - type: object + required: + - environment + - type: object + properties: + environment: + example: + id: env-00000 + responses: + '201': + description: An Integration was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/pim/v2/integrations/{id} + description: Integration resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/pim.v2.Integration' + - type: object + required: + - status + - environment + - type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /pim/v2/integrations/{id}: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + get: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + operationId: getPimV2Integration + summary: Read an Integration + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to read an integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/pim.v2.Integration' + - type: object + required: + - api_version + - kind + - id + - status + - environment + - type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + operationId: updatePimV2Integration + summary: Update an Integration + description: |+ + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to update an integration. + + This request only works for integrations with `DRAFT` status. + + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/pim.v2.Integration' + - type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Integration. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/pim.v2.Integration' + - type: object + required: + - api_version + - kind + - id + - status + - environment + - type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + operationId: deletePimV2Integration + summary: Delete an Integration + description: | + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to delete an integration. + + This request fails if existing workloads are using this CSP integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Integration is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /pim/v2/integrations:validate: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + post: + description: | + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Validate the provider integration configuration. + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/pim.v2.IntegrationValidateRequest' + - type: object + required: + - id + - environment + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + x-name: pim.v2.Integration + operationId: validatePimV2Integration + summary: Validate an Integration + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: The provider integration configuration is validated successfully. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /artifact/v1/flink-artifacts: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listArtifactV1FlinkArtifacts + summary: List of Flink Artifacts + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all flink artifacts. + parameters: + - name: cloud + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for cloud. + - name: region + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-1 + description: Filter the results by exact match for region. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Flink Artifacts (artifact/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Flink Artifact. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/artifact.v1.FlinkArtifactList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + summary: Create a new Flink Artifact. + requestBody: + content: + application/json: + schema: + type: object + properties: + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is + uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: [AWS, GCP, AZURE] + region: + type: string + description: The Cloud provider region the Flink Artifact archive + is uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: Unique name of the Flink Artifact per cloud, region, + environment scope. + maxLength: 60 + class: + type: string + description: Java class or alias for the artifact as provided by + developer. Deprecated + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: [ZIP, JAR] + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: [JAVA, PYTHON] + upload_source: + type: object + description: Upload source of the Flink Artifact source. + oneOf: + - $ref: '#/components/schemas/artifact.v1.UploadSource.PresignedUrl' + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/artifact.v1.UploadSource.PresignedUrl' + required: + - cloud + - region + - environment + - display_name + - upload_source + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createArtifactV1FlinkArtifact + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a flink artifact. + parameters: + - name: cloud + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Scope the operation to the given cloud. + - name: region + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-1 + description: Scope the operation to the given region. + tags: + - Flink Artifacts (artifact/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '201': + description: A Flink Artifact was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/artifact/v1/flink-artifacts/{id} + description: FlinkArtifact resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/artifact.v1.FlinkArtifact' + - type: object + required: + - cloud + - region + - environment + - display_name + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /artifact/v1/flink-artifacts/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getArtifactV1FlinkArtifact + summary: Read a Flink Artifact + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a flink artifact. + parameters: + - name: cloud + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Scope the operation to the given cloud. + - name: region + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-1 + description: Scope the operation to the given region. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the flink artifact. + tags: + - Flink Artifacts (artifact/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Flink Artifact. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/artifact.v1.FlinkArtifact' + - type: object + required: + - api_version + - kind + - id + - cloud + - region + - environment + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateArtifactV1FlinkArtifact + summary: Update a Flink Artifact + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a flink artifact. + + parameters: + - name: cloud + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Scope the operation to the given cloud. + - name: region + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-1 + description: Scope the operation to the given region. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the flink artifact. + tags: + - Flink Artifacts (artifact/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/artifact.v1.FlinkArtifact' + responses: + '200': + description: Flink Artifact. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/artifact.v1.FlinkArtifact' + - type: object + required: + - api_version + - kind + - id + - cloud + - region + - environment + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteArtifactV1FlinkArtifact + summary: Delete a Flink Artifact + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a flink artifact. + parameters: + - name: cloud + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Scope the operation to the given cloud. + - name: region + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-1 + description: Scope the operation to the given region. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the flink artifact. + tags: + - Flink Artifacts (artifact/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Flink Artifact is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /artifact/v1/presigned-upload-url: + x-lifecycle-stage: General Availability + x-self-access: true + post: + summary: Request a presigned upload URL for a new Flink Artifact. + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Request a presigned upload URL to upload a Flink Artifact archive. + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/artifact.v1.PresignedUrlRequest' + - type: object + required: + - content_format + - cloud + - region + - environment + x-lifecycle-stage: General Availability + x-self-access: true + x-name: artifact.v1.PresignedUrl + operationId: presigned-upload-urlArtifactV1PresignedUrl + tags: + - Presigned Urls (artifact/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Presigned Url. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/artifact.v1.PresignedUrl' + - type: object + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/gateways: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1Gateways + summary: List of Gateways + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all gateways. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: gateway_type + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [AwsEgressPrivateLink, AzureEgressPrivateLink] + description: Filter the results by exact match for gateway_type. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: id + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [gw-1, gw-2] + description: Filter the results by exact match for id. Pass multiple times + to see results matching any of the values. + style: form + explode: true + - name: spec.config.region + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [us-east-1, us-west-2] + description: Filter the results by exact match for spec.config.region. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [prod-gateway-ingress-use1, prod-gateway-ingress-use2] + description: Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [PROVISIONING, READY] + description: Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Gateways (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Gateway. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.GatewayList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1Gateway + summary: Create a Gateway + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a gateway. + tags: + - Gateways (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.Gateway' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - config + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + responses: + '202': + description: A Gateway is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/gateways/{id} + description: Gateway resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.Gateway' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - config + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /networking/v1/gateways/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1Gateway + summary: Read a Gateway + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a gateway. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the gateway. + tags: + - Gateways (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Gateway. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.Gateway' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - config + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1Gateway + summary: Update a Gateway + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a gateway. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the gateway. + tags: + - Gateways (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.Gateway' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Gateway. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/networking.v1.Gateway' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - config + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1Gateway + summary: Delete a Gateway + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a gateway. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the gateway. + tags: + - Gateways (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Gateway is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /ccl/v1/custom-code-loggings: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + get: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + operationId: listCclV1CustomCodeLoggings + summary: List of Custom Code Loggings + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Custom Code Logging API EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Retrieve a sorted, filtered, paginated list of all custom code loggings. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Custom Code Loggings (ccl/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Code Logging. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccl.v1.CustomCodeLoggingList' + - type: object + properties: + data: + type: array + items: + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + operationId: createCclV1CustomCodeLogging + summary: Create a Custom Code Logging + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Custom Code Logging API EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to create a custom code logging. + tags: + - Custom Code Loggings (ccl/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccl.v1.CustomCodeLogging' + - type: object + required: + - cloud + - region + - destination_settings + - environment + - type: object + properties: + environment: + example: + id: env-00000 + responses: + '201': + description: A Custom Code Logging was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/ccl/v1/custom-code-loggings/{id} + description: CustomCodeLogging resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccl.v1.CustomCodeLogging' + - type: object + required: + - cloud + - region + - destination_settings + - environment + - type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /ccl/v1/custom-code-loggings/{id}: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + get: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + operationId: getCclV1CustomCodeLogging + summary: Read a Custom Code Logging + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Custom Code Logging API EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to read a custom code logging. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom code logging. + tags: + - Custom Code Loggings (ccl/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Code Logging. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccl.v1.CustomCodeLogging' + - type: object + required: + - api_version + - kind + - id + - cloud + - region + - destination_settings + - environment + - type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + operationId: updateCclV1CustomCodeLogging + summary: Update a Custom Code Logging + description: |+ + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Custom Code Logging API EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to update a custom code logging. + + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom code logging. + tags: + - Custom Code Loggings (ccl/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccl.v1.CustomCodeLogging' + - type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Custom Code Logging. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccl.v1.CustomCodeLogging' + - type: object + required: + - api_version + - kind + - id + - cloud + - region + - destination_settings + - environment + - type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + operationId: deleteCclV1CustomCodeLogging + summary: Delete a Custom Code Logging + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Custom Code Logging API EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to delete a custom code logging. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom code logging. + tags: + - Custom Code Loggings (ccl/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Custom Code Logging is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /tableflow/v1/regions: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listTableflowV1Regions + summary: List of Regions + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all regions. + parameters: + - name: cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for cloud. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Regions (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Region. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/tableflow.v1.RegionList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /tableflow/v1/tableflow-topics: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listTableflowV1TableflowTopics + summary: List of Tableflow Topics + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all tableflow topics. + parameters: + - name: spec.table_formats + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: [DELTA, ICEBERG] + description: Filter the results by exact match for spec.table_formats. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Filter the results by exact match for spec.kafka_cluster. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Tableflow Topics (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Tableflow Topic. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/tableflow.v1.TableflowTopicList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + kafka_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createTableflowV1TableflowTopic + summary: Create a Tableflow Topic + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a tableflow topic. + tags: + - Tableflow Topics (tableflow/v1) + security: + - resource-api-key: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/tableflow.v1.TableflowTopic' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - display_name + - storage + - environment + - kafka_cluster + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + kafka_cluster: + example: + id: lkc-00000 + responses: + '202': + description: A Tableflow Topic is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/tableflow/v1/tableflow-topics/{id} + description: TableflowTopic resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/tableflow.v1.TableflowTopic' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - display_name + - storage + - environment + - kafka_cluster + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + kafka_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /tableflow/v1/tableflow-topics/{display_name}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getTableflowV1TableflowTopic + summary: Read a Tableflow Topic + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a tableflow topic. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Scope the operation to the given spec.kafka_cluster. + - name: display_name + in: path + required: true + schema: + type: string + description: The name of the Kafka topic for which Tableflow is enabled. + tags: + - Tableflow Topics (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Tableflow Topic. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/tableflow.v1.TableflowTopic' + - type: object + required: + - api_version + - kind + - spec + - status + properties: + spec: + type: object + required: + - display_name + - storage + - environment + - kafka_cluster + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + kafka_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateTableflowV1TableflowTopic + summary: Update a Tableflow Topic + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a tableflow topic. + + parameters: + - name: display_name + in: path + required: true + schema: + type: string + description: The name of the Kafka topic for which Tableflow is enabled. + tags: + - Tableflow Topics (tableflow/v1) + security: + - resource-api-key: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/tableflow.v1.TableflowTopic' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Tableflow Topic. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/tableflow.v1.TableflowTopic' + - type: object + required: + - api_version + - kind + - spec + - status + properties: + spec: + type: object + required: + - display_name + - storage + - environment + - kafka_cluster + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + kafka_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteTableflowV1TableflowTopic + summary: Delete a Tableflow Topic + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a tableflow topic. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Scope the operation to the given spec.kafka_cluster. + - name: display_name + in: path + required: true + schema: + type: string + description: The name of the Kafka topic for which Tableflow is enabled. + tags: + - Tableflow Topics (tableflow/v1) + security: + - resource-api-key: [] + responses: + '204': + description: A Tableflow Topic is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /tableflow/v1/catalog-integrations: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listTableflowV1CatalogIntegrations + summary: List of Catalog Integrations + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all catalog integrations. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Filter the results by exact match for spec.kafka_cluster. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Catalog Integrations (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Catalog Integration. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + kafka_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createTableflowV1CatalogIntegration + summary: Create a Catalog Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a catalog integration. + tags: + - Catalog Integrations (tableflow/v1) + security: + - resource-api-key: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/tableflow.v1.CatalogIntegration' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - display_name + - config + - environment + - kafka_cluster + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + kafka_cluster: + example: + id: lkc-00000 + responses: + '202': + description: A Catalog Integration is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/tableflow/v1/catalog-integrations/{id} + description: CatalogIntegration resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/tableflow.v1.CatalogIntegration' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - display_name + - config + - environment + - kafka_cluster + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + kafka_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /tableflow/v1/catalog-integrations/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getTableflowV1CatalogIntegration + summary: Read a Catalog Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a catalog integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Scope the operation to the given spec.kafka_cluster. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the catalog integration. + tags: + - Catalog Integrations (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Catalog Integration. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/tableflow.v1.CatalogIntegration' + - type: object + required: + - api_version + - kind + - id + - spec + properties: + spec: + type: object + required: + - display_name + - config + - environment + - kafka_cluster + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + kafka_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationUpdateRequest' + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateTableflowV1CatalogIntegration + summary: Update a Catalog Integration + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a catalog integration. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the catalog integration. + tags: + - Catalog Integrations (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Catalog Integration. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/tableflow.v1.CatalogIntegration' + - type: object + required: + - api_version + - kind + - id + - spec + properties: + spec: + type: object + required: + - display_name + - config + - environment + - kafka_cluster + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/org/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + kafka_cluster: + example: + id: lkc-00000 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteTableflowV1CatalogIntegration + summary: Delete a Catalog Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a catalog integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Scope the operation to the given spec.kafka_cluster. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the catalog integration. + tags: + - Catalog Integrations (tableflow/v1) + security: + - resource-api-key: [] + responses: + '204': + description: A Catalog Integration is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /ccpm/v1/plugins: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCcpmV1CustomConnectPlugins + summary: List of Custom Connect Plugins + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all custom connect plugins. + + If no `cloud` filter is specified, returns custom connect plugins from all clouds. + parameters: + - name: spec.cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for spec.cloud. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Custom Connect Plugins (ccpm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Connect Plugin. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-page-first-available: true + x-page-last-available: true + x-page-from-start: true + x-page-from-end: true + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createCcpmV1CustomConnectPlugin + summary: Create a Custom Connect Plugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a custom connect plugin. + tags: + - Custom Connect Plugins (ccpm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccpm.v1.CustomConnectPlugin' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - cloud + - display_name + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + responses: + '202': + description: A Custom Connect Plugin is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/ccpm/v1/plugins/{id} + description: CustomConnectPlugin resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccpm.v1.CustomConnectPlugin' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - cloud + - display_name + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /ccpm/v1/plugins/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCcpmV1CustomConnectPlugin + summary: Read a Custom Connect Plugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a custom connect plugin. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connect plugin. + tags: + - Custom Connect Plugins (ccpm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Connect Plugin. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccpm.v1.CustomConnectPlugin' + - type: object + required: + - api_version + - kind + - id + - spec + properties: + spec: + type: object + required: + - cloud + - display_name + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateCcpmV1CustomConnectPlugin + summary: Update a Custom Connect Plugin + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a custom connect plugin. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connect plugin. + tags: + - Custom Connect Plugins (ccpm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccpm.v1.CustomConnectPlugin' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - environment + properties: + environment: + example: + id: env-00000 + responses: + '200': + description: Custom Connect Plugin. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccpm.v1.CustomConnectPlugin' + - type: object + required: + - api_version + - kind + - id + - spec + properties: + spec: + type: object + required: + - cloud + - display_name + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteCcpmV1CustomConnectPlugin + summary: Delete a Custom Connect Plugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a custom connect plugin. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connect plugin. + tags: + - Custom Connect Plugins (ccpm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Custom Connect Plugin is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /ccpm/v1/presigned-upload-url: + x-lifecycle-stage: General Availability + x-self-access: true + post: + summary: Request a presigned upload URL for a new Custom Connect Plugin. + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Request a presigned upload URL to upload a Custom Connect Plugin archive. + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createCcpmV1PresignedUrl + tags: + - Presigned Urls (ccpm/v1) + security: + - cloud-api-key: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccpm.v1.PresignedUrl' + - type: object + required: + - content_format + - cloud + - environment + - type: object + properties: + environment: + example: + id: env-00000 + responses: + '201': + description: A Presigned Url was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/ccpm/v1/presigned-upload-url/{id} + description: PresignedUrl resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccpm.v1.PresignedUrl' + - type: object + required: + - content_format + - cloud + - environment + - type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /ccpm/v1/plugins/{plugin_id}/versions: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCcpmV1CustomConnectPluginVersions + summary: List of Custom Connect Plugin Versions + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all custom connect plugin versions. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: plugin_id + in: path + required: true + schema: + type: string + description: The Plugin + tags: + - Custom Connect Plugin Versions (ccpm/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Custom Connect Plugin Version. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionList' + - type: object + properties: + data: + type: array + items: + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createCcpmV1CustomConnectPluginVersion + summary: Create a Custom Connect Plugin Version + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a custom connect plugin version. + parameters: + - name: plugin_id + in: path + required: true + schema: + type: string + description: The Plugin + tags: + - Custom Connect Plugin Versions (ccpm/v1) + security: + - cloud-api-key: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersion' + - type: object + required: + - spec + properties: + spec: + type: object + required: + - version + - connector_classes + - upload_source + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + responses: + '202': + description: A Custom Connect Plugin Version is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/ccpm/v1/plugins/{plugin_id}/versions/{id} + description: CustomConnectPluginVersion resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersion' + - type: object + required: + - spec + - status + properties: + spec: + type: object + required: + - version + - connector_classes + - upload_source + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /ccpm/v1/plugins/{plugin_id}/versions/{id}: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCcpmV1CustomConnectPluginVersion + summary: Read a Custom Connect Plugin Version + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a custom connect plugin version. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: plugin_id + in: path + required: true + schema: + type: string + description: The Plugin + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connect plugin version. + tags: + - Custom Connect Plugin Versions (ccpm/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Custom Connect Plugin Version. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersion' + - type: object + required: + - api_version + - kind + - id + - spec + - status + properties: + spec: + type: object + required: + - version + - connector_classes + - upload_source + - environment + - type: object + properties: + spec: + type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteCcpmV1CustomConnectPluginVersion + summary: Delete a Custom Connect Plugin Version + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a custom connect plugin version. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: plugin_id + in: path + required: true + schema: + type: string + description: The Plugin + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connect plugin version. + tags: + - Custom Connect Plugin Versions (ccpm/v1) + security: + - cloud-api-key: [] + responses: + '204': + description: A Custom Connect Plugin Version is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /usm/v1/kafka-clusters: + x-lifecycle-stage: Preview + x-self-access: true + get: + x-lifecycle-stage: Preview + x-self-access: true + operationId: listUsmV1KafkaClusters + summary: List of Kafka Clusters + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all kafka clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Kafka Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Kafka Cluster. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/usm.v1.KafkaClusterList' + - type: object + properties: + data: + type: array + items: + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Preview + x-self-access: true + operationId: createUsmV1KafkaCluster + summary: Create a Kafka Cluster + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a kafka cluster. + tags: + - Kafka Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/usm.v1.KafkaCluster' + - type: object + required: + - display_name + - confluent_platform_kafka_cluster_id + - cloud + - region + - environment + - type: object + properties: + environment: + example: + id: env-00000 + responses: + '201': + description: A Kafka Cluster was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/usm/v1/kafka-clusters/{id} + description: KafkaCluster resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/usm.v1.KafkaCluster' + - type: object + required: + - display_name + - confluent_platform_kafka_cluster_id + - cloud + - region + - environment + - type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /usm/v1/kafka-clusters/{id}: + x-lifecycle-stage: Preview + x-self-access: true + get: + x-lifecycle-stage: Preview + x-self-access: true + operationId: getUsmV1KafkaCluster + summary: Read a Kafka Cluster + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a kafka cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the kafka cluster. + tags: + - Kafka Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Kafka Cluster. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/usm.v1.KafkaCluster' + - type: object + required: + - api_version + - kind + - id + - display_name + - confluent_platform_kafka_cluster_id + - cloud + - region + - environment + - type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Preview + x-self-access: true + operationId: deleteUsmV1KafkaCluster + summary: Delete a Kafka Cluster + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a kafka cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the kafka cluster. + tags: + - Kafka Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Kafka Cluster is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /usm/v1/connect-clusters: + x-lifecycle-stage: Preview + x-self-access: true + get: + x-lifecycle-stage: Preview + x-self-access: true + operationId: listUsmV1ConnectClusters + summary: List of Connect Clusters + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all connect clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Connect Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connect Cluster. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/usm.v1.ConnectClusterList' + - type: object + properties: + data: + type: array + items: + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Preview + x-self-access: true + operationId: createUsmV1ConnectCluster + summary: Create a Connect Cluster + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a connect cluster. + tags: + - Connect Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/usm.v1.ConnectCluster' + - type: object + required: + - confluent_platform_connect_cluster_id + - kafka_cluster_id + - environment + - type: object + properties: + environment: + example: + id: env-00000 + responses: + '201': + description: A Connect Cluster was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/usm/v1/connect-clusters/{id} + description: ConnectCluster resource uri + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/usm.v1.ConnectCluster' + - type: object + required: + - confluent_platform_connect_cluster_id + - kafka_cluster_id + - environment + - type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /usm/v1/connect-clusters/{id}: + x-lifecycle-stage: Preview + x-self-access: true + get: + x-lifecycle-stage: Preview + x-self-access: true + operationId: getUsmV1ConnectCluster + summary: Read a Connect Cluster + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a connect cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the connect cluster. + tags: + - Connect Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connect Cluster. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/usm.v1.ConnectCluster' + - type: object + required: + - api_version + - kind + - id + - confluent_platform_connect_cluster_id + - kafka_cluster_id + - environment + - type: object + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Preview + x-self-access: true + operationId: deleteUsmV1ConnectCluster + summary: Delete a Connect Cluster + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a connect cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the connect cluster. + tags: + - Connect Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Connect Cluster is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /endpoint/v1/endpoints: + x-lifecycle-stage: General Availability + x-self-access: true + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listEndpointV1Endpoints + summary: List of Endpoints + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all endpoints. + parameters: + - name: cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for cloud. + - name: region + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-west-2 + description: Filter the results by exact match for region. + - name: service + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: KAFKA + description: Filter the results by exact match for service. + - name: is_private + in: query + required: false + schema: + $ref: '#/components/schemas/BooleanFilter' + example: true + description: | + Filter the results by whether the endpoint is private (true) or public (false). + If not specified, returns both private and public endpoints. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: resource + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-abc123 + description: Filter the results by exact match for resource. + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 1000 + x-max-page-items: 5000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Endpoints (endpoint/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Endpoint. + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/endpoint.v1.EndpointList' + - type: object + properties: + data: + type: array + items: + properties: + environment: + example: + id: env-00000 + related: https://api.confluent.cloud/v2/environments/env-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000 + resource: + example: + id: lkc-abc123 + related: https://api.confluent.cloud/cmk/v2/clusters/lkc-abc123 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-abc123 + gateway: + example: + id: gw-00000 + related: https://api.confluent.cloud/networking/v1/gateways/gw-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-00000 + access_point: + example: + id: ap-00000 + related: https://api.confluent.cloud/networking/v1/access-points/ap-00000 + resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-456xyz/access-point=ap-00000 + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make + per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and\ + \ Twitter's same-named header which uses UTC epoch seconds. We use\ + \ relative time to avoid client/server time synchronization issues." + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' +components: + schemas: + iam.v2.ApiKey: + type: object + description: |- + `ApiKey` objects represent access to different parts of Confluent Cloud. Some types + of API keys represent access to a single cluster/resource such as a Kafka cluster, + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization + that are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API. + Tableflow API keys are not tied to a specific cluster. + + The API allows you to list, create, update and delete your API Keys. + + + Related guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + ## The API Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `apikeys_per_org` | API Keys in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKey + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/iam/v2/api-keys/ak-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/api-key=ak-12345 + spec: + $ref: '#/components/schemas/iam.v2.ApiKeySpec' + SearchFilter: + description: Filter a collection by a string search + type: string + iam.v2.ApiKeyList: + type: object + description: |- + `ApiKey` objects represent access to different parts of Confluent Cloud. Some types + of API keys represent access to a single cluster/resource such as a Kafka cluster, + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization + that are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API. + Tableflow API keys are not tied to a specific cluster. + + The API allows you to list, create, update and delete your API Keys. + + + Related guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + ## The API Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `apikeys_per_org` | API Keys in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKeyList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/iam/v2/api-keys + last: + example: https://api.confluent.cloud/iam/v2/api-keys?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/iam/v2/api-keys?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/iam/v2/api-keys?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/iam.v2.ApiKey' + - type: object + required: + - id + - metadata + - spec + properties: + spec: + type: object + required: + - owner + uniqueItems: true + iam.v2.ApiKeySpec: + type: object + description: The desired state of the Api Key + properties: + secret: + type: string + example: R15hoiDIq8Nxu/lY4mPO3DwAVIfU5W7OI+efsB607mLgHTnVW5XJGVqX2ysDx987 + description: The API key secret. Only provided in `create` responses, not + in `get` or `list`. + x-redact: true + x-immutable: true + readOnly: true + display_name: + type: string + example: CI kafka access key + description: A human readable name for the API key + description: + type: string + example: This API key provides kafka access to cluster x + description: A human readable description for the API key + owner: + allOf: + - $ref: '#/components/schemas/TypedGlobalObjectReference' + description: The owner to which this belongs. The owner can be one of iam.v2.User, + iam.v2.ServiceAccount. + x-immutable: true + resource: + allOf: + - $ref: '#/components/schemas/TypedEnvScopedObjectReference' + nullable: true + description: | + The resource associated with this object. The resource can be one of Kafka Cluster ID (example: lkc-12345), + Schema Registry Cluster ID (example: lsrc-12345), ksqlDB Cluster ID (example: lksqlc-12345), or Flink + (Environment + Region pair, example: env-abc123.aws.us-east-2). + May be null or omitted if not associated with a resource. For creating Cloud API key, resource should be `CLOUD`, + for creating Tableflow API key, resource should be `TABLEFLOW`. The resource id is case-insensitive. + [Learn more in Authentication](https://docs.confluent.io/cloud/current/api.html#section/Authentication). + + Note - Flink is in the [Preview lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object + can be addressed. This URL encodes the service location, API version, + and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a Confluent + Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented + in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It + is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does + not contain a prev link, then either there is no previous data or backwards + traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may + be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + ObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + TypedGlobalObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + TypedEnvScopedObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + Failure: + type: object + description: Provides information about problems encountered while performing + an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed + as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD + NOT** change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of + the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body property + that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the + request document [e.g. "/spec" for a spec object, or "/spec/title" + for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + + additionalProperties: false + org.v2.Environment: + type: object + description: |- + `Environment` objects represent an isolated namespace for your Confluent resources + for organizational purposes. + + The API allows you to create, delete, and update your environments. You can retrieve + individual environments as well as a list of all your environments. + + + Related guide: [Environments in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + ## The Environments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `environments_per_org` | Environments in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Environment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/org/v2/environments/e-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=e-12345 + display_name: + type: string + example: prod-finance01 + description: A human-readable name for the Environment + stream_governance_config: + type: object + description: Stream Governance configurations for the environment + allOf: + - $ref: '#/components/schemas/org.v2.StreamGovernanceConfig' + org.v2.Organization: + type: object + description: |- + `Organization` objects represent a customer organization. An organization contains all customer + resources (e.g., Environments, Kafka Clusters, Service Accounts, API Keys) and is tied to a billing + agreement (including any annual commitment or support plan). + + The API allows you to list, view, and update your organizations. + + + Related guide: [Organizations for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + ## The Organizations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `organizations_per_user` | Confluent Cloud organizations a user belongs to | + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/org/v2/organizations/o-12345 + resource_name: + example: crn://confluent.cloud/organization=o-12345 + display_name: + type: string + example: Finance Org + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + description: A human-readable name for the Organization + jit_enabled: + type: boolean + description: The flag to toggle Just-In-Time user provisioning for SSO-enabled + organization. Available for early access only. + org.v2.StreamGovernanceConfig: + description: | + Configurations pertaining to Stream Governance + type: object + properties: + package: + type: string + x-extensible-enum: [ESSENTIALS, ADVANCED] + description: | + Stream Governance Package. Supported values are ESSENTIALS and ADVANCED. + Package comparison can be found + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + +# Default Values for Org API + org.v2.EnvironmentList: + type: object + description: |- + `Environment` objects represent an isolated namespace for your Confluent resources + for organizational purposes. + + The API allows you to create, delete, and update your environments. You can retrieve + individual environments as well as a list of all your environments. + + + Related guide: [Environments in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + ## The Environments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `environments_per_org` | Environments in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - EnvironmentList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/org/v2/environments + last: + example: https://api.confluent.cloud/org/v2/environments?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/org/v2/environments?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/org/v2/environments?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/org.v2.Environment' + - type: object + required: + - id + - metadata + - display_name + uniqueItems: true + org.v2.OrganizationList: + type: object + description: |- + `Organization` objects represent a customer organization. An organization contains all customer + resources (e.g., Environments, Kafka Clusters, Service Accounts, API Keys) and is tied to a billing + agreement (including any annual commitment or support plan). + + The API allows you to list, view, and update your organizations. + + + Related guide: [Organizations for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + ## The Organizations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `organizations_per_user` | Confluent Cloud organizations a user belongs to | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OrganizationList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/org/v2/organizations + last: + example: https://api.confluent.cloud/org/v2/organizations?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/org/v2/organizations?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/org/v2/organizations?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/org.v2.Organization' + - type: object + required: + - id + - metadata + uniqueItems: true + iam.v2.User: + type: object + description: |- + `User` objects represent individuals who may access your Confluent resources. + + The API allows you to retrieve, update, and delete individual users, as well as list of all your + users. This API cannot be used to create new user accounts. + + + Related guide: [Users in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + ## The Users Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `users_per_org` | Users in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - User + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/iam/v2/users/u-12345 + resource_name: + example: crn://confluent.cloud/user=u-12345 + email: + type: string + format: email + example: marty.mcfly@example.com + description: The user's email address + x-immutable: true + full_name: + example: Marty McFly + type: string + description: The user's full name + auth_type: + type: string + description: The user's authentication method + example: AUTH_TYPE_SSO + x-extensible-enum: [AUTH_TYPE_LOCAL, AUTH_TYPE_SSO] + readOnly: true + iam.v2.ServiceAccount: + type: object + description: |- + `ServiceAccount` objects are typically used to represent applications and other non-human principals + that may access your Confluent resources. + + The API allows you to create, retrieve, update, and delete individual service accounts, as well as + list all your service accounts. + + + Related guide: [Service Accounts in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + ## The Service Accounts Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `service_accounts_per_org` | Service Accounts in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccount + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/iam/v2/service-accounts/sa-12345 + resource_name: + example: crn://confluent.cloud/service-account=sa-12345 + display_name: + type: string + example: DeLorean_auto_repair + description: A human-readable name for the Service Account + description: + type: string + example: Doc's repair bot for the DeLorean + description: A free-form description of the Service Account + iam.v2.Invitation: + type: object + description: |- + `Invitation` objects represent invitations to invite users to join your organizations in Confluent Cloud. + + The API allows you to list all your invitations, as well as create, read, and delete a specified invitation. + + + Related guide: [User invitations in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + ## The Invitations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `invitations_per_org` | Invitations in a Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Invitation + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/iam/v2/invitations/i-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/invitation=i-12345 + email: + type: string + format: email + example: johndoe@confluent.io + description: The user/invitee's email address + x-immutable: true + auth_type: + type: string + # yamllint disable rule:line-length + description: | + The user/invitee's authentication type. Note that only the [OrganizationAdmin role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) + can invite AUTH_TYPE_LOCAL users to SSO organizations. + The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. + Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default. + example: AUTH_TYPE_SSO + x-extensible-enum: [AUTH_TYPE_LOCAL, AUTH_TYPE_SSO] + status: + type: string + example: INVITE_STATUS_SENT + description: The status of invitations + x-extensible-enum: [INVITE_STATUS_SENT, INVITE_STATUS_STAGED, INVITE_STATUS_ACCEPTED, + INVITE_STATUS_EXPIRED, INVITE_STATUS_DEACTIVATED] + readOnly: true + accepted_at: + type: string + format: date-time + example: 2022-07-06T17:21:33Z + description: The timestamp that the invitation was accepted + nullable: true + readOnly: true + expires_at: + type: string + format: date-time + example: 2022-07-07T17:22:39Z + description: The timestamp that the invitation will expire + readOnly: true + user: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The user/invitee + readOnly: true + creator: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The invitation creator + readOnly: true + iam.v2.User.ConfigureUserAuthRequest: + type: object + description: Configure user auth type + properties: + api_version: + type: string + enum: + - iam.v2/User + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConfigureUserAuthRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/iam.v2/User/configure-user-auth-requests/cuar-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/configure-user-auth-request=cuar-12345 + auth_type: + type: string + description: The user's authentication method. + example: AUTH_TYPE_SSO + x-extensible-enum: [AUTH_TYPE_LOCAL, AUTH_TYPE_SSO] + MultipleSearchFilter: + description: Filter a collection by a string search for one or more values + type: array + items: + type: string + iam.v2.UserList: + type: object + description: |- + `User` objects represent individuals who may access your Confluent resources. + + The API allows you to retrieve, update, and delete individual users, as well as list of all your + users. This API cannot be used to create new user accounts. + + + Related guide: [Users in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + ## The Users Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `users_per_org` | Users in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - UserList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/iam/v2/users + last: + example: https://api.confluent.cloud/iam/v2/users?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/iam/v2/users?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/iam/v2/users?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/iam.v2.User' + - type: object + required: + - id + - metadata + - email + uniqueItems: true + iam.v2.ServiceAccountList: + type: object + description: |- + `ServiceAccount` objects are typically used to represent applications and other non-human principals + that may access your Confluent resources. + + The API allows you to create, retrieve, update, and delete individual service accounts, as well as + list all your service accounts. + + + Related guide: [Service Accounts in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + ## The Service Accounts Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `service_accounts_per_org` | Service Accounts in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccountList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/iam/v2/service-accounts + last: + example: https://api.confluent.cloud/iam/v2/service-accounts?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/iam/v2/service-accounts?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/iam/v2/service-accounts?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/iam.v2.ServiceAccount' + - type: object + required: + - id + - metadata + - display_name + uniqueItems: true + iam.v2.InvitationList: + type: object + description: |- + `Invitation` objects represent invitations to invite users to join your organizations in Confluent Cloud. + + The API allows you to list all your invitations, as well as create, read, and delete a specified invitation. + + + Related guide: [User invitations in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + ## The Invitations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `invitations_per_org` | Invitations in a Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - InvitationList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/iam/v2/invitations + last: + example: https://api.confluent.cloud/iam/v2/invitations?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/iam/v2/invitations?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/iam/v2/invitations?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/iam.v2.Invitation' + - type: object + required: + - id + - metadata + - email + uniqueItems: true + GlobalObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + iam.v2.IpGroup: + type: object + description: |- + Definitions of networks which can be named and referred by IP blocks, commonly used to attach to IP Filter rules. + + + ## The IP Groups Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroup + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/iam/v2/ip-groups/ipg-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/ip-group=ipg-12345 + group_name: + type: string + minLength: 1 + maxLength: 64 + example: CorpNet + description: | + A human readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or + any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + cidr_blocks: + type: array + items: + type: string + minItems: 1 + maxItems: 25 + example: [192.168.0.0/24, 192.168.7.0/24] + description: A list of CIDRs. + iam.v2.IpFilter: + type: object + description: |- + `IP Filter` objects are bindings between IP Groups and Confluent resource(s). + For example, a binding between "CorpNet" and "Management APIs" will enforce that + access must come from one of the CIDR blocks associated with CorpNet. + If there are multiple IP filters bound to a resource, a request matching any of the CIDR blocks + for any of the IP Group will allow the request. + If there are no IP Filters for a resource, then access will be granted to requests originating + from any IP Address. + + + ## The IP Filters Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilter + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/iam/v2/ip-filters/ipf-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/ip-filter=ipf-12345 + filter_name: + type: string + minLength: 1 + maxLength: 64 + example: Management API Rules + description: | + A human readable name for an IP Filter. Can contain any unicode letter or number, the ASCII space character, + or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + resource_group: + type: string + example: management + description: | + Scope of resources covered by this IP filter. Available resource groups include "management" and "multiple". + resource_scope: + type: string + example: crn://confluent.cloud/organization=org-123/environment=env-abc + format: uri + pattern: ^crn://.+$ + description: | + A CRN that specifies the scope of the ip filter, specifically the organization + or environment. Without specifying this property, the ip filter + would apply to the whole organization. + operation_groups: + type: array + items: + type: string + example: [MANAGEMENT, SCHEMA, FLINK] + description: | + Scope of resources covered by this IP filter. Resource group must be set to 'multiple' + in order to use this property.During update operations, note that the operation + groups passed in will replace the list of existing operation groups + (passing in an empty list will remove all operation groups) from the filter + (in line with the behavior for ip_groups). + ip_groups: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: A list of IP Groups. + minItems: 1 + maxItems: 25 + iam.v2.IpFilterSummary: + type: object + description: | + The IP Filter Summary endpoint returns an aggregation of the IP Filters across the system. + This API can be queried in the context of an organization or an environment. It returns a + summary of every operation group in the system grouped with a higher summary by operation + group category. + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilterSummary + scope: + type: string + description: The scope associated with this object. + categories: + type: array + items: + type: object + properties: + name: + type: string + description: Name of the category. + status: + type: string + description: Open, limited, or mixed. + operation_groups: + type: array + description: Operation groups part of this category. + items: + type: object + properties: + name: + type: string + description: Name of the operation group. + status: + type: string + description: Open, limited, or no access. + example: [{name: management, status: MIXED, operation_groups: [{name: MANAGEMENT, + status: LIMITED}]}] + description: | + Summary of the operation groups and IP filters created in those operation groups. + iam.v2.IpGroupList: + type: object + description: |- + Definitions of networks which can be named and referred by IP blocks, commonly used to attach to IP Filter rules. + + + ## The IP Groups Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroupList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/iam/v2/ip-groups + last: + example: https://api.confluent.cloud/iam/v2/ip-groups?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/iam/v2/ip-groups?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/iam/v2/ip-groups?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/iam.v2.IpGroup' + - type: object + required: + - id + - metadata + - group_name + - cidr_blocks + uniqueItems: true + iam.v2.IpFilterList: + type: object + description: |- + `IP Filter` objects are bindings between IP Groups and Confluent resource(s). + For example, a binding between "CorpNet" and "Management APIs" will enforce that + access must come from one of the CIDR blocks associated with CorpNet. + If there are multiple IP filters bound to a resource, a request matching any of the CIDR blocks + for any of the IP Group will allow the request. + If there are no IP Filters for a resource, then access will be granted to requests originating + from any IP Address. + + + ## The IP Filters Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilterList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/iam/v2/ip-filters + last: + example: https://api.confluent.cloud/iam/v2/ip-filters?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/iam/v2/ip-filters?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/iam/v2/ip-filters?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/iam.v2.IpFilter' + - type: object + required: + - id + - metadata + - filter_name + - resource_group + - ip_groups + uniqueItems: true + iam.v2.RoleBinding: + type: object + description: |- + A role binding grants a Principal a role on resources that match a pattern. + + The API allows you to perform create, delete, and list operations on role bindings. + + + Related guide: [Role-Based Access Control (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + ## The Role Bindings Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBinding + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/iam/v2/role-bindings/rb-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/role-binding=rb-12345 + principal: + type: string + description: The principal User to bind the role to + pattern: (^User:.+$) + example: User:u-111aaa + role_name: + type: string + description: The name of the role to bind to the principal + example: CloudClusterAdmin + crn_pattern: + type: string + description: A CRN that specifies the scope and resource patterns necessary + for the role to bind + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + iam.v2.RoleBindingList: + type: object + description: |- + A role binding grants a Principal a role on resources that match a pattern. + + The API allows you to perform create, delete, and list operations on role bindings. + + + Related guide: [Role-Based Access Control (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + ## The Role Bindings Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBindingList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/iam/v2/role-bindings + last: + example: https://api.confluent.cloud/iam/v2/role-bindings?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/iam/v2/role-bindings?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/iam/v2/role-bindings?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/iam.v2.RoleBinding' + - type: object + required: + - id + - metadata + - principal + - role_name + - crn_pattern + uniqueItems: true + notifications.v1.Subscription: + type: object + description: |- + `Subscription` objects represent the intent of the customers to get notifications of particular types. + A subscription is created for a particular `NotificationType` and the user will get notifications on the + `Integrations` that are provided while creating the subscription. + + This API allows you to create, retrieve, and update subscriptions, + as well as to view the list of all your subscriptions. You can also delete subscriptions + with RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Subscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/notifications/v1/subscriptions/s-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/subscription=s-12345 + current_state: + type: string + x-extensible-enum: [ENABLED, DISABLED] + description: | + Denotes the state of the subscription. When the subscription is ENABLED, the user will receive + notification on the configured Integrations. If the subscription is DISABLED, the user will not + recieve any notification for the configured notification type. Note that, you cannot disable + a subscription for `REQUIRED` notification type. + example: ENABLED + notification_type: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The type of notification to subscribe to. + x-immutable: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + notifications.v1.Integration: + type: object + description: |- + You can create an `Integration` to specify how we can notify you when we receive an alert/notification for + a subscription. Please note that you can only perform create, update and delete operations for integrations + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail` + and `UserEmail`. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Integrations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `integrations_per_org` | Maximum number of integrations in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/notifications/v1/integrations/i-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/integration=i-12345 + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: | + A human readable description for the particular integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + allOf: + - $ref: '#/components/schemas/notifications.v1.Target' + notifications.v1.NotificationType: + type: object + description: |- + The type of notifications (and their corresponding metadata) supported by Confluent. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Notification Types Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NotificationType + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/notifications/v1/notification-types/nt-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/notification-type=nt-12345 + display_name: + type: string + description: | + Human readable display name of the notification type + example: Cluster Shrink + category: + type: string + x-extensible-enum: [BILLING_LICENSING, SECURITY, SERVICE, ACCOUNT] + description: | + Represents the group with which the notification is associated. + Notifications are grouped under certain categories for better organization. + - BILLING_LICENSING: All billing, payments or licensing related notifications are grouped here. + - SECURITY: All Confluent Cloud and Platform security related notifications are grouped here. + - SERVICE: All Confluent services (eg. Kafka, Schema Registry, Connect etc.) related notifications are + grouped here. + - ACCOUNT: All Confluent account related notifications are grouped here. + For example: Billing, payment or license related notifications are grouped in BILLING_LICENSING category. + example: BILLING_LICENSING + description: + type: string + description: | + Human readable description of the notification type + example: Cluster shrink operation is completed + subscription_priority: + type: string + x-extensible-enum: [REQUIRED, RECOMMENDED, OPTIONAL] + description: | + Indicates whether the notification is auto-subscribed and if the user can opt-out. + - REQUIRED: the user is auto-subscribed to this notification and can't opt-out. + - RECOMMENDED: the user is auto-subscribed to this notification and can opt-out. + - OPTIONAL: the user is not auto-subscribed to this notification but can explicitly subscribe to it. + example: REQUIRED + is_included_in_plan: + type: boolean + description: | + Whether this notification is available to subscribe or not + as per the user's current billing plan. + severity: + type: string + x-extensible-enum: [CRITICAL, WARN, INFO] + description: | + Severity indicates the impact of this notification. + - CRITICAL: a high impact notification which needs immediate attention. + - WARN: a warning notification which can be addressed now or later. + - INFO: an informational notification. + example: INFO + notifications.v1.ResourcePreference: + type: object + description: |- + `ResourcePreference` objects represent the intent of the customers to enable or disable all notifications + at the resource level. A ResourcePreference is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update and delete resourcePreferences. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Preferences Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourcePreference + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/notifications/v1/resource-preferences/rp-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/resource-preference=rp-12345 + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: [ORGANIZATION, ENVIRONMENT, CLUSTER, CONNECTOR, FLINK_COMPUTE_POOL, + FLINK_STATEMENT] + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: [ENABLED, DISABLED] + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + notifications.v1.ResourceSubscription: + type: object + description: |- + `ResourceSubscription` objects represent the intent of the customers to get notifications of particular types + at the resource level. A ResourceSubscription is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update, delete and list ResourceSubscription. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/notifications/v1/resource-subscriptions/rs-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/resource-subscription=rs-12345 + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: [ENVIRONMENT, CLUSTER, CONNECTOR, FLINK_COMPUTE_POOL, + FLINK_STATEMENT] + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: [ENABLED, DISABLED] + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + notification_type: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The type of notification to subscribe to. + x-immutable: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + notifications.v1.SlackTarget: + type: object + description: Target required for Slack integration + required: + - kind + - webhook_url + properties: + kind: + type: string + enum: [Slack] + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + notifications.v1.RoleEmailTarget: + type: object + description: Email integration target to send email to all user with specified + role + required: + - kind + - role_name + properties: + kind: + type: string + enum: [RoleEmail] + description: Email Integration type for Role + example: RoleEmail + role_name: + type: string + description: name of the role + example: OrganizationAdmin + notifications.v1.UserEmailTarget: + type: object + description: Email integration target to send email to a particular user + required: + - kind + - user + properties: + kind: + type: string + enum: [UserEmail] + description: Email Integration type for User + example: UserEmail + user: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: Reference to the user + notifications.v1.WebhookTarget: + type: object + description: Target required for webhook integration + required: + - kind + - url + properties: + kind: + type: string + enum: [Webhook] + description: Integration Type + example: Webhook + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + notifications.v1.MsTeamsTarget: + type: object + description: Target required for MS Teams integration + required: + - kind + - webhook_url + properties: + kind: + type: string + enum: [MsTeams] + description: Integration Type + example: MsTeams + webhook_url: + type: string + format: uri + description: MS Teams Webhook URL for the particular team channel + example: https://admin.webhook.office.com/webhookb2/{id}/IncomingWebhook/{id} + notifications.v1.Target: + description: Target for the particular integration + oneOf: + - $ref: '#/components/schemas/notifications.v1.SlackTarget' + - $ref: '#/components/schemas/notifications.v1.RoleEmailTarget' + - $ref: '#/components/schemas/notifications.v1.UserEmailTarget' + - $ref: '#/components/schemas/notifications.v1.WebhookTarget' + - $ref: '#/components/schemas/notifications.v1.MsTeamsTarget' + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + +# Default + notifications.v1.SubscriptionList: + type: object + description: |- + `Subscription` objects represent the intent of the customers to get notifications of particular types. + A subscription is created for a particular `NotificationType` and the user will get notifications on the + `Integrations` that are provided while creating the subscription. + + This API allows you to create, retrieve, and update subscriptions, + as well as to view the list of all your subscriptions. You can also delete subscriptions + with RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Subscriptions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - SubscriptionList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/notifications/v1/subscriptions + last: + example: https://api.confluent.cloud/notifications/v1/subscriptions?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/notifications/v1/subscriptions?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/notifications/v1/subscriptions?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/notifications.v1.Subscription' + - type: object + required: + - id + - metadata + - notification_type + - integrations + uniqueItems: true + notifications.v1.IntegrationList: + type: object + description: |- + You can create an `Integration` to specify how we can notify you when we receive an alert/notification for + a subscription. Please note that you can only perform create, update and delete operations for integrations + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail` + and `UserEmail`. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Integrations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `integrations_per_org` | Maximum number of integrations in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/notifications/v1/integrations + last: + example: https://api.confluent.cloud/notifications/v1/integrations?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/notifications/v1/integrations?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/notifications/v1/integrations?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/notifications.v1.Integration' + - type: object + required: + - id + - metadata + - display_name + - target + uniqueItems: true + notifications.v1.NotificationTypeList: + type: object + description: |- + The type of notifications (and their corresponding metadata) supported by Confluent. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Notification Types Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NotificationTypeList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/notifications/v1/notification-types + last: + example: https://api.confluent.cloud/notifications/v1/notification-types?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/notifications/v1/notification-types?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/notifications/v1/notification-types?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/notifications.v1.NotificationType' + - type: object + required: + - id + - metadata + - display_name + - category + - description + - subscription_priority + - is_included_in_plan + - severity + uniqueItems: true + notifications.v1.ResourceSubscriptionList: + type: object + description: |- + `ResourceSubscription` objects represent the intent of the customers to get notifications of particular types + at the resource level. A ResourceSubscription is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update, delete and list ResourceSubscription. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Subscriptions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscriptionList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/notifications/v1/resource-subscriptions + last: + example: https://api.confluent.cloud/notifications/v1/resource-subscriptions?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/notifications/v1/resource-subscriptions?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/notifications/v1/resource-subscriptions?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/notifications.v1.ResourceSubscription' + - type: object + required: + - id + - metadata + - resource + - resource_type + - notification_type + - integrations + uniqueItems: true + cmk.v2.Cluster: + type: object + description: |- + `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Kafka clusters. + + + Related guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/cmk/v2/clusters/lkc-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-12345 + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + cmk.v2.ClusterStatus: + type: object + required: + - phase + description: The status of the Cluster + properties: + phase: + type: string + x-extensible-enum: [PROVISIONING, PROVISIONED, FAILED] + description: | + The lifecyle phase of the cluster: + PROVISIONED: cluster is provisioned; + PROVISIONING: cluster provisioning is in progress; + FAILED: provisioning failed + readOnly: true + example: PROVISIONED + cku: + description: | + The number of Confluent Kafka Units (CKUs) the Dedicated cluster currently has. + readOnly: true + type: integer + format: int32 + minimum: 1 + example: 2 + readOnly: true + cmk.v2.Basic: + type: object + description: | + The basic cluster type. + properties: + kind: + description: | + Basic cluster type. + type: string + enum: [Basic] + max_ecku: + # yamllint disable rule:line-length + description: | + The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. + For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements). + type: integer + format: int32 + minimum: 1 + example: 2 + required: + - kind + cmk.v2.Standard: + type: object + description: | + The standard cluster type. + properties: + kind: + description: | + Standard cluster type. + type: string + enum: [Standard] + max_ecku: + # yamllint disable rule:line-length + description: | + The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. + Kafka clusters with `HIGH` availability must have at least two eCKUs. + For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements). + type: integer + format: int32 + minimum: 1 + example: 2 + required: + - kind + cmk.v2.Enterprise: + type: object + # yamllint disable rule:line-length + description: | + The enterprise cluster type. + properties: + kind: + description: | + Enterprise cluster type. + type: string + enum: [Enterprise] + max_ecku: + # yamllint disable rule:line-length + description: | + The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. + Kafka clusters with `HIGH` availability must have at least two eCKUs. + For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements). + type: integer + format: int32 + minimum: 1 + example: 2 + required: + - kind + cmk.v2.Dedicated: + type: object + description: | + A dedicated cluster with its parameters. + properties: + kind: + type: string + enum: [Dedicated] + description: | + Dedicated cluster type. + cku: + description: | + The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. + MULTI_ZONE dedicated clusters must have at least two CKUs. + type: integer + format: int32 + minimum: 1 + example: 2 + encryption_key: + type: string + description: | + The id of the encryption key that is used to encrypt the data in the Kafka cluster. + (e.g. for Amazon Web Services, the Amazon Resource Name of the key). + example: arn:aws:kms:us-west-2:000000000000:key/0000xxxx-00xx-00xx-00xx-0000000000xx + deprecated: true + x-immutable: true + zones: + type: array + items: + type: string + uniqueItems: true + minItems: 1 + maxItems: 3 + description: | + The list of zones the cluster is in. + + On AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) + (e.g. use1-az3) + + On GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones) + (e.g. us-central1-c). + readOnly: false + example: [us-central1-a, us-central1-b, us-central1-c] + x-immutable: true + required: + - kind + - cku + cmk.v2.Freight: + type: object + description: | + A freight cluster with its parameters. + properties: + kind: + type: string + enum: [Freight] + # yamllint disable rule:line-length + description: | + Freight cluster type. + max_ecku: + # yamllint disable rule:line-length + description: | + The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. + Kafka clusters with `HIGH` availability must have at least two eCKUs. + For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements). + type: integer + format: int32 + minimum: 1 + example: 2 + zones: + type: array + items: + type: string + uniqueItems: true + minItems: 1 + maxItems: 3 + description: | + The list of zones the cluster is in. + + On AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) + (e.g. use1-az3) + + On GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones) + (e.g. us-central1-c). + readOnly: true + example: [us-central1-a, us-central1-b, us-central1-c] + x-immutable: true + required: + - kind + + cmk.v2.EndpointsMap: + type: object + description: | + Map of endpoints for a Kafka cluster, keyed by access point ID. + additionalProperties: + $ref: '#/components/schemas/cmk.v2.Endpoints' + readOnly: true + example: + ap1pni123: + kafka_bootstrap_endpoint: lkc-s1232-00000.us-central1.gcp.private.confluent.cloud:9092 + http_endpoint: https://lkc-s1232.us-central1.gcp.private.confluent.cloud:443 + connection_type: PRIVATE_NETWORK_INTERFACE + ap2platt67890: + kafka_bootstrap_endpoint: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092 + http_endpoint: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud + connection_type: PRIVATE_LINK + + cmk.v2.Endpoints: + type: object + description: | + Given a gateway type, endpoints to connect to the Kafka cluster. + properties: + kafka_bootstrap_endpoint: + type: string + description: | + The bootstrap endpoint used by Kafka clients to connect to the cluster. + example: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092 + http_endpoint: + type: string + description: | + The REST endpoint for the Kafka cluster. + format: uri + example: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:443 + connection_type: + type: string + description: | + The type of connection used for the endpoint. + # This list comes from networking.v1.ConnectionType and [PEERING, TRANSITGATEWAY] values were dropped + x-extensible-enum: [PUBLIC, PRIVATE_LINK, PRIVATE_NETWORK_INTERFACE] + example: PRIVATE_NETWORK_INTERFACE + required: + - kafka_bootstrap_endpoint + - http_endpoint + - connection_type + readOnly: true + + cmk.v2.ClusterList: + type: object + description: |- + `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Kafka clusters. + + + Related guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cmk/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/cmk/v2/clusters + last: + example: https://api.confluent.cloud/cmk/v2/clusters?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/cmk/v2/clusters?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/cmk/v2/clusters?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/cmk.v2.Cluster' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - display_name + - availability + - cloud + - region + - config + - environment + uniqueItems: true + cmk.v2.ClusterSpec: + type: object + description: The desired state of the Cluster + properties: + display_name: + type: string + description: The name of the cluster. + example: ProdKafkaCluster + availability: + type: string + description: | + The availability zone configuration of the cluster + x-extensible-enum: [MULTI_ZONE, SINGLE_ZONE, HIGH, LOW] + example: SINGLE_ZONE + cloud: + type: string + description: The cloud service provider in which the cluster is running. + x-extensible-enum: [AWS, GCP, AZURE] + example: GCP + x-immutable: true + region: + type: string + description: The cloud service provider region where the cluster is running. + example: us-east4 + x-immutable: true + config: + description: | + The configuration of the Kafka cluster. + + Note: Clusters can be upgraded from Basic to Standard, but cannot be downgraded from Standard to Basic. + default: {kind: Basic} + example: {kind: Basic} + discriminator: + propertyName: kind + mapping: + Basic: '#/components/schemas/cmk.v2.Basic' + Standard: '#/components/schemas/cmk.v2.Standard' + Dedicated: '#/components/schemas/cmk.v2.Dedicated' + Enterprise: '#/components/schemas/cmk.v2.Enterprise' + Freight: '#/components/schemas/cmk.v2.Freight' + oneOf: + - $ref: '#/components/schemas/cmk.v2.Basic' + - $ref: '#/components/schemas/cmk.v2.Standard' + - $ref: '#/components/schemas/cmk.v2.Dedicated' + - $ref: '#/components/schemas/cmk.v2.Enterprise' + - $ref: '#/components/schemas/cmk.v2.Freight' + kafka_bootstrap_endpoint: + type: string + description: | + The bootstrap endpoint used by Kafka clients to connect to the cluster. + + DEPRECATED - Please use the `endpoints` attribute instead. + example: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092 + deprecated: true + x-immutable: true + readOnly: true + http_endpoint: + type: string + description: | + The cluster HTTP request URL. + + DEPRECATED - Please use the `endpoints` attribute instead. + format: uri + example: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud + deprecated: true + x-immutable: true + readOnly: true + api_endpoint: + type: string + description: | + The Kafka API cluster endpoint used by Kafka clients to connect to the cluster. + + DEPRECATED - Please use the `endpoints` attribute instead. + example: https://pkac-00000.us-west-2.aws.confluent.cloud + deprecated: true + x-immutable: true + readOnly: true + endpoints: + description: | + A map of endpoints for connecting to the Kafka cluster, + keyed by access_point_id. Access Point ID 'PUBLIC' and 'PRIVATE_LINK' are reserved. + These can be used for different network access methods or regions. + example: + ap1pni123: + kafka_bootstrap_endpoint: lkc-s1232-00000.us-central1.gcp.private.confluent.cloud:9092 + http_endpoint: https://lkc-s1232.us-central1.gcp.private.confluent.cloud:443 + connection_type: PRIVATENETWORKINTERFACE + ap2platt67890: + kafka_bootstrap_endpoint: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092 + http_endpoint: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud + connection_type: PRIVATELINK + allOf: + - $ref: '#/components/schemas/cmk.v2.EndpointsMap' + readOnly: true + environment: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The environment to which this belongs. + network: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The network associated with this object. + x-immutable: true + byok: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: | + Note: For Pre-BYOK v1 clusters, API responses might show both + `encryption_key` and `byok`. + To manage Pre-BYOK v1 keys, refer to: + https://docs.confluent.io/cloud/current/security/encrypt/byok/legacy-byok.html + #manage-pre-byok-api-v1-self-managed-encryption-keys + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + EnvScopedObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + ksqldbcm.v2.Cluster: + type: object + description: |- + `Cluster` represents a ksqlDB runtime that you can issue queries to using its API endpoint. + It executes SQL statements and queries which under the hood get built into corresponding + Kafka Streams topologies. The API allows you to list, create, read, and delete your ksqlDB clusters. + + + Related guide: [ksqlDB in Confluent Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the following quotas: + + | Quota | Description | + | --- | --- | + | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent Cloud Kafka Cluster. | + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/ksqldbcm/v2/clusters/lksqlc-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lksqlc-12345 + spec: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterStatus' + ksqldbcm.v2.ClusterStatus: + type: object + required: + - phase + - is_paused + - storage + description: The status of the Cluster + properties: + http_endpoint: + type: string + description: The dataplane endpoint of the ksqlDB cluster. + example: https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud + readOnly: true + phase: + type: string + x-extensible-enum: [PROVISIONING, PROVISIONED, FAILED] + description: Status of the ksqlDB cluster. + example: PROVISIONING + readOnly: true + is_paused: + type: boolean + description: Tells you if the cluster has been paused + readOnly: true + storage: + type: integer + format: int32 + example: 125 + description: Amount of storage (in GB) provisioned to this cluster + readOnly: true + topic_prefix: + type: string + description: Topic name prefix used by this ksqlDB cluster. Used to assign + ACLs for this ksqlDB cluster to use. + example: pksqlc-00000 + readOnly: true + readOnly: true + ksqldbcm.v2.ClusterList: + type: object + description: |- + `Cluster` represents a ksqlDB runtime that you can issue queries to using its API endpoint. + It executes SQL statements and queries which under the hood get built into corresponding + Kafka Streams topologies. The API allows you to list, create, read, and delete your ksqlDB clusters. + + + Related guide: [ksqlDB in Confluent Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the following quotas: + + | Quota | Description | + | --- | --- | + | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent Cloud Kafka Cluster. | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/ksqldbcm/v2/clusters + last: + example: https://api.confluent.cloud/ksqldbcm/v2/clusters?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/ksqldbcm/v2/clusters?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/ksqldbcm/v2/clusters?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/ksqldbcm.v2.Cluster' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - display_name + - csu + - kafka_cluster + - credential_identity + - environment + uniqueItems: true + ksqldbcm.v2.ClusterSpec: + type: object + description: The desired state of the Cluster + properties: + display_name: + type: string + example: ksqlDB_cluster_0 + description: The name of the ksqlDB cluster. + pattern: ^(?:[0-9A-Za-z\-])[\w-]{0,63}$ + x-immutable: true + use_detailed_processing_log: + type: boolean + default: true + description: | + This flag controls whether you want to include the row data in the processing log topic. Turn it off if you + don't want to emit sensitive information to the processing log + x-immutable: true + csu: + type: integer + format: int32 + example: 4 + x-extensible-enum: [1, 2, 4, 8, 12] + description: The number of CSUs (Confluent Streaming Units) in a ksqlDB + cluster. + x-immutable: false + kafka_cluster: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The kafka_cluster to which this belongs. + x-immutable: true + credential_identity: + allOf: + - $ref: '#/components/schemas/TypedGlobalObjectReference' + description: The credential_identity to which this belongs. The credential_identity + can be one of iam.v2.User, iam.v2.ServiceAccount. + x-immutable: true + environment: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The environment to which this belongs. + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + connect.v1.ConnectorError: + type: object + properties: + error: + type: object + description: Connector Error with error code and message. + properties: + code: + type: integer + description: Error code for the type of error + message: + type: string + description: Human readable error message + connect.v1.Connector: + type: object + properties: + name: + type: string + description: Name of the connector + config: + type: object + description: |- + Configuration parameters for the connector. These configurations + are the minimum set of key-value pairs (KVP) which can be used to + define how the connector connects Kafka to the external system. + Some of these KVPs are common to all the connectors, such as + connection parameters to Kafka, connector metadata, etc. The list + of common connector configurations is as follows + + - cloud.environment + - cloud.provider + - connector.class + - kafka.api.key + - kafka.api.secret + - kafka.endpoint + - kafka.region + - name + + A specific connector such as `GcsSink` would have additional + parameters such as `gcs.bucket.name`, `flush.size`, etc. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: [aws, azure, gcp] + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.endpoint: + type: string + description: The kafka cluster endpoint. + kafka.region: + type: string + description: The kafka cluster region. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + additionalProperties: + type: string + tasks: + type: array + description: List of active tasks generated by the connector + items: + type: object + properties: + connector: + type: string + description: The name of the connector the task belongs to + task: + type: integer + description: Task ID within the connector + required: + - connector + - task + type: + type: string + description: Type of connector, sink or source + enum: [sink, source] + required: + - name + - config + connect.v1.ConnectorWithOffsets: + type: object + properties: + name: + type: string + description: Name of the connector + config: + type: object + description: |- + Configuration parameters for the connector. These configurations + are the minimum set of key-value pairs which can be used to + define how the connector connects Kafka to the external system. + Some of these key-value pairs are common to all the connectors, such as + connection parameters to Kafka, connector metadata, etc. The list + of common connector configurations is as follows + - cloud.environment + - cloud.provider + - connector.class + - kafka.api.key + - kafka.api.secret + - kafka.endpoint + - kafka.region + - name + A specific connector such as `GcsSink` would have additional + parameters such as `gcs.bucket.name`, `flush.size`, etc. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: [aws, azure, gcp] + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.endpoint: + type: string + description: The Kafka cluster endpoint. + kafka.region: + type: string + description: The Kafka cluster region. + kafka.api.key: + type: string + description: The Kafka cluster API key. + kafka.api.secret: + type: string + description: The Kafka cluster API secret. + x-redact: true + additionalProperties: + type: string + tasks: + type: array + description: List of active tasks generated by the connector + items: + type: object + properties: + connector: + type: string + description: The name of the connector the task belongs to + task: + type: integer + description: Task ID within the connector + required: + - connector + - task + type: + type: string + description: Type of connector, sink or source + enum: [sink, source] + offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + required: + - name + - config + connect.v1.Connectors: + type: array + description: List of active task configs that have been created by the connector + items: + type: object + properties: + id: + type: object + description: The ID of task. + properties: + connector: + type: string + description: The name of the connector the task belongs to. + task: + type: integer + description: Task ID within the connector. + config: + type: object + description: |- + Configuration parameters for the connector. These configurations + are the minimum set of key-value pairs (KVP) which can be used to + define how the connector connects Kafka to the external system. + Some of these KVPs are common to all the connectors, such as + connection parameters to Kafka, connector metadata, etc. The list + of common connector configurations is as follows + + - cloud.environment + - cloud.provider + - connector.class + - kafka.api.key + - kafka.api.secret + - kafka.endpoint + - kafka.region + - name + + A specific connector such as `GcsSink` would have additional + parameters such as `gcs.bucket.name`, `flush.size`, etc. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: [aws, azure, gcp] + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, + etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.endpoint: + type: string + description: The kafka cluster endpoint. + kafka.region: + type: string + description: The kafka cluster region. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + additionalProperties: + type: string + connect.v1.ConnectorExpansionMap: + type: object + additionalProperties: + $ref: '#/components/schemas/connect.v1.ConnectorExpansion' + connect.v1.ConnectorExpansion: + type: object + description: Name of connector + properties: + id: + type: object + description: The ID of connector. + properties: + id: + type: string + description: The ID of the connector. + id_type: + type: string + description: Type of the value in the `id` property. + info: + type: object + description: Metadata of the connector. + properties: + name: + type: string + description: Name of the connector. + config: + type: object + description: |- + Configuration parameters for the connector. These configurations + are the minimum set of key-value pairs (KVP) which are used to + define how the connector connects Kafka to the external system. + Some of these KVPs are common to all the connectors, such as + connection parameters to Kafka, connector metadata, etc. The list + of common connector configurations is as follows + + - cloud.environment + - cloud.provider + - connector.class + - kafka.api.key + - kafka.api.secret + - kafka.endpoint + - kafka.region + - name + + For example, a connector like `GcsSink` would have additional + parameters such as `gcs.bucket.name`, `flush.size`, etc. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: [aws, azure, gcp] + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, + etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.endpoint: + type: string + description: The kafka cluster endpoint. + kafka.region: + type: string + description: The kafka cluster region. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + additionalProperties: + type: string + status: + type: object + description: Status of the connector and its tasks. + properties: + name: + type: string + description: The name of the connector. + type: + type: string + description: Type of connector, sink or source. + enum: [sink, source] + connector: + type: object + description: A map containing connector status. + required: + - state + - worker_id + properties: + state: + type: string + description: The state of the connector. + enum: + - NONE + - PROVISIONING + - RUNNING + - DEGRADED + - FAILED + - PAUSED + - DELETED + worker_id: + type: string + description: The worker ID of the connector. + trace: + type: string + description: Exception message in case of an error. + tasks: + type: array + description: A map containing the task status. + items: + type: object + properties: + id: + type: integer + description: The ID of task. + state: + type: string + description: The state of the task. + worker_id: + type: string + description: The worker ID of the task. + msg: + type: string + required: + - id + - state + - worker_id + required: + - name + - type + - connector + connect.v1.Offsets: + type: array + description: Array of offsets which are categorised into partitions. + items: + type: object + properties: + partition: + type: object + additionalProperties: true + description: |- + The partition information. For sink connectors this is the kafka topic and + partition. For source connectors this is depends on the partitions defined by the + source connector. For example, the table which this task is pulling data from in a + JDBC based MySQL source connector. + Please refer to the [documentation](https://docs.confluent.io/cloud/current/connectors/offsets.html#manage-offsets-for-fully-managed-connectors-in-ccloud) for + more information. + offset: + type: object + additionalProperties: true + description: |- + The offset of the partition. For sink connectors this is the kafka offset. For + source connectors this is depends on the offset defined by the source connector. + For example, the timestamp and incrementing column info in a table, for a JDBC based + MySQL source connector. + Please refer to the [documentation](https://docs.confluent.io/cloud/current/connectors/offsets.html#manage-offsets-for-fully-managed-connectors-in-ccloud) for + more information. + connect.v1.ConnectorOffsets: + type: object + description: Offsets for a connector + properties: + name: + type: string + description: The name of the connector. + id: + type: string + description: The ID of the connector. + offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + metadata: + type: object + description: Metadata of the connector offset. + properties: + observed_at: + type: string + format: date-time + example: 2024-02-20T15:14:19Z + readOnly: true + description: The time at which the offsets were observed. The time is + in UTC, ISO 8601 format. + connect.v1.AlterOffsetRequestType: + type: string + enum: + - PATCH + - DELETE + description: |- + The type of alter operation. PATCH will update the offset to the provided values. + The update will only happen for the partitions provided in the request. + DELETE will delete the offset for the provided partitions and reset them back to the + base state. It is as if, a fresh new connector was created. + + For sink connectors PATCH/DELETE will move the offsets to the provided point in the + topic partition. If the offset provided is not present in the topic partition it will + by default reset to the earliest offset in the topic partition. + + For source connectors, post PATCH/DELETE the connector will attempt to read from the + position defined in the altered offsets. + connect.v1.AlterOffsetRequest: + type: object + description: |- + Request to alter the offset of a connector. The offsets parameter is options for DELETE type. + properties: + type: + $ref: '#/components/schemas/connect.v1.AlterOffsetRequestType' + offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + required: + - type + connect.v1.AlterOffsetRequestInfo: + type: object + description: |- + The request made to alter offsets. + properties: + id: + type: string + description: The ID of the connector. + name: + type: string + description: The name of the connector. + offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + requested_at: + type: string + format: date-time + readOnly: true + example: 2024-02-20T15:14:19Z + description: The time at which the request was made. The time is in UTC, + ISO 8601 format. + type: + $ref: '#/components/schemas/connect.v1.AlterOffsetRequestType' + required: + - id + - name + - type + - requested_at + connect.v1.AlterOffsetStatus: + type: object + description: |- + Status of the alter offset operation. The previous offsets in the response + is the offsets that the connector last processed, before the offsets were altered, + via a patch or delete operation. + properties: + request: + $ref: '#/components/schemas/connect.v1.AlterOffsetRequestInfo' + status: + type: object + description: The response of the alter offsets operation. + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - PENDING_VALIDATION + - APPLIED + - FAILED + description: |- + The phase of the alter offset operation. + + PENDING: The offset alter operation is in progress. + + APPLIED: The offset alter operation has been applied to the connector. + + FAILED: The offset alter operation has failed to be applied to the connector. + message: + type: string + description: An info message from the alter offset operation. + required: + - phase + previous_offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + applied_at: + type: string + nullable: true + format: date-time + example: 2024-02-20T15:14:19Z + readOnly: true + description: The time at which the offsets were applied. The time is in + UTC, ISO 8601 format. + required: + - request + - status + connect.v1.CustomConnectorPlugin: + type: object + description: |- + CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connector Plugins. + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connector Plugins Model + + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/connect/v1/custom-connector-plugins/ccp-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/custom-connector-plugin=ccp-12345 + display_name: + type: string + description: Display name of Custom Connector Plugin. + maxLength: 60 + content_format: + type: string + example: ZIP + description: Archive format of Custom Connector Plugin. + x-extensible-enum: [ZIP, JAR] + readOnly: true + description: + type: string + description: Description of Custom Connector Plugin. + maxLength: 256 + documentation_link: + maxLength: 512 + type: string + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connector Plugin. + connector_class: + type: string + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + # yamllint disable-line rule:line-length + description: Java class or alias for connector. You can get connector class + from connector documentation provided by developer. + example: io.confluent.kafka.connect.datagen.DatagenConnector + x-immutable: true + connector_type: + type: string + description: | + Custom Connector type. + example: SOURCE + x-extensible-enum: [SOURCE, SINK] + x-immutable: true + cloud: + type: string + description: Cloud provider where the Custom Connector Plugin archive is + uploaded. + example: AWS + default: AWS + x-extensible-enum: [AWS, GCP, AZURE] + x-immutable: true + sensitive_config_properties: + type: array + # yamllint disable-line rule:line-length + description: | + A sensitive property is a connector configuration property that must be hidden after a user enters property + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: [passwords, keys, tokens] + upload_source: + type: object + oneOf: + - $ref: '#/components/schemas/connect.v1.UploadSource.PresignedUrl' + # yamllint disable-line rule:line-length + description: Upload source of Custom Connector Plugin. Only required in + `create` request, will be ignored in `read`, `update` or `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/connect.v1.UploadSource.PresignedUrl' + runtime_language: + type: string + example: JAVA + default: JAVA + description: Runtime language of Custom Connector Plugin. + x-extensible-enum: [JAVA, PYTHON] + connect.v1.PresignedUrl: + type: object + description: |- + Request a presigned upload URL for new Custom Connector Plugin. Note that + the URL policy expires in one hour. If the policy expires, you can request + a new presigned upload URL. + + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Presigned Urls Model + + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Custom Connector Plugin archive. + example: ZIP + x-extensible-enum: [ZIP, JAR] + readOnly: true + cloud: + type: string + description: Cloud provider where the Custom Connector Plugin archive is + uploaded. + example: AWS + x-extensible-enum: [AWS, GCP, AZURE] + readOnly: true + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Custom Connector Plugin archive. + example: https://confluent-custom-connectors-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: object + description: Upload form data of the Custom Connector Plugin. All values + should be strings. + example: + bucket: confluent-custom-connectors-stag-us-west-2 + # yamllint disable-line rule:line-length + key: staging/custom-plugin/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/connect-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/plugin.zip + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + # You can add other constraints or properties specific to this example if needed + readOnly: true + connect.v1.CustomConnectorRuntime: + type: object + description: |- + List of supported runtime languages for Custom Connector Plugin. The list defines the supported + entries for confluent.custom.connect.plugin.runtime attribute in CustomConnectorPlugin object. + Each entry also defines the set of supported java versions for that runtime which can be specified during + connector provisioning via the confluent.custom.connect.plugin.java.version attribute. + + + ## The Custom Connector Runtimes Model + + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorRuntime + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + custom_connect_plugin_runtime_name: + type: string + description: | + Name of the runtime that is being used while provisioning a custom connector. This corresponds to + the property custom.connect.plugin.runtime in the connector configuration. + example: 3.9.0 + readOnly: true + runtime_ak_version: + type: string + description: The underlying version of Apache Kafka which bundles the connect + runtime + example: 3.9.0 + readOnly: true + supported_java_versions: + type: array + description: List of supported Java versions + items: + type: string + example: ['11', '17'] + readOnly: true + product_maturity: + type: string + description: | + The product maturity phase for the plugin runtime. + EA (Early Access), GA (Generally Available), or Preview. + x-extensible-enum: [EA, GA, PREVIEW] + example: GA + readOnly: true + end_of_life_at: + type: string + format: date-time + description: End of Life date for the runtime + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: + type: string + description: Description of the runtime + example: Custom Connector Plugin runtime using AK 3.9.0 and supporting Java + 11 and 17 + readOnly: true + connect.v1.PresignedUrlRequest: + type: object + description: | + Request schema of the presigned upload URL. + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrlRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/connect/v1/presigned-url-requests/pur-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/presigned-url-request=pur-12345 + content_format: + type: string + example: ZIP + description: Archive format of the Custom Connector Plugin. + x-extensible-enum: [JAR, ZIP] + cloud: + type: string + example: AWS + default: AWS + description: Cloud provider where the Custom Connector Plugin archive is + uploaded. + x-extensible-enum: [AWS, GCP, AZURE] + connect.v1.UploadSource.PresignedUrl: + type: object + description: Presigned URL of the uploaded Custom Connector Plugin archive. + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: [PRESIGNED_URL_LOCATION] + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + # yamllint disable-line rule:line-length + description: Upload ID returned by the `/presigned-upload-url` API. This + field returns an empty string in all responses. + required: + - location + - upload_id + + connect.v1.CustomConnectorPluginList: + type: object + description: |- + CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connector Plugins. + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connector Plugins Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPluginList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/connect/v1/custom-connector-plugins + last: + example: https://api.confluent.cloud/connect/v1/custom-connector-plugins?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/connect/v1/custom-connector-plugins?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/connect/v1/custom-connector-plugins?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/connect.v1.CustomConnectorPlugin' + - type: object + required: + - id + - metadata + - display_name + - connector_class + - connector_type + - upload_source + uniqueItems: true + connect.v1.CustomConnectorRuntimeList: + type: object + description: |- + List of supported runtime languages for Custom Connector Plugin. The list defines the supported + entries for confluent.custom.connect.plugin.runtime attribute in CustomConnectorPlugin object. + Each entry also defines the set of supported java versions for that runtime which can be specified during + connector provisioning via the confluent.custom.connect.plugin.java.version attribute. + + + ## The Custom Connector Runtimes Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorRuntimeList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/connect/v1/custom-connector-runtimes + last: + example: https://api.confluent.cloud/connect/v1/custom-connector-runtimes?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/connect/v1/custom-connector-runtimes?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/connect/v1/custom-connector-runtimes?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/connect.v1.CustomConnectorRuntime' + - type: object + required: + - id + uniqueItems: true + AbstractConfigData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - name + - is_default + - is_read_only + - is_sensitive + - source + - synonyms + properties: + cluster_id: + type: string + name: + type: string + value: + type: string + nullable: true + is_default: + type: boolean + is_read_only: + type: boolean + is_sensitive: + type: boolean + source: + $ref: '#/components/schemas/ConfigSource' + synonyms: + type: array + items: + $ref: '#/components/schemas/ConfigSynonymData' + # Currently the aggregator script doesn't merge correctly some + # otherwise identical parts of duplicate components defined in + # both kafka-rest and ce-kafka-rest's OpenAPI specs. + # In some cases this can be handled by slightly tweaking the + # input specs, but in other cases this requires manual + # intervention in the consolidated specs after the generation. + # We should eventually fix the aggregator script, but in the + # meantime, we should be careful during reviews, making sure + # that comments like this do not get replaced by wrongly + # merged autogenerated content. + # See https://github.com/confluentinc/ce-kafka-rest/pull/227. + + AclData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - resource_type + - resource_name + - pattern_type + - principal + - host + - operation + - permission + properties: + cluster_id: + type: string + resource_type: + $ref: '#/components/schemas/AclResourceType' + resource_name: + type: string + pattern_type: + $ref: '#/components/schemas/AclPatternType' + principal: + type: string + host: + type: string + operation: + $ref: '#/components/schemas/AclOperation' + permission: + $ref: '#/components/schemas/AclPermission' + + AclDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/AclData' + + AclOperation: + type: string + x-extensible-enum: + - UNKNOWN + - ANY + - ALL + - READ + - WRITE + - CREATE + - DELETE + - ALTER + - DESCRIBE + - CLUSTER_ACTION + - DESCRIBE_CONFIGS + - ALTER_CONFIGS + - IDEMPOTENT_WRITE + + AclPatternType: + type: string + x-extensible-enum: + - UNKNOWN + - ANY + - MATCH + - LITERAL + - PREFIXED + + AclPermission: + type: string + x-extensible-enum: + - UNKNOWN + - ANY + - DENY + - ALLOW + + AclResourceType: + type: string + enum: + - UNKNOWN + - ANY + - TOPIC + - GROUP + - CLUSTER + - TRANSACTIONAL_ID + - DELEGATION_TOKEN + + AlterConfigBatchRequestData: + type: object + required: + - data + properties: + data: + type: array + items: + type: object + required: + - name + properties: + name: + type: string + value: + type: string + nullable: true + operation: + type: string + x-extensible-enum: + - SET + - DELETE + nullable: true + validate_only: + type: boolean + + AnyValue: + nullable: true + + AuthorizedOperations: + type: array + items: + type: string + x-extensible-enum: + - UNKNOWN + - ALL + - READ + - WRITE + - CREATE + - DELETE + - ALTER + - DESCRIBE + - CLUSTER_ACTION + - DESCRIBE_CONFIGS + - ALTER_CONFIGS + - IDEMPOTENT_WRITE + + BrokerConfigData: + allOf: + - $ref: '#/components/schemas/AbstractConfigData' + - type: object + required: + - broker_id + properties: + broker_id: + type: integer + + BrokerConfigDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/BrokerConfigData' + + BrokerData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - broker_id + - configs + - partition_replicas + properties: + cluster_id: + type: string + broker_id: + type: integer + host: + type: string + nullable: true + port: + type: integer + nullable: true + rack: + type: string + nullable: true + configs: + $ref: '#/components/schemas/Relationship' + partition_replicas: + $ref: '#/components/schemas/Relationship' + + BrokerDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/BrokerData' + + ClusterConfigData: + allOf: + - $ref: '#/components/schemas/AbstractConfigData' + - type: object + required: + - config_type + properties: + config_type: + $ref: '#/components/schemas/ClusterConfigType' + + ClusterConfigDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ClusterConfigData' + + ClusterConfigType: + type: string + x-extensible-enum: + - BROKER + + ClusterData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - acls + - brokers + - broker_configs + - consumer_groups + - topics + - partition_reassignments + properties: + cluster_id: + type: string + controller: + $ref: '#/components/schemas/Relationship' + acls: + $ref: '#/components/schemas/Relationship' + brokers: + $ref: '#/components/schemas/Relationship' + broker_configs: + $ref: '#/components/schemas/Relationship' + consumer_groups: + $ref: '#/components/schemas/Relationship' + topics: + $ref: '#/components/schemas/Relationship' + partition_reassignments: + $ref: '#/components/schemas/Relationship' + + ClusterDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ClusterData' + + CreateAclRequestData: + type: object + required: + - resource_type + - resource_name + - pattern_type + - principal + - host + - operation + - permission + properties: + resource_type: + $ref: '#/components/schemas/AclResourceType' + resource_name: + type: string + pattern_type: + $ref: '#/components/schemas/AclPatternType' + principal: + type: string + host: + type: string + operation: + $ref: '#/components/schemas/AclOperation' + permission: + $ref: '#/components/schemas/AclPermission' + + CreateAclRequestDataList: + allOf: + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/CreateAclRequestData' + + CreateTopicRequestData: + type: object + required: + - topic_name + properties: + topic_name: + type: string + partitions_count: + type: integer + replication_factor: + type: integer + configs: + type: array + items: + type: object + required: + - name + properties: + name: + type: string + value: + type: string + nullable: true + validate_only: + type: boolean + + ConfigSource: + type: string + x-extensible-enum: + - DYNAMIC_CLUSTER_LINK_CONFIG + - DYNAMIC_TOPIC_CONFIG + - DYNAMIC_BROKER_LOGGER_CONFIG + - DYNAMIC_BROKER_CONFIG + - DYNAMIC_DEFAULT_BROKER_CONFIG + - STATIC_BROKER_CONFIG + - DEFAULT_CONFIG + - UNKNOWN + # Currently the aggregator script doesn't merge correctly some + # otherwise identical parts of duplicate components defined in + # both kafka-rest and ce-kafka-rest's OpenAPI specs. + # In some cases this can be handled by slightly tweaking the + # input specs, but in other cases this requires manual + # intervention in the consolidated specs after the generation. + # We should eventually fix the aggregator script, but in the + # meantime, we should be careful during reviews, making sure + # that comments like this do not get replaced by wrongly + # merged autogenerated content. + # See https://github.com/confluentinc/ce-kafka-rest/pull/227. + + ConfigSynonymData: + type: object + required: + - name + - source + properties: + name: + type: string + value: + type: string + nullable: true + source: + $ref: '#/components/schemas/ConfigSource' + + ConsumerAssignmentData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - consumer_group_id + - consumer_id + - topic_name + - partition_id + - partition + - lag + properties: + cluster_id: + type: string + consumer_group_id: + type: string + consumer_id: + type: string + topic_name: + type: string + partition_id: + type: integer + partition: + $ref: '#/components/schemas/Relationship' + lag: + $ref: '#/components/schemas/Relationship' + + ConsumerAssignmentDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ConsumerAssignmentData' + + ConsumerData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - consumer_group_id + - consumer_id + - client_id + - assignments + properties: + cluster_id: + type: string + consumer_group_id: + type: string + consumer_id: + type: string + instance_id: + type: string + nullable: true + client_id: + type: string + assignments: + $ref: '#/components/schemas/Relationship' + + ConsumerDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ConsumerData' + + ConsumerGroupData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - consumer_group_id + - is_simple + - partition_assignor + - state + - type + - is_mixed_consumer_group + - coordinator + - consumers + - lag_summary + properties: + cluster_id: + type: string + consumer_group_id: + type: string + is_simple: + type: boolean + partition_assignor: + type: string + state: + $ref: '#/components/schemas/ConsumerGroupState' + type: + $ref: '#/components/schemas/ConsumerGroupType' + is_mixed_consumer_group: + type: boolean + coordinator: + $ref: '#/components/schemas/Relationship' + consumers: + $ref: '#/components/schemas/Relationship' + lag_summary: + $ref: '#/components/schemas/Relationship' + + ConsumerGroupDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ConsumerGroupData' + + ConsumerGroupState: + type: string + x-extensible-enum: + - UNKNOWN + - PREPARING_REBALANCE + - COMPLETING_REBALANCE + - ASSIGNING + - RECONCILING + - STABLE + - DEAD + - EMPTY + + ConsumerGroupType: + type: string + x-extensible-enum: + - UNKNOWN + - CLASSIC + - CONSUMER + - SHARE + + ConsumerLagData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - consumer_group_id + - topic_name + - partition_id + - current_offset + - log_end_offset + - lag + - consumer_id + - client_id + properties: + cluster_id: + type: string + consumer_group_id: + type: string + topic_name: + type: string + partition_id: + type: integer + current_offset: + type: integer + format: int64 + log_end_offset: + type: integer + format: int64 + lag: + type: integer + format: int64 + consumer_id: + type: string + instance_id: + type: string + nullable: true + client_id: + type: string + + ConsumerLagDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ConsumerLagData' + + ConsumerGroupLagSummaryData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - consumer_group_id + - max_lag_consumer_id + - max_lag_client_id + - max_lag_topic_name + - max_lag_partition_id + - max_lag + - total_lag + - max_lag_consumer + - max_lag_partition + properties: + cluster_id: + type: string + consumer_group_id: + type: string + max_lag_consumer_id: + type: string + max_lag_instance_id: + type: string + nullable: true + max_lag_client_id: + type: string + max_lag_topic_name: + type: string + max_lag_partition_id: + type: integer + max_lag: + type: integer + format: int64 + total_lag: + type: integer + format: int64 + max_lag_consumer: + $ref: '#/components/schemas/Relationship' + max_lag_partition: + $ref: '#/components/schemas/Relationship' + + PartitionData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - topic_name + - partition_id + - replicas + - reassignment + properties: + cluster_id: + type: string + topic_name: + type: string + partition_id: + type: integer + leader: + $ref: '#/components/schemas/Relationship' + replicas: + $ref: '#/components/schemas/Relationship' + reassignment: + $ref: '#/components/schemas/Relationship' + + PartitionDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/PartitionData' + + ProduceResponse: + type: object + required: + - error_code + properties: + error_code: + type: integer + format: int32 + message: + type: string + cluster_id: + type: string + topic_name: + type: string + partition_id: + type: integer + format: int32 + offset: + type: integer + format: int64 + timestamp: + type: string + format: date-time + nullable: true + key: + $ref: '#/components/schemas/ProduceResponseData' + value: + $ref: '#/components/schemas/ProduceResponseData' + + ProduceResponseData: + type: object + required: + - size + - type + properties: + size: + type: integer + type: + type: string + x-extensible-enum: + - BINARY + - JSON + - STRING + nullable: true + + ProduceRequest: + type: object + properties: + partition_id: + type: integer + nullable: true + format: int32 + headers: + type: array + items: + $ref: '#/components/schemas/ProduceRequestHeader' + key: + $ref: '#/components/schemas/ProduceRequestData' + value: + $ref: '#/components/schemas/ProduceRequestData' + timestamp: + type: string + format: date-time + nullable: true + + ProduceRequestData: + type: object + properties: + type: + type: string + x-extensible-enum: + - BINARY + - JSON + - STRING + data: + $ref: '#/components/schemas/AnyValue' + nullable: true + + ProduceRequestHeader: + type: object + required: + - name + properties: + name: + type: string + value: + type: string + format: byte + nullable: true + + ReassignmentData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - topic_name + - partition_id + - adding_replicas + - removing_replicas + - replicas + properties: + cluster_id: + type: string + topic_name: + type: string + partition_id: + type: integer + adding_replicas: + type: array + items: + type: integer + removing_replicas: + type: array + items: + type: integer + replicas: + $ref: '#/components/schemas/Relationship' + + ReassignmentDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ReassignmentData' + + Relationship: + type: object + required: + - related + properties: + related: + type: string + + ReplicaData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - topic_name + - partition_id + - broker_id + - is_leader + - is_in_sync + - broker + properties: + cluster_id: + type: string + topic_name: + type: string + partition_id: + type: integer + broker_id: + type: integer + is_leader: + type: boolean + is_in_sync: + type: boolean + broker: + $ref: '#/components/schemas/Relationship' + + ReplicaDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ReplicaData' + + Resource: + type: object + required: + - kind + - metadata + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + + ResourceCollection: + type: object + required: + - kind + - metadata + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + + ResourceCollectionMetadata: + type: object + required: + - self + properties: + self: + type: string + next: + type: string + nullable: true + + ResourceMetadata: + type: object + required: + - self + properties: + self: + type: string + resource_name: + type: string + nullable: true + + ShareGroupConsumerAssignmentData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - group_id + - consumer_id + - topic_name + - partition_id + - partition + properties: + cluster_id: + type: string + group_id: + type: string + consumer_id: + type: string + topic_name: + type: string + partition_id: + type: integer + partition: + $ref: '#/components/schemas/Relationship' + + ShareGroupConsumerAssignmentDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ShareGroupConsumerAssignmentData' + + + ShareGroupDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ShareGroupData' + + ShareGroupData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - share_group_id + - state + - coordinator + - consumers + - consumer_count + - partition_count + properties: + cluster_id: + type: string + share_group_id: + type: string + state: + $ref: '#/components/schemas/ShareGroupState' + coordinator: + $ref: '#/components/schemas/Relationship' + consumers: + $ref: '#/components/schemas/Relationship' + consumer_count: + type: integer + format: int32 + description: Number of consumers in this share group + partition_count: + type: integer + format: int32 + description: Total number of partitions assigned to this share group + across all consumers + assigned_topic_partitions: + type: array + items: + $ref: '#/components/schemas/ShareGroupTopicPartitionData' + description: List of topic-partitions assigned to this share group, + including those from empty groups + + ShareGroupState: + type: string + x-extensible-enum: + - UNKNOWN + - PREPARING_REBALANCE + - COMPLETING_REBALANCE + - STABLE + - DEAD + - EMPTY + + ShareGroupTopicPartitionData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - topic_name + - partition_id + - partition + properties: + topic_name: + type: string + description: The name of the topic + partition_id: + type: integer + format: int32 + description: The partition ID + partition: + $ref: '#/components/schemas/Relationship' + description: Link to the topic partition + + + ShareGroupConsumerData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - group_id + - consumer_id + - client_id + - assignments + properties: + cluster_id: + type: string + group_id: + type: string + consumer_id: + type: string + client_id: + type: string + assignments: + $ref: '#/components/schemas/Relationship' + + ShareGroupConsumerDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ShareGroupConsumerData' + + GroupConfigData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - group_id + - name + - is_default + - is_read_only + - is_sensitive + - source + - synonyms + properties: + cluster_id: + type: string + group_id: + type: string + name: + type: string + value: + type: string + nullable: true + is_default: + type: boolean + is_read_only: + type: boolean + is_sensitive: + type: boolean + source: + $ref: '#/components/schemas/ConfigSource' + synonyms: + type: array + items: + $ref: '#/components/schemas/ConfigSynonymData' + + GroupConfigDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/GroupConfigData' + + UpdateGroupConfigRequestData: + properties: + value: + type: string + required: + - value + type: object + + TopicConfigData: + allOf: + - $ref: '#/components/schemas/AbstractConfigData' + - type: object + required: + - topic_name + properties: + topic_name: + type: string + # Currently the aggregator script doesn't merge correctly some + # otherwise identical parts of duplicate components defined in + # both kafka-rest and ce-kafka-rest's OpenAPI specs. + # In some cases this can be handled by slightly tweaking the + # input specs, but in other cases this requires manual + # intervention in the consolidated specs after the generation. + # We should eventually fix the aggregator script, but in the + # meantime, we should be careful during reviews, making sure + # that comments like this do not get replaced by wrongly + # merged autogenerated content. + # See https://github.com/confluentinc/ce-kafka-rest/pull/227. + + TopicConfigDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/TopicConfigData' + # Currently the aggregator script doesn't merge correctly some + # otherwise identical parts of duplicate components defined in + # both kafka-rest and ce-kafka-rest's OpenAPI specs. + # In some cases this can be handled by slightly tweaking the + # input specs, but in other cases this requires manual + # intervention in the consolidated specs after the generation. + # We should eventually fix the aggregator script, but in the + # meantime, we should be careful during reviews, making sure + # that comments like this do not get replaced by wrongly + # merged autogenerated content. + # See https://github.com/confluentinc/ce-kafka-rest/pull/227. + + TopicData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - topic_name + - is_internal + - replication_factor + - partitions_count + - partitions + - configs + - partition_reassignments + properties: + cluster_id: + type: string + topic_name: + type: string + is_internal: + type: boolean + replication_factor: + type: integer + partitions_count: + type: integer + partitions: + $ref: '#/components/schemas/Relationship' + configs: + $ref: '#/components/schemas/Relationship' + partition_reassignments: + $ref: '#/components/schemas/Relationship' + authorized_operations: + $ref: '#/components/schemas/AuthorizedOperations' + + TopicDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/TopicData' + + UpdateConfigRequestData: + type: object + properties: + value: + type: string + nullable: true + + UpdatePartitionCountRequestData: + type: object + required: + - partitions_count + properties: + partitions_count: + type: integer + format: int32 + + StreamsGroupState: + description: The state of the Streams group. + type: string + x-extensible-enum: + - UNKNOWN + - PREPARING_REBALANCE + - COMPLETING_REBALANCE + - STABLE + - DEAD + - EMPTY + - ASSIGNING + - RECONCILING + - NOT_READY + + AssignmentsType: + description: The type of the Streams task assignments. + type: string + x-extensible-enum: + - ACTIVE + - STANDBY + - WARMUP + + StreamsGroupDataList: + description: The list of Streams groups. + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + description: The array of Streams group details. + items: + $ref: '#/components/schemas/StreamsGroupData' + + StreamsGroupData: + description: The details of a Streams group. + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - group_id + - state + - member_count + - subtopology_count + - group_epoch + - topology_epoch + - target_assignment_epoch + - members + - subtopologies + properties: + cluster_id: + type: string + description: The unique identifier of the Kafka cluster. + group_id: + type: string + description: The unique identifier of the Streams group. + state: + $ref: '#/components/schemas/StreamsGroupState' + member_count: + type: integer + description: The number of members in the Streams group. + subtopology_count: + type: integer + description: The number of subtopologies in the Streams group. + group_epoch: + type: integer + description: The epoch of the Streams group. + topology_epoch: + type: integer + description: The epoch of the Streams topology. + target_assignment_epoch: + type: integer + description: The epoch of the target assignment. + members: + $ref: '#/components/schemas/Relationship' + subtopologies: + $ref: '#/components/schemas/Relationship' + + StreamsGroupSubtopologyDataList: + description: The list of Streams group subtopologies. + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + description: The array of Streams group subtopology details. + items: + $ref: '#/components/schemas/StreamsGroupSubtopologyData' + + StreamsGroupSubtopologyData: + description: The details of a Streams group subtopology. + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - group_id + - subtopology_id + - source_topics + properties: + cluster_id: + type: string + description: The unique identifier of the Kafka cluster. + group_id: + type: string + description: The unique identifier of the Streams group. + subtopology_id: + type: string + description: The unique identifier of the Streams subtopology. + source_topics: + type: array + description: The list of source topics for the subtopology. + items: + type: string + description: The name of a source topic. + + StreamsGroupMemberDataList: + description: The list of Streams group members. + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + description: The array of Streams group member details. + items: + $ref: '#/components/schemas/StreamsGroupMemberData' + + StreamsGroupMemberData: + description: The details of a Streams group member. + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - group_id + - member_id + - process_id + - client_id + - instance_id + - member_epoch + - topology_epoch + - is_classic + - assignments + - target_assignment + properties: + cluster_id: + type: string + description: The unique identifier of the Kafka cluster. + group_id: + type: string + description: The unique identifier of the Streams group. + member_id: + type: string + description: The unique identifier of the Streams group member. + process_id: + type: string + description: The process identifier of the Streams group member. + client_id: + type: string + description: The client identifier of the Streams group member. + instance_id: + type: string + description: The instance identifier of the Streams group member. + member_epoch: + type: integer + description: The epoch of the Streams group member. + topology_epoch: + type: integer + description: The epoch of the Streams topology for the member. + is_classic: + type: boolean + description: The flag indicating if the member is a classic consumer. + assignments: + $ref: '#/components/schemas/Relationship' + target_assignment: + $ref: '#/components/schemas/Relationship' + + StreamsGroupMemberAssignmentData: + description: The assignment details of a Streams group member. + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - group_id + - member_id + - active_tasks + - standby_tasks + - warmup_tasks + properties: + cluster_id: + type: string + description: The unique identifier of the Kafka cluster. + group_id: + type: string + description: The unique identifier of the Streams group. + member_id: + type: string + description: The unique identifier of the Streams group member. + active_tasks: + $ref: '#/components/schemas/Relationship' + standby_tasks: + $ref: '#/components/schemas/Relationship' + warmup_tasks: + $ref: '#/components/schemas/Relationship' + + StreamsTaskDataList: + description: The list of Streams tasks. + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + description: The array of Streams task details. + items: + $ref: '#/components/schemas/StreamsTaskData' + + StreamsTaskData: + description: The details of a Streams task. + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - subtopology_id + - partition_ids + properties: + subtopology_id: + type: string + description: The unique identifier of the Streams subtopology. + partition_ids: + type: array + description: The list of partition IDs assigned to the Streams task. + items: + type: integer + description: The partition ID. + + ReplicaStatusData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - topic_name + - broker_id + - partition_id + - is_leader + - is_observer + - is_isr_eligible + - is_in_isr + - is_caught_up + - log_start_offset + - log_end_offset + - last_caught_up_time_ms + - last_fetch_time_ms + properties: + cluster_id: + type: string + topic_name: + type: string + broker_id: + type: integer + format: int32 + partition_id: + type: integer + format: int32 + is_leader: + type: boolean + is_observer: + type: boolean + is_isr_eligible: + type: boolean + is_in_isr: + type: boolean + is_caught_up: + type: boolean + log_start_offset: + format: int64 + type: integer + log_end_offset: + format: int64 + type: integer + last_caught_up_time_ms: + format: int64 + type: integer + last_fetch_time_ms: + format: int64 + type: integer + link_name: + type: string + + ReplicaStatusDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ReplicaStatusData' + + AnyUnevenLoadData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - status + - previous_status + - status_updated_at + - previous_status_updated_at + - broker_tasks + properties: + cluster_id: + type: string + status: + $ref: '#/components/schemas/AnyUnevenLoadStatus' + previous_status: + $ref: '#/components/schemas/AnyUnevenLoadStatus' + status_updated_at: + type: string + format: date-time + example: '2019-10-12T07:20:50Z' + readOnly: true + description: The date and time at which this task was created. + previous_status_updated_at: + type: string + format: date-time + example: '2019-10-12T07:20:50Z' + readOnly: true + description: The date and time at which this task was created. + error_code: + type: integer + nullable: true + error_message: + type: string + nullable: true + broker_tasks: + $ref: '#/components/schemas/Relationship' + + BalancerStatusData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - status + - any_uneven_load + - broker_tasks + properties: + cluster_id: + type: string + status: + $ref: '#/components/schemas/BalancerStatus' + error_code: + type: integer + nullable: true + error_message: + type: string + nullable: true + any_uneven_load: + $ref: '#/components/schemas/Relationship' + broker_tasks: + $ref: '#/components/schemas/Relationship' + + BrokerRemovalData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - broker_id + - broker_task + - broker + properties: + cluster_id: + type: string + broker_id: + type: integer + broker_task: + $ref: '#/components/schemas/Relationship' + broker: + $ref: '#/components/schemas/Relationship' + + BrokerRemovalDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/BrokerRemovalData' + + BrokerTaskData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - broker_id + - task_type + - task_status + - sub_task_statuses + - created_at + - updated_at + - broker + properties: + cluster_id: + type: string + broker_id: + type: integer + task_type: + $ref: '#/components/schemas/BrokerTaskType' + task_status: + $ref: '#/components/schemas/BrokerTaskStatus' + shutdown_scheduled: + type: boolean + nullable: true + sub_task_statuses: + type: object + additionalProperties: + type: string + created_at: + type: string + format: date-time + example: '2019-10-12T07:20:50Z' + readOnly: true + description: The date and time at which this task was created. + updated_at: + type: string + format: date-time + example: '2019-10-12T07:20:50Z' + readOnly: true + description: The date and time at which this task was last updated. + error_code: + type: integer + nullable: true + error_message: + type: string + nullable: true + broker: + $ref: '#/components/schemas/Relationship' + + BrokerTaskDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/BrokerTaskData' + + BrokerReplicaExclusionRequestData: + type: object + required: + - broker_id + - reason + properties: + broker_id: + type: integer + reason: + type: string + + BrokerReplicaExclusionBatchRequestData: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/BrokerReplicaExclusionRequestData' + + BrokerReplicaExclusionData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - broker_id + - reason + - broker + properties: + cluster_id: + type: string + broker_id: + type: integer + reason: + type: string + broker: + $ref: '#/components/schemas/Relationship' + + BrokerReplicaExclusionDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/BrokerReplicaExclusionData' + + AlterBrokerReplicaExclusionData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - broker_id + - exclusion + - reason + - broker + properties: + cluster_id: + type: string + broker_id: + type: integer + exclusion: + $ref: '#/components/schemas/ExclusionOp' + reason: + type: string + error_code: + type: integer + nullable: true + error_message: + type: string + nullable: true + broker: + $ref: '#/components/schemas/Relationship' + + AlterBrokerReplicaExclusionDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/AlterBrokerReplicaExclusionData' + + RemoveBrokerTaskData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - broker_id + - shutdown_scheduled + - broker_replica_exclusion_status + - partition_reassignment_status + - broker_shutdown_status + - broker + properties: + cluster_id: + type: string + broker_id: + type: integer + shutdown_scheduled: + type: boolean + broker_replica_exclusion_status: + $ref: '#/components/schemas/BrokerReplicaExclusionStatus' + partition_reassignment_status: + $ref: '#/components/schemas/DeprecatedPartitionReassignmentStatus' + broker_shutdown_status: + $ref: '#/components/schemas/DeprecatedBrokerShutdownStatus' + error_code: + type: integer + nullable: true + error_message: + type: string + nullable: true + broker: + $ref: '#/components/schemas/Relationship' + + RemoveBrokerTaskDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/RemoveBrokerTaskData' + + ConfigData: + example: + name: name + value: value + properties: + name: + type: string + value: + nullable: true + type: string + required: + - name + - value + + CreateLinkRequestData: + properties: + source_cluster_id: + type: string + destination_cluster_id: + type: string + remote_cluster_id: + description: The expected remote cluster ID. + type: string + cluster_link_id: + description: The expected cluster link ID. Can be provided when creating + the second side of a bidirectional link for validating the link ID is + as expected. If it's not provided, it's inferred from the remote cluster. + type: string + configs: + items: + $ref: '#/components/schemas/ConfigData' + type: array + type: object + + UpdateLinkConfigRequestData: + properties: + value: + type: string + required: + - value + type: object + + LinkState: + type: string + x-extensible-enum: + - ACTIVE + - FAILED + - UNAVAILABLE + - PAUSED + - UNKNOWN + + LinkError: + type: string + x-extensible-enum: + - UNKNOWN + - NO_ERROR + - AUTHENTICATION_ERROR + - UNRESOLVABLE_BOOTSTRAP_ERROR + - INVALID_BOOTSTRAP_INTERNAL_ENDPOINT_ERROR + - BOOTSTRAP_TCP_CONNECTION_FAILED_ERROR + - TIMEOUT_ERROR + + LinkTask: + type: object + required: + - task_name + - state + - errors + properties: + task_name: + type: string + state: + $ref: '#/components/schemas/LinkTaskState' + errors: + type: array + items: + $ref: '#/components/schemas/LinkTaskError' + + LinkCategory: + type: object + required: + - state_category + - count + properties: + state_category: + $ref: '#/components/schemas/StateCategory' + count: + type: integer + format: int32 + example: 123 + + StateCategory: + type: string + x-extensible-enum: + - PAUSED + - IN_ERROR + - PENDING + - ACTIVE + - NOT_APPLICABLE + + LinkTaskError: + type: object + required: + - error_code + - error_message + properties: + error_code: + type: string + error_message: + type: string + + LinkTaskState: + type: string + x-extensible-enum: + - UNKNOWN + - ACTIVE + - IN_ERROR + - NOT_CONFIGURED + - LINK_FAILED + - LINK_UNAVAILABLE + - LINK_PAUSED + + LinkTaskErrorCode: + type: string + x-extensible-enum: + - UNKNOWN + - NO_ERROR + - INTERNAL_ERROR + - AUTHENTICATION_ERROR + - BROKER_AUTHENTICATION_ERROR + - MISCONFIGURATION_ERROR + - REMOTE_LINK_NOT_FOUND_ERROR + - LINK_NOT_FOUND_ERROR + - CONSUMER_GROUP_IN_USE_ERROR + - AUTHORIZATION_ERROR + - BROKER_AUTHORIZATION_ERROR + - SECURITY_DISABLED_ERROR + - TOPIC_EXISTS_ERROR + - POLICY_VIOLATION_ERROR + - LINK_COORDINATOR_NOT_ENABLED_ERROR + - ACL_LIMIT_EXCEEDED + - REMOTE_MIRROR_NOT_FOUND_ERROR + - UNKNOWN_TOPIC_OR_PARTITION_ERROR + - INVALID_TOPIC + - SUPPRESSED_ERRORS + - INVALID_REQUEST_ERROR + + ListLinksResponseData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - link_name + - cluster_link_id + - topic_names + properties: + source_cluster_id: + type: string + nullable: true + destination_cluster_id: + type: string + nullable: true + remote_cluster_id: + type: string + nullable: true + link_name: + type: string + link_id: + type: string + deprecated: true + cluster_link_id: + type: string + topic_names: + type: array + items: + type: string + link_error: + $ref: '#/components/schemas/LinkError' + nullable: true + link_error_message: + type: string + nullable: true + link_state: + $ref: '#/components/schemas/LinkState' + nullable: true + tasks: + nullable: true + type: array + items: + $ref: '#/components/schemas/LinkTask' + category_counts: + nullable: true + type: array + items: + $ref: '#/components/schemas/LinkCategory' + + + # This schema also exists in kafka-rest/api/v3/openapi.yaml. The aggregator script is not + # handling that correctly and is duplicating the required and enum sections below. They have + # been commented out, so that consolidated-openapi.yaml is generated correctly. + ListLinksResponseDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ListLinksResponseData' + + ListLinkConfigsResponseData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - cluster_id + - name + - value + - is_default + - is_read_only + - is_sensitive + - source + - synonyms + - link_name + properties: + cluster_id: + type: string + name: + type: string + value: + type: string + is_default: + type: boolean + is_read_only: + type: boolean + is_sensitive: + type: boolean + source: + type: string + x-extensible-enum: + - DYNAMIC_CLUSTER_LINK_CONFIG + synonyms: + type: array + items: + type: string + link_name: + type: string + + ListLinkConfigsResponseDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ListLinkConfigsResponseData' + + CreateMirrorTopicRequestData: + properties: + source_topic_name: + type: string + mirror_topic_name: + type: string + replication_factor: + type: integer + configs: + type: array + items: + $ref: '#/components/schemas/ConfigData' + required: + - source_topic_name + type: object + + AlterMirrorsRequestData: + properties: + mirror_topic_names: + description: The mirror topics specified as a list of topic names. + type: array + items: + type: string + mirror_topic_name_pattern: + description: The mirror topics specified as a pattern. + type: string + type: object + + ListMirrorTopicsResponseData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - link_name + - mirror_topic_name + - source_topic_name + - num_partitions + - mirror_lags + - mirror_status + - state_time_ms + properties: + link_name: + type: string + mirror_topic_name: + type: string + source_topic_name: + type: string + num_partitions: + type: integer + mirror_lags: + $ref: '#/components/schemas/MirrorLags' + mirror_status: + $ref: '#/components/schemas/MirrorTopicStatus' + mirror_topic_error: + $ref: '#/components/schemas/MirrorTopicError' + state_time_ms: + type: integer + format: int64 + mirror_state_transition_errors: + type: array + items: + $ref: '#/components/schemas/LinkTaskError' + + ListMirrorTopicsResponseDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ListMirrorTopicsResponseData' + + AlterMirrorStatusResponseData: + allOf: + - $ref: '#/components/schemas/Resource' + - type: object + required: + - mirror_topic_name + - error_message + - error_code + - mirror_lags + - messages_truncated + - partition_level_truncation_data + properties: + mirror_topic_name: + type: string + error_message: + type: string + nullable: true + error_code: + type: integer + nullable: true + mirror_lags: + $ref: '#/components/schemas/MirrorLags' + messages_truncated: + type: integer + format: int64 + nullable: true + partition_level_truncation_data: + $ref: '#/components/schemas/PartitionLevelTruncationDataList' + nullable: true + + AlterMirrorStatusResponseDataList: + allOf: + - $ref: '#/components/schemas/ResourceCollection' + - type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/AlterMirrorStatusResponseData' + + RemoveBrokersRequestData: + properties: + broker_ids: + type: array + items: + type: integer + required: + - broker_ids + type: object + + PartitionLevelTruncationDataList: + type: array + items: + $ref: '#/components/schemas/PartitionLevelTruncationData' + + PartitionLevelTruncationData: + type: object + required: + - partition_id + - offset_truncated_to + - messages_truncated + properties: + partition_id: + type: integer + offset_truncated_to: + type: integer + format: int64 + messages_truncated: + type: integer + format: int64 + + MirrorLags: + type: array + items: + $ref: '#/components/schemas/MirrorLag' + + MirrorLag: + type: object + required: + - partition + - lag + - last_source_fetch_offset + properties: + partition: + type: integer + lag: + type: integer + format: int64 + last_source_fetch_offset: + type: integer + format: int64 + + MirrorTopicStatus: + enum: + - ACTIVE + - FAILED + - LINK_FAILED + - LINK_PAUSED + - PAUSED + - PENDING_STOPPED + - SOURCE_UNAVAILABLE + - STOPPED + - PENDING_MIRROR + - PENDING_SYNCHRONIZE + - PENDING_SETUP_FOR_RESTORE + - PENDING_RESTORE + type: string + + MirrorTopicError: + type: string + x-extensible-enum: + - UNKNOWN + - NOT_SET + - NO_ERROR + - SOURCE_TOPIC_MAY_BE_DELETED + - SOURCE_TOPIC_ID_CHANGED + - SOURCE_PARTITIONS_DECREASED + - NON_MONOTONIC_LOG_APPEND_EPOCH + - UNEXPECTED_TRUNCATION + - UNSUPPORTED_MESSAGE_FORMAT + - NON_MONOTONIC_SOURCE_EPOCH + - ILLEGAL_STATE + - UNSUPPORTED_MIRROR_STATE + + AnyUnevenLoadStatus: + type: string + x-extensible-enum: + - STARTING + - BALANCING + - BALANCED + - BALANCING_FAILED + - DISABLED + - ABORTED + - UNKNOWN + + BalancerStatus: + type: string + x-extensible-enum: + - BOOTSTRAPPING + - STARTING + - ENABLED + - ERROR + - DISABLED + - FAILOVER + - LOAD_FAILURE + - UNKNOWN + + BrokerTaskType: + type: string + enum: + - add-broker + - remove-broker + + BrokerTaskStatus: + type: string + x-extensible-enum: + - FAILED + - IN_PROGRESS + - SUCCESS + - UNKNOWN + + ExclusionOp: + type: string + x-extensible-enum: + - SET + - DELETE + - UNKNOWN + + BrokerReplicaExclusionStatus: + type: string + x-extensible-enum: + - PENDING + - IN_PROGRESS + - EXCLUDED + - REMOVING + - ERROR + - CANCELED + - COMPLETED + - UNKNOWN + + DeprecatedPartitionReassignmentStatus: + type: string + x-extensible-enum: + - CANCELED + - FAILED + - PENDING + - IN_PROGRESS + - COMPLETE + + DeprecatedBrokerShutdownStatus: + type: string + x-extensible-enum: + - FAILED + - CANCELED + - PENDING + - COMPLETE + + service-quota.v1.AppliedQuota: + type: object + description: |- + A `quota` object represents a quota configuration for a specific Confluent Cloud resource. + Use this API to retrieve an individual quota or list of quotas for a given scope. + + + Related guide: [Service Quotas for Confluent Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). + + ## The Applied Quotas Model + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AppliedQuota + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/service-quota/v1/applied-quotas/aq-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/applied-quota=aq-12345 + scope: + type: string + description: The applied scope that this quota belongs to. + example: ORGANIZATION + x-extensible-enum: [ORGANIZATION, ENVIRONMENT, NETWORK, KAFKA_CLUSTER, SERVICE_ACCOUNT, + USER_ACCOUNT] + display_name: + type: string + example: Kafka Cluster Per Organization + description: A human-readable name for the quota type name. + x-immutable: true + default_limit: + type: integer + format: int32 + description: | + The default service quota value. + applied_limit: + type: integer + format: int32 + description: | + The latest applied service quota value, taking into account any limit adjustments. + usage: + type: integer + description: | + Show the quota usage value if the quota usage is available for this quota. + format: int32 + user: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The user associated with this object. + x-immutable: true + organization: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + nullable: true + description: A unique organization id to associate a specific organization + to this quota. + environment: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + nullable: true + description: | + The environment ID the quota is associated with. + x-immutable: true + network: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + nullable: true + description: | + The network ID the quota is associated with. + x-immutable: true + kafka_cluster: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + nullable: true + description: | + The kafka cluster ID the quota is associated with. + x-immutable: true + service-quota.v1.Scope: + type: object + description: |- + Gets a list of all available scopes for applied quotas. + + + Related guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). + + ## The Scopes Model + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Scope + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/service-quota/v1/scopes/s-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/scope=s-12345 + description: + type: string + description: the quota scope for listing quotas queries + example: ORGANIZATION scope that quotas would be applied to + service-quota.v1.AppliedQuotaList: + type: object + description: |- + A `quota` object represents a quota configuration for a specific Confluent Cloud resource. + Use this API to retrieve an individual quota or list of quotas for a given scope. + + + Related guide: [Service Quotas for Confluent Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). + + ## The Applied Quotas Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AppliedQuotaList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/service-quota/v1/applied-quotas + last: + example: https://api.confluent.cloud/service-quota/v1/applied-quotas?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/service-quota/v1/applied-quotas?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/service-quota/v1/applied-quotas?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/service-quota.v1.AppliedQuota' + - type: object + required: + - id + - metadata + - scope + - display_name + - default_limit + - applied_limit + uniqueItems: true + service-quota.v1.ScopeList: + type: object + description: |- + Gets a list of all available scopes for applied quotas. + + + Related guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). + + ## The Scopes Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ScopeList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/service-quota/v1/scopes + last: + example: https://api.confluent.cloud/service-quota/v1/scopes?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/service-quota/v1/scopes?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/service-quota/v1/scopes?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/service-quota.v1.Scope' + - type: object + required: + - id + - metadata + - description + uniqueItems: true + partner.v2.Entitlement: + type: object + description: '`Entitlement` objects represent metadata about a marketplace entitlement.' + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Entitlement + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + external_id: + type: string + description: The unique external ID of the entitlement (this should be unique + to customer) + example: 1111-2222-3333-4444 + name: + type: string + description: The name of the entitlement + example: Acme Prod Entitlement + plan_id: + type: string + description: The plan ID the entitlement + example: confluent-cloud-payg-prod + x-extensible-enum: + - confluent-cloud-payg-prod + - payg-prod.gcpmarketplace.confluent.cloud + product_id: + type: string + description: The product ID of the entitlement + example: confluent-cloud-kafka-service-azure + x-extensible-enum: + - confluent-cloud-kafka-service-azure + - confluent-cloud-for-apache-kafka + - payg-prod.gcpmarketplace.confluent.cloud + usage_reporting_id: + type: string + description: | + The usage reporting ID of the entitlement (if usage reporting uses + a different ID, otherwise, same as external_id) + example: 1111-2222-3333-4444 + resource_id: + type: string + description: The resource ID of the entitlement + example: 1111-2222-3333-4444 + organization: + allOf: + - $ref: '#/components/schemas/ObjectReference' + - required: + - related + description: The organization associated with this object. + additionalProperties: false + partner.v2.EntitlementList: + type: object + description: '`Entitlement` objects represent metadata about a marketplace entitlement.' + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - EntitlementList + metadata: + $ref: '#/components/schemas/ListMeta' + data: + type: array + items: + allOf: + - $ref: '#/components/schemas/partner.v2.Entitlement' + - type: object + required: + - id + - metadata + - external_id + - name + - plan_id + - product_id + uniqueItems: true + additionalProperties: false + srcm.v2.Region: + type: object + description: |- + `Region` objects represent cloud provider regions available when placing Schema Registry clusters. + The API allows you to list Schema Registry regions. + + + Related guides: + * [Confluent Cloud providers and region support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Regions Model + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/srcm/v2/regions/sgreg-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/region=sgreg-12345 + spec: + $ref: '#/components/schemas/srcm.v2.RegionSpec' + srcm.v2.Cluster: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list, create, read, and delete your Schema Registry clusters. + + + Related guides: + * [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Clusters Model + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/srcm/v2/clusters/lsrc-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lsrc-12345 + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + srcm.v2.ClusterStatus: + type: object + required: + - phase + description: The status of the Cluster + properties: + phase: + type: string + x-extensible-enum: [PROVISIONING, PROVISIONED, FAILED] + description: | + The lifecyle phase of the cluster: + + PROVISIONED: cluster is provisioned; + + PROVISIONING: cluster provisioning is in progress; + + FAILED: provisioning failed + + Note: Schema Registry Cluster Management is handled through the org/v2 Environments API as of srcm/v3. + readOnly: true + example: PROVISIONED + readOnly: true + srcm.v2.RegionList: + type: object + description: |- + `Region` objects represent cloud provider regions available when placing Schema Registry clusters. + The API allows you to list Schema Registry regions. + + + Related guides: + * [Confluent Cloud providers and region support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Regions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RegionList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/srcm/v2/regions + last: + example: https://api.confluent.cloud/srcm/v2/regions?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/srcm/v2/regions?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/srcm/v2/regions?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/srcm.v2.Region' + - type: object + required: + - id + - metadata + - spec + properties: + spec: + type: object + required: + - display_name + - cloud + - region_name + - packages + uniqueItems: true + srcm.v2.RegionSpec: + type: object + description: The desired state of the Region + properties: + display_name: + type: string + description: The display name. + example: Ohio (us-east-2) + x-immutable: true + readOnly: true + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: [AWS, GCP, AZURE] + example: AWS + x-immutable: true + readOnly: true + region_name: + type: string + description: The region name. + example: us-east-2 + x-immutable: true + readOnly: true + packages: + type: array + items: + type: string + x-extensible-enum: [ESSENTIALS, ADVANCED] + description: List of Stream Governance packages allowing placement in this + region. + example: [ESSENTIALS, ADVANCED] + x-immutable: true + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + srcm.v2.ClusterList: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list, create, read, and delete your Schema Registry clusters. + + + Related guides: + * [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Clusters Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/srcm/v2/clusters + last: + example: https://api.confluent.cloud/srcm/v2/clusters?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/srcm/v2/clusters?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/srcm/v2/clusters?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/srcm.v2.Cluster' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - package + - environment + - region + uniqueItems: true + srcm.v2.ClusterSpec: + type: object + description: The desired state of the Cluster + properties: + display_name: + type: string + description: The cluster name. + example: Stream Governance package + x-immutable: true + readOnly: true + package: + type: string + description: | + The billing package. + + Note: Clusters can be upgraded from ESSENTIALS to ADVANCED, but cannot be + downgraded from ADVANCED to ESSENTIALS. + x-extensible-enum: [ESSENTIALS, ADVANCED] + example: ESSENTIALS + http_endpoint: + type: string + description: The cluster HTTP request URL. + format: uri + example: https://psrc-00000.us-central1.gcp.confluent.cloud + x-immutable: true + readOnly: true + environment: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The environment to which this belongs. + region: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The region to which this belongs. + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + srcm.v3.Cluster: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list and read your Schema Registry clusters. + + + Related guide: [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + ## The Clusters Model + + properties: + api_version: + type: string + enum: + - srcm/v3 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/srcm/v3/clusters/lsrc-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lsrc-12345 + spec: + $ref: '#/components/schemas/srcm.v3.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v3.ClusterStatus' + srcm.v3.ClusterStatus: + type: object + required: + - phase + description: The status of the Cluster + properties: + phase: + type: string + x-extensible-enum: [PROVISIONING, PROVISIONED, FAILED] + description: | + The lifecyle phase of the cluster: + + PROVISIONED: cluster is provisioned; + + PROVISIONING: cluster provisioning is in progress; + + FAILED: provisioning failed + readOnly: true + example: PROVISIONED + readOnly: true + srcm.v3.ClusterList: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list and read your Schema Registry clusters. + + + Related guide: [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + ## The Clusters Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - srcm/v3 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/srcm/v3/clusters + last: + example: https://api.confluent.cloud/srcm/v3/clusters?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/srcm/v3/clusters?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/srcm/v3/clusters?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/srcm.v3.Cluster' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - package + - cloud + - region + - environment + uniqueItems: true + srcm.v3.ClusterSpec: + type: object + description: The desired state of the Cluster + properties: + display_name: + type: string + description: The cluster name. + example: Stream Governance package + x-immutable: true + readOnly: true + package: + type: string + description: | + The billing package. + + Note: Clusters can be upgraded from ESSENTIALS to ADVANCED, but cannot be + downgraded from ADVANCED to ESSENTIALS. + x-extensible-enum: [ESSENTIALS, ADVANCED] + example: ESSENTIALS + http_endpoint: + type: string + description: The cluster HTTP request URL. + format: uri + example: https://psrc-00000.us-central1.gcp.confluent.cloud + x-immutable: true + readOnly: true + catalog_http_endpoint: + type: string + description: The cluster's catalog HTTP request URL. + format: uri + example: https://psrc-00000.us-central1.gcp.confluent.cloud + x-immutable: true + readOnly: true + private_http_endpoint: + type: string + description: | + The cluster's private HTTP request URL. + + DEPRECATED - Please use the `private_networking_config.regional_endpoints` attribute instead, + which supersedes the `private_http_endpoint` attribute. + format: uri + example: https://lsrc-abc.us-central-1.aws.private.confluent.cloud + x-immutable: true + readOnly: true + private_networking_config: + type: object + description: Available HTTP request URLs for private connectivity. + properties: + regional_endpoints: + type: object + description: A map of region identifiers to their corresponding private + HTTP request URL. + additionalProperties: + type: string + format: uri + example: + regional_endpoints: + us-central-1: https://lsrc-abc.us-central-1.aws.private.confluent.cloud + us-west-2: https://lsrc-abc.us-west-2.aws.private.confluent.cloud + x-immutable: true + readOnly: true + cloud: + type: string + description: The cloud service provider in which the cluster is running. + x-extensible-enum: [AWS, GCP, AZURE] + example: GCP + x-immutable: true + region: + type: string + description: The cloud service provider region where the cluster is running. + example: us-east4 + x-immutable: true + environment: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The environment to which this belongs. + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + ClusterConfig: + type: object + properties: + maxSchemas: + type: integer + description: Maximum number of registered schemas allowed + format: int32 + example: 20000 + maxRequestsPerSec: + type: integer + description: Maximum number of allowed requests per second + format: int32 + example: 25 + description: Cluster Config + CompatibilityCheckResponse: + type: object + properties: + is_compatible: + type: boolean + description: Whether the compared schemas are compatible + messages: + type: array + description: Error messages + example: [] + items: + type: string + description: Error messages + example: '[]' + description: Compatibility check response + ErrorMessage: + type: object + properties: + error_code: + type: integer + description: The error code + format: int32 + message: + type: string + description: The error message + description: Error message of this operation + RegisterExporterRequest: + type: object + properties: + references: + type: array + description: References to other schemas + items: + $ref: '#/components/schemas/ExporterReference' + description: Exporter register request + RegisterSchemaRequest: + type: object + properties: + version: + type: integer + description: Version number + format: int32 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + schemaType: + type: string + description: Schema type + references: + type: array + description: References to other schemas + items: + $ref: '#/components/schemas/SchemaReference' + schema: + type: string + description: Schema definition string + metadata: + $ref: '#/components/schemas/Metadata' + ruleSet: + $ref: '#/components/schemas/RuleSet' + schemaTagsToAdd: + type: array + items: + $ref: '#/components/schemas/SchemaTags' + schemaTagsToRemove: + type: array + items: + $ref: '#/components/schemas/SchemaTags' + propagateSchemaTags: + type: boolean + description: Schema register request + ExporterUpdateRequest: + type: object + properties: + contextType: + description: Context type of the exporter. One of CUSTOM, NONE or AUTO (default) + type: string + example: CUSTOM + x-extensible-enum: + - CUSTOM + - AUTO + - NONE + context: + type: string + description: Customized context of the exporter if contextType equals CUSTOM. + example: User + subjects: + type: array + description: Name of each exporter subject + items: + type: string + kekRenameFormat: + type: string + description: |- + Format string for the KEK name in the destination cluster, which may + contain ${kek} as a placeholder for the originating KEK name. For + example, dc_${kek} for the KEK aws_key will map to the destination + KEK name dc_aws_key. + subjectRenameFormat: + type: string + description: |- + Format string for the subject name in the destination cluster, which + may contain ${subject} as a placeholder for the originating subject + name. For example, dc_${subject} for the subject orders will map to + the destination subject name dc_orders. + config: + type: object + description: The map containing exporter's configurations + additionalProperties: + type: string + description: Exporter update request + ExporterStatusResponse: + type: object + properties: + name: + description: Name of exporter. + type: string + example: test-exporter + state: + type: string + description: State of the exporter. Could be STARTING, RUNNING or PAUSED + example: RUNNING + x-extensible-enum: + - STARTING + - RUNNING + - PAUSED + offset: + type: integer + description: Offset of the exporter + format: int64 + example: 100 + ts: + type: integer + description: Timestamp of the exporter + format: int64 + example: 1631206325 + trace: + description: Error trace of the exporter + type: string + example: '' + description: Exporter status get request + ExporterConfigResponse: + type: object + properties: + schema.registry.url: + description: Config SR URL + type: string + example: + basic.auth.credentials.source: + description: Config SR Auth + type: string + example: USER_INFO + basic.auth.user.info: + description: Config SR User Info + type: string + description: The map containing exporter's configurations + SchemaReference: + type: object + properties: + name: + type: string + description: Reference name + example: io.confluent.kafka.example.User + subject: + type: string + description: Name of the referenced subject + example: User + version: + type: integer + description: Version number of the referenced subject + format: int32 + example: 1 + description: Schema reference + ExporterReference: + type: object + properties: + name: + type: string + description: Name of the exporter + example: test-exporter + contextType: + description: Context type of the exporter. One of CUSTOM, NONE or AUTO (default) + type: string + example: CUSTOM + x-extensible-enum: + - CUSTOM + - AUTO + - NONE + context: + type: string + description: Customized context of the exporter if contextType equals CUSTOM. + example: User + subjects: + type: array + description: Name of each exporter subject + items: + type: string + kekRenameFormat: + type: string + description: Format string for the KEK name in the destination cluster, + which may contain ${kek} as a placeholder for the originating KEK name. + For example, dc_${kek} for the KEK aws_key will map to the destination + KEK name dc_aws_key. + subjectRenameFormat: + type: string + description: Format string for the subject name in the destination cluster, + which may contain ${subject} as a placeholder for the originating subject + name. For example, dc_${subject} for the subject orders will map to the + destination subject name dc_orders. + config: + type: object + description: The map containing exporter's configurations + additionalProperties: + type: string + description: The format for a typical exporter object + Config: + type: object + properties: + alias: + type: string + description: |- + If alias is specified, then this subject is an alias for the subject + named by the alias. That means that any reference to this subject + will be replaced by the alias. + normalize: + type: boolean + description: |- + If true, then schemas are automatically normalized when registered or + when passed during lookups. This means that clients do not have to + pass the "normalize" query parameter to have normalization occur. + compatibilityLevel: + type: string + description: Compatibility Level + example: FULL_TRANSITIVE + x-extensible-enum: + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + - NONE + compatibilityGroup: + type: string + description: |- + Only schemas that belong to the same compatibility group will be + checked for compatibility. + defaultMetadata: + type: object + description: |- + Default value for the metadata to be used during schema registration. + properties: + properties: + type: object + description: The metadata properties and their new values + overrideMetadata: + type: object + description: |- + Override value for the metadata to be used during schema registration. + properties: + properties: + type: object + description: The metadata properties and their new values + defaultRuleSet: + type: object + description: |- + Default value for the ruleSet to be used during schema registration. + properties: + properties: + type: object + description: The metadata properties and their new values + overrideRuleSet: + type: object + description: |- + Override value for the ruleSet to be used during schema registration. + properties: + properties: + type: object + description: The metadata properties and their new values + description: Config + ConfigUpdateRequest: + type: object + properties: + alias: + type: string + description: |- + If alias is specified, then this subject is an alias for the subject + named by the alias. That means that any reference to this subject + will be replaced by the alias. + normalize: + type: boolean + description: |- + If true, then schemas are automatically normalized when registered + or when passed during lookups. This means that clients do not have + to pass the "normalize" query parameter to have normalization occur. + compatibility: + type: string + description: Compatibility Level + example: FULL_TRANSITIVE + x-extensible-enum: + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + - NONE + compatibilityGroup: + type: string + description: |- + Only schemas that belong to the same compatibility group will be + checked for compatibility. + defaultMetadata: + type: object + description: |- + Default value for the metadata to be used during schema registration. + properties: + properties: + type: object + description: The metadata properties and their new values + overrideMetadata: + type: object + description: |- + Override value for the metadata to be used during schema registration. + properties: + properties: + type: object + description: The metadata properties and their new values + defaultRuleSet: + type: object + description: |- + Default value for the ruleSet to be used during schema registration. + properties: + properties: + type: object + description: The metadata properties and their new values + overrideRuleSet: + type: object + description: |- + Override value for the ruleSet to be used during schema registration. + properties: + properties: + type: object + description: The metadata properties and their new values + description: Config update request + Mode: + type: object + properties: + mode: + type: string + description: Schema Registry operating mode + example: READWRITE + x-extensible-enum: + - READWRITE + - READONLY + - READONLY_OVERRIDE + - IMPORT + description: Schema Registry operating mode + ModeUpdateRequest: + type: object + properties: + mode: + type: string + description: Schema Registry operating mode + example: READWRITE + x-extensible-enum: + - READWRITE + - READONLY + - READONLY_OVERRIDE + - IMPORT + description: Mode update request + SchemaString: + type: object + properties: + schemaType: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema string identified by the ID + example: '{"schema": "{"type": "string"}"}' + references: + type: array + description: References to other schemas + items: + $ref: '#/components/schemas/SchemaReference' + metadata: + $ref: '#/components/schemas/Metadata' + ruleSet: + $ref: '#/components/schemas/RuleSet' + schemaTags: + type: array + description: Schema tags + items: + $ref: '#/components/schemas/SchemaTags' + maxId: + type: integer + description: Maximum ID + format: int32 + example: 1 + description: Schema definition + Schema: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schemaType: + type: string + description: Schema type + example: AVRO + references: + type: array + description: References to other schemas + items: + $ref: '#/components/schemas/SchemaReference' + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + metadata: + $ref: '#/components/schemas/Metadata' + ruleSet: + $ref: '#/components/schemas/RuleSet' + schemaTags: + type: array + description: Schema tags + items: + $ref: '#/components/schemas/SchemaTags' + description: Schema + SubjectVersion: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + description: Subject version pair + ExporterResponse: + type: object + properties: + name: + type: string + description: Name of the exporter + example: test-exporter + description: Exporter register response + RegisterSchemaResponse: + type: object + properties: + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + description: Schema register response + Dek: + example: + kekName: kekName + keyMaterial: keyMaterial + deleted: true + subject: subject + encryptedKeyMaterial: encryptedKeyMaterial + version: 0 + algorithm: AES128_GCM + ts: 6 + properties: + kekName: + type: string + description: Kek name of the dek + subject: + type: string + description: Subject of the dek + version: + type: integer + description: Version of the dek + format: int32 + algorithm: + type: string + description: Algorithm of the dek + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + encryptedKeyMaterial: + type: string + description: Encrypted key material of the dek + keyMaterial: + type: string + description: Raw key material of the dek + ts: + type: integer + description: Timestamp of the dek + format: int64 + deleted: + type: boolean + description: Whether the dek is deleted + type: object + CreateDekRequest: + example: + subject: subject + encryptedKeyMaterial: encryptedKeyMaterial + version: 0 + algorithm: AES128_GCM + properties: + subject: + type: string + description: Subject of the dek + version: + type: integer + description: Version of the dek + format: int32 + algorithm: + type: string + description: Algorithm of the dek + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + encryptedKeyMaterial: + type: string + description: Encrypted key material of the dek + deleted: + type: boolean + description: Whether the dek is deleted + type: object + Kek: + example: + kmsProps: + key: kmsProps + shared: true + deleted: true + name: name + doc: doc + kmsKeyId: kmsKeyId + kmsType: kmsType + ts: 0 + properties: + name: + type: string + description: Name of the kek + kmsType: + type: string + description: KMS type of the kek + kmsKeyId: + type: string + description: KMS key ID of the kek + kmsProps: + type: object + additionalProperties: + type: string + description: Properties of the kek + doc: + type: string + description: Description of the kek + shared: + type: boolean + description: Whether the kek is shared + ts: + type: integer + description: Timestamp of the kek + format: int64 + deleted: + type: boolean + description: Whether the kek is deleted + type: object + CreateKekRequest: + example: + kmsProps: + key: kmsProps + shared: true + name: name + doc: doc + kmsKeyId: kmsKeyId + kmsType: kmsType + properties: + name: + type: string + description: Name of the kek + kmsType: + type: string + description: KMS type of the kek + kmsKeyId: + type: string + description: KMS key ID of the kek + kmsProps: + type: object + additionalProperties: + type: string + description: Properties of the kek + doc: + type: string + description: Description of the kek + shared: + type: boolean + description: Whether the kek is shared + deleted: + type: boolean + description: Whether the kek is deleted + type: object + UpdateKekRequest: + example: + kmsProps: + key: kmsProps + shared: true + doc: doc + properties: + kmsProps: + type: object + additionalProperties: + type: string + description: Properties of the kek + doc: + type: string + description: Description of the kek + shared: + type: boolean + description: Whether the kek is shared + type: object + + Metadata: + description: User-defined metadata + nullable: true + properties: + tags: + additionalProperties: + items: + type: string + type: array + uniqueItems: true + type: object + properties: + additionalProperties: + type: string + type: object + sensitive: + items: + type: string + type: array + uniqueItems: true + type: object + RuleSet: + description: Schema rule set + nullable: true + properties: + migrationRules: + items: + $ref: '#/components/schemas/Rule' + type: array + domainRules: + items: + $ref: '#/components/schemas/Rule' + type: array + type: object + Rule: + description: Rule + properties: + name: + description: Rule name + type: string + doc: + description: Rule doc + type: string + kind: + description: Rule kind + enum: + - TRANSFORM + - CONDITION + type: string + mode: + description: Rule mode + enum: + - UPGRADE + - DOWNGRADE + - UPDOWN + - WRITE + - READ + - WRITEREAD + type: string + type: + description: Rule type + type: string + tags: + description: The tags to which this rule applies + items: + description: The tags to which this rule applies + type: string + type: array + uniqueItems: true + params: + additionalProperties: + description: Optional params for the rule + type: string + description: Optional params for the rule + type: object + expr: + description: Rule expression + type: string + onSuccess: + description: Rule action on success + type: string + onFailure: + description: Rule action on failure + type: string + disabled: + description: Whether the rule is disabled + type: boolean + type: object + SchemaEntity: + type: object + properties: + entityPath: + type: string + entityType: + type: string + enum: + - sr_record + - sr_field + SchemaTags: + type: object + properties: + schemaEntity: + $ref: '#/components/schemas/SchemaEntity' + tags: + type: array + items: + type: string + + ServerClusterId: + type: object + properties: + scope: + type: object + additionalProperties: + type: object + id: + type: string + SchemaRegistryServerVersion: + type: object + properties: + version: + type: string + commitId: + type: string + Tag: + type: object + properties: + typeName: + type: string + description: The tag name + attributes: + type: object + description: The tag attributes + entityGuid: + type: string + description: The internal entity guid + entityStatus: + type: string + description: The entity status + enum: + - ACTIVE + - DELETED + - PURGED + propagate: + type: boolean + description: Whether to propagate the tag + validityPeriods: + type: array + description: The validity periods + items: + $ref: '#/components/schemas/TimeBoundary' + removePropagationsOnEntityDelete: + type: boolean + description: Whether to remove propagations on entity delete + entityType: + type: string + description: The entity type + entityName: + type: string + description: The qualified name of the entity + TimeBoundary: + type: object + properties: + startTime: + type: string + description: The start time of format yyyy/MM/dd HH:mm:ss + endTime: + type: string + description: The end time of format yyyy/MM/dd HH:mm:ss + timeZone: + type: string + description: The time zone (see java.util.TimeZone) + Classification: + type: object + properties: + typeName: + type: string + description: The tag name + attributes: + type: object + description: The tag attributes + additionalProperties: + type: object + entityGuid: + type: string + description: The internal entity guid + entityStatus: + type: string + description: The entity status + enum: + - ACTIVE + - DELETED + - PURGED + propagate: + type: boolean + description: Whether to propagate the tag + validityPeriods: + type: array + description: The validity periods + items: + $ref: '#/components/schemas/TimeBoundary' + removePropagationsOnEntityDelete: + type: boolean + description: Whether to remove propagations on entity delete + ClassificationHeader: + type: object + properties: + typeName: + type: string + description: The tag name + entityGuid: + type: string + description: The internal entity guid + entityStatus: + type: string + description: The entity status + enum: + - ACTIVE + - DELETED + - PURGED + propagate: + type: boolean + description: Whether to propagate the tag + removePropagationsOnEntityDelete: + type: boolean + description: Whether to remove propagations on entity delete + Entity: + type: object + description: The entity + properties: + typeName: + type: string + description: The type name + attributes: + type: object + description: The type attributes + guid: + type: string + description: The internal guid + homeId: + type: string + description: The home id + isProxy: + type: boolean + description: Whether is a proxy + writeOnly: true + isIncomplete: + type: boolean + description: Whether is incomplete + provenanceType: + type: integer + description: The provenance type + format: int32 + status: + type: string + description: The status + enum: + - ACTIVE + - DELETED + - PURGED + createdBy: + type: string + description: The creator + updatedBy: + type: string + description: The updater + createTime: + type: integer + description: The create time + format: int64 + updateTime: + type: integer + description: The update time + format: int64 + version: + type: integer + description: The version + format: int32 + relationshipAttributes: + type: object + description: The relationship attributes + classifications: + type: array + description: The classifications (tags) + items: + $ref: '#/components/schemas/Classification' + meanings: + type: array + description: The meanings + items: + $ref: '#/components/schemas/TermAssignmentHeader' + customAttributes: + type: object + description: The custom attributes + additionalProperties: + type: string + businessAttributes: + type: object + description: The business attributes + additionalProperties: + type: object + labels: + uniqueItems: true + type: array + description: The labels + items: + type: string + proxy: + type: boolean + description: Whether is a proxy + EntityWithExtInfo: + type: object + properties: + referredEntities: + type: object + description: The referred entities + additionalProperties: + $ref: '#/components/schemas/Entity' + entity: + $ref: '#/components/schemas/Entity' + EntityPartialUpdateResponse: + type: object + properties: + mutatedEntities: + $ref: '#/components/schemas/EntityPartialUpdate' + description: The type name + TermAssignmentHeader: + type: object + properties: + termGuid: + type: string + description: The term guid + relationGuid: + type: string + description: The relation guid + description: + type: string + description: The description + displayText: + type: string + description: The display text + expression: + type: string + description: The expression + createdBy: + type: string + description: The creator + steward: + type: string + description: The steward + source: + type: string + description: The source + confidence: + type: integer + description: The confidence + format: int32 + status: + type: string + description: The status + enum: + - DISCOVERED + - PROPOSED + - IMPORTED + - VALIDATED + - DEPRECATED + - OBSOLETE + - OTHER + EntityHeader: + type: object + properties: + typeName: + type: string + description: The type name + attributes: + type: object + description: The attributes + additionalProperties: true + guid: + type: string + description: The internal guid + status: + type: string + description: The status + enum: + - ACTIVE + - DELETED + - PURGED + displayText: + type: string + description: The display text + classificationNames: + type: array + description: The classification (tag) names + items: + type: string + classifications: + type: array + description: The classifications (tags) + items: + $ref: '#/components/schemas/Classification' + meaningNames: + type: array + description: The meaning names + items: + type: string + meanings: + type: array + description: The meanings + items: + $ref: '#/components/schemas/TermAssignmentHeader' + isIncomplete: + type: boolean + description: Whether is incomplete + labels: + uniqueItems: true + type: array + description: The labels + items: + type: string + EntityPartialUpdate: + type: object + properties: + UPDATE: + type: array + description: The updated entities. + items: + $ref: '#/components/schemas/PartialUpdateParams' + description: The updated entities. + PartialUpdateParams: + type: object + properties: + typeName: + type: string + description: The type name + attributes: + type: object + description: The attributes + guid: + type: string + description: The internal guid + status: + type: string + description: The status + enum: + - ACTIVE + - DELETED + - PURGED + classificationNames: + type: array + description: The classification (tag) names + items: + type: string + classifications: + type: array + description: The classifications (tags) + items: + $ref: '#/components/schemas/ClassificationHeader' + isIncomplete: + type: boolean + description: Whether is incomplete + SearchParams: + type: object + description: Search paramas to filter results + properties: + includeDeleted: + type: boolean + description: Whether to include deleted + limit: + type: integer + description: The limit + format: int32 + offset: + type: integer + description: The offset + format: int32 + SearchResult: + type: object + properties: + searchParameters: + $ref: '#/components/schemas/SearchParams' + types: + type: array + description: The types + items: + type: string + entities: + type: array + description: The entities + items: + $ref: '#/components/schemas/EntityHeader' + referredEntities: + type: object + description: The referred entities + additionalProperties: + $ref: '#/components/schemas/EntityHeader' + AttributeDef: + type: object + properties: + name: + type: string + description: The name + typeName: + type: string + description: The type name + isOptional: + type: boolean + description: Whether is optional + cardinality: + type: string + description: The cardinality + enum: + - SINGLE + - LIST + - SET + valuesMinCount: + type: integer + description: The values min count + format: int32 + valuesMaxCount: + type: integer + description: The values max count + format: int32 + isUnique: + type: boolean + description: Whether is unique + isIndexable: + type: boolean + description: Whether is indexable + includeInNotification: + type: boolean + description: Whether to include in notifications + defaultValue: + type: string + description: The default value + description: + type: string + description: The description + searchWeight: + type: integer + description: The search weight + format: int32 + indexType: + type: string + description: The index type + enum: + - DEFAULT + - STRING + constraints: + type: array + description: The constraints + items: + $ref: '#/components/schemas/ConstraintDef' + options: + type: object + description: The options + additionalProperties: + type: string + displayName: + type: string + description: The display name + ConstraintDef: + type: object + properties: + type: + type: string + description: The type + params: + type: object + description: The params + additionalProperties: + type: object + TagDef: + type: object + properties: + category: + type: string + description: The category + enum: + - PRIMITIVE + - OBJECT_ID_TYPE + - ENUM + - STRUCT + - CLASSIFICATION + - ENTITY + - ARRAY + - MAP + - RELATIONSHIP + - BUSINESS_METADATA + guid: + type: string + description: The internal guid + createdBy: + type: string + description: The creator + updatedBy: + type: string + description: The updater + createTime: + type: integer + description: The create time + format: int64 + updateTime: + type: integer + description: The update time + format: int64 + version: + type: integer + description: The version + format: int32 + name: + type: string + description: The name + description: + type: string + description: The description + typeVersion: + type: string + description: The type version + serviceType: + type: string + description: The service type + options: + type: object + description: The options + additionalProperties: + type: string + attributeDefs: + type: array + description: The attribute definitions + items: + $ref: '#/components/schemas/AttributeDef' + superTypes: + uniqueItems: true + type: array + description: The supertypes + items: + type: string + entityTypes: + uniqueItems: true + type: array + description: The entity types + items: + type: string + subTypes: + uniqueItems: true + type: array + description: The subtypes + items: + type: string + BusinessMetadataResponse: + properties: + typeName: + type: string + description: The business metadata name + attributes: + type: object + description: The business metadata attributes + entityType: + type: string + description: The entity type + entityName: + type: string + description: The qualified name of the entity + error: + $ref: '#/components/schemas/ErrorMessage' + type: object + BusinessMetadata: + properties: + typeName: + type: string + description: The business metadata name + attributes: + type: object + description: The business metadata attributes + entityType: + type: string + description: The entity type + entityName: + type: string + description: The qualified name of the entity + type: object + BusinessMetadataDefResponse: + properties: + category: + enum: + - PRIMITIVE + - OBJECT_ID_TYPE + - ENUM + - STRUCT + - CLASSIFICATION + - ENTITY + - ARRAY + - MAP + - RELATIONSHIP + - BUSINESS_METADATA + type: string + description: The category + guid: + type: string + description: The internal guid + createdBy: + type: string + description: The creator + updatedBy: + type: string + description: The updater + createTime: + format: int64 + type: integer + description: The create time + updateTime: + format: int64 + type: integer + description: The update time + version: + format: int32 + type: integer + description: The version + name: + type: string + description: The name + description: + type: string + description: The description + typeVersion: + type: string + description: The type version + serviceType: + type: string + description: The service type + options: + additionalProperties: + type: string + type: object + description: The options + attributeDefs: + items: + $ref: '#/components/schemas/AttributeDef' + type: array + description: The attribute definitions + error: + $ref: '#/components/schemas/ErrorMessage' + type: object + BusinessMetadataDef: + properties: + category: + enum: + - PRIMITIVE + - OBJECT_ID_TYPE + - ENUM + - STRUCT + - CLASSIFICATION + - ENTITY + - ARRAY + - MAP + - RELATIONSHIP + - BUSINESS_METADATA + type: string + description: The category + guid: + type: string + description: The internal guid + createdBy: + type: string + description: The creator + updatedBy: + type: string + description: The updater + createTime: + format: int64 + type: integer + description: The create time + updateTime: + format: int64 + type: integer + description: The update time + version: + format: int32 + type: integer + description: The version + name: + type: string + description: The name + description: + type: string + description: The description + typeVersion: + type: string + description: The type version + serviceType: + type: string + description: The service type + options: + additionalProperties: + type: string + type: object + description: The options + attributeDefs: + items: + $ref: '#/components/schemas/AttributeDef' + type: array + description: The attribute definitions + type: object + TagResponse: + type: object + properties: + typeName: + type: string + description: The tag name + attributes: + type: object + description: The tag attributes + entityGuid: + type: string + description: The internal entity guid + entityStatus: + type: string + description: The entity status + enum: + - ACTIVE + - DELETED + - PURGED + propagate: + type: boolean + description: Whether to propagate the tag + validityPeriods: + type: array + description: The validity periods + items: + $ref: '#/components/schemas/TimeBoundary' + removePropagationsOnEntityDelete: + type: boolean + description: Whether to remove propagations on entity delete + entityType: + type: string + description: The entity type + entityName: + type: string + description: The qualified name of the entity + error: + $ref: '#/components/schemas/ErrorMessage' + TagDefResponse: + type: object + properties: + category: + type: string + description: The category + enum: + - PRIMITIVE + - OBJECT_ID_TYPE + - ENUM + - STRUCT + - CLASSIFICATION + - ENTITY + - ARRAY + - MAP + - RELATIONSHIP + - BUSINESS_METADATA + guid: + type: string + description: The internal guid + createdBy: + type: string + description: The creator + updatedBy: + type: string + description: The updater + createTime: + type: integer + description: The create time + format: int64 + updateTime: + type: integer + description: The update time + format: int64 + version: + type: integer + description: The version + format: int32 + name: + type: string + description: The name + description: + type: string + description: The description + typeVersion: + type: string + description: The type version + serviceType: + type: string + description: The service type + options: + type: object + description: The options + additionalProperties: + type: string + attributeDefs: + type: array + description: The attribute definitions + items: + $ref: '#/components/schemas/AttributeDef' + superTypes: + uniqueItems: true + type: array + description: The supertypes + items: + type: string + entityTypes: + uniqueItems: true + type: array + description: The entity types + items: + type: string + subTypes: + uniqueItems: true + type: array + description: The subtypes + items: + type: string + error: + $ref: '#/components/schemas/ErrorMessage' + + cdx.v1.ProviderSharedResource: + type: object + description: |- + `ProviderSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you have shared through Stream Sharing. + + + ## The Provider Shared Resources Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderSharedResource + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/cdx/v1/provider-shared-resources/psr-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/provider-shared-resource=psr-12345 + crn: + type: string + description: Deprecated please use resources attribute. + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic + x-immutable: true + resources: + type: array + minItems: 1 + description: List of resource crns that are shared together + items: + type: string + description: crn that specifies the shared resource + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + display_name: + type: string + description: Shared resource display name + example: Stock Trades + description: + type: string + description: Description of shared resource + example: This topic provides realtime data for the orders placed through + the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: [recent, pending] + x-immutable: true + readOnly: true + schemas: + type: array + items: + allOf: + - $ref: '#/components/schemas/cdx.v1.Schema' + - type: object + description: List of schemas in JSON format. This field is work in progress + and subject to changes. + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of contact person from the organization + logo_url: + type: string + format: uri + description: Resource logo url + example: https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo + readOnly: true + organization_name: + description: Organization to which the shared resource belongs. Deprecated + example: ABC Corp + x-immutable: true + readOnly: true + environment_name: + type: string + description: The environment name of the shared resource. Deprecated + example: Public Env + x-immutable: true + readOnly: true + cluster_name: + type: string + description: The cluster display name of the shared resource. Deprecated + example: Published Trades + x-immutable: true + readOnly: true + cloud_cluster: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The cloud cluster to which this belongs. + x-immutable: true + cdx.v1.ProviderShare: + type: object + description: |- + `ProviderShare` object respresents the share that you have created through Stream Sharing. + + + Related guide: [Provider Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares). + + ## The Provider Shares Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderShare + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/cdx/v1/provider-shares/ps-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/provider-share=ps-12345 + consumer_user_name: + type: string + description: Name of the consumer + example: John Doe + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user. Deprecated + example: Jane Doe + readOnly: true + delivery_method: + description: Method by which the invite will be delivered + type: string + x-extensible-enum: [EMAIL] + example: EMAIL + x-immutable: true + consumer_restriction: + description: Restrictions on the consumer that can redeem this token + discriminator: + propertyName: kind + mapping: + Email: '#/components/schemas/cdx.v1.EmailConsumerRestriction' + oneOf: + - $ref: '#/components/schemas/cdx.v1.EmailConsumerRestriction' + x-immutable: true + invited_at: + type: string + format: date-time + description: The date and time at which consumer was invited + example: '2006-01-02T15:04:05-07:00' + readOnly: true + invite_expires_at: + type: string + format: date-time + description: The date and time at which the invitation will expire. Only + for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + redeemed_at: + type: string + format: date-time + description: The date and time at which the invite was redeemed + example: '2006-01-02T15:04:05-07:00' + readOnly: true + provider_user: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The provider user/inviter + readOnly: true + service_account: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The service account associated with this object. + x-immutable: true + cloud_cluster: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The cloud cluster to which this belongs. + x-immutable: true + status: + $ref: '#/components/schemas/cdx.v1.ProviderShareStatus' + cdx.v1.ProviderShareStatus: + type: object + required: + - phase + description: The status of the Provider Share + properties: + phase: + type: string + x-extensible-enum: [INVITED, EXPIRED, ACTIVE, DEACTIVATED] + description: Status of share + example: ACTIVE + readOnly: true + readOnly: true + cdx.v1.ConsumerSharedResource: + type: object + description: |- + `ConsumerSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you received through Stream Sharing. + + + ## The Consumer Shared Resources Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerSharedResource + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/cdx/v1/consumer-shared-resources/csr-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/consumer-shared-resource=csr-12345 + cloud: + type: string + description: The cloud service provider of the provider shared cluster. + x-extensible-enum: [AWS, AZURE, GCP] + example: AWS + x-immutable: true + readOnly: true + network_connection_types: + type: array + description: | + The network connection types of the provider shared cluster. If the shared cluster is on public internet, + then the list will be empty + items: + $ref: '#/components/schemas/cdx.v1.ConnectionType' + uniqueItems: true + x-immutable: true + readOnly: true + display_name: + type: string + description: Consumer resource display name + example: Stock Trades + x-immutable: true + readOnly: true + description: + type: string + description: Description of consumer resource + example: This topic provides realtime data for the orders placed through + the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: [recent, pending] + x-immutable: true + readOnly: true + schemas: + type: array + items: + allOf: + - $ref: '#/components/schemas/cdx.v1.Schema' + - type: object + description: List of schemas in JSON format. This field is work in progress + and subject to changes. + x-immutable: true + readOnly: true + organization_name: + type: string + description: Shared resource's organization name + example: ABC Corp + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + x-immutable: true + readOnly: true + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of the shared resource's organization contact + x-immutable: true + readOnly: true + logo_url: + type: string + format: uri + description: Resource logo url + example: https://confluent.cloud/api/cdx/v1/consumer-shared-resources/sr-123/images/logo + x-immutable: true + readOnly: true + cdx.v1.ConsumerShare: + type: object + description: |- + `ConsumerShare` object respresents the share that you received through Stream Sharing. + + + Related guide: [Consumer Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html). + + ## The Consumer Shares Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerShare + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/cdx/v1/consumer-shares/cs-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/consumer-share=cs-12345 + provider_organization_name: + type: string + description: Provider organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user + example: Jane Doe + readOnly: true + invite_expires_at: + type: string + format: date-time + description: The date and time at which the invitation will expire. Only + for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name. Deprecated + example: Nasdaq + readOnly: true + consumer_user_name: + type: string + description: Name of the consumer. Deprecated + example: John Doe + readOnly: true + consumer_user: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The consumer user/invitee + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ConsumerShareStatus' + cdx.v1.ConsumerShareStatus: + type: object + required: + - phase + description: The status of the Consumer Share + properties: + phase: + type: string + description: Status of share + x-extensible-enum: [INVITED, EXPIRED, ACTIVE, DEACTIVATED] + example: ACTIVE + readOnly: true + readOnly: true + cdx.v1.SharedToken: + type: object + description: |- + Encrypted Token shared with consumer + + + ## The Shared Tokens Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - SharedToken + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/cdx/v1/shared-tokens/st-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/shared-token=st-12345 + token: + type: string + description: The encrypted token + cdx.v1.OptIn: + type: object + description: |- + Stream sharing opt in options + + ## The Opt Ins Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OptIn + stream_share_enabled: + type: boolean + description: Enable stream sharing for the organization + cdx.v1.CreateProviderShareRequest: + type: object + description: Create share request + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CreateProviderShareRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/cdx/v1/create-provider-share-requests/cpsr-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/create-provider-share-request=cpsr-12345 + delivery_method: + type: string + description: Method by which the invite will be delivered + x-extensible-enum: [EMAIL] + example: EMAIL + consumer_restriction: + description: Restrictions on the consumer that can redeem this token + discriminator: + propertyName: kind + mapping: + Email: '#/components/schemas/cdx.v1.EmailConsumerRestriction' + oneOf: + - $ref: '#/components/schemas/cdx.v1.EmailConsumerRestriction' + resources: + type: array + minItems: 1 + description: List of resource crns to be shared + items: + type: string + description: crn that specifies the sharedresource + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + cdx.v1.RedeemTokenRequest: + type: object + description: Redeem share with token request parameters + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RedeemTokenRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/cdx/v1/redeem-token-requests/rtr-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/redeem-token-request=rtr-12345 + token: + type: string + description: The encrypted token + aws_account: + type: string + description: Consumer's AWS account ID for PrivateLink access. + example: '000000000000' + azure_subscription: + type: string + description: Consumer's Azure subscription ID for PrivateLink access. + example: 00000000-0000-0000-0000-000000000000 + gcp_project: + type: string + minLength: 1 + description: Consumer's GCP project ID for Private Service Connect access. + cdx.v1.RedeemTokenResponse: + type: object + description: Share details for the consumer org or user + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RedeemTokenResponse + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/cdx/v1/redeem-token-responses/rtr-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/redeem-token-response=rtr-12345 + api_key: + type: string + description: The api key + readOnly: true + secret: + type: string + description: The api key secret + x-redact: true + readOnly: true + kafka_bootstrap_url: + type: string + format: uri + description: The kafka cluster bootstrap url + example: SASL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + x-immutable: true + readOnly: true + schema_registry_api_key: + type: string + description: The api key for schema registry + readOnly: true + schema_registry_secret: + type: string + description: The api key secret for schema registry + x-redact: true + readOnly: true + schema_registry_url: + type: string + format: uri + description: The schema registry endpoint url + example: https://psrc-xxxxx.us-west-2.aws.confluent.cloud + x-immutable: true + readOnly: true + resources: + type: array + minItems: 1 + description: List of shared resources + items: + type: object + discriminator: + propertyName: kind + mapping: + Topic: '#/components/schemas/cdx.v1.SharedTopic' + Group: '#/components/schemas/cdx.v1.SharedGroup' + Subject: '#/components/schemas/cdx.v1.SharedSubject' + oneOf: + - $ref: '#/components/schemas/cdx.v1.SharedTopic' + - $ref: '#/components/schemas/cdx.v1.SharedGroup' + - $ref: '#/components/schemas/cdx.v1.SharedSubject' + cdx.v1.EmailConsumerRestriction: + type: object + description: Consumer restrictions limits by authenticated user's email + required: + - kind + - email + properties: + kind: + description: The resource kind + type: string + enum: [Email] + email: + type: string + format: email + description: Email based matching for the consumers + cdx.v1.SharedTopic: + type: object + description: The shared resource details + required: + - kind + - topic + properties: + kind: + description: The shared resource kind + type: string + enum: [Topic] + topic: + type: string + description: The topic name + cdx.v1.SharedGroup: + type: object + description: The shared consumer group + required: + - kind + - group_prefix + properties: + kind: + description: The resource kind + type: string + enum: [Group] + group_prefix: + type: string + description: The consumer group prefix + cdx.v1.SharedSubject: + type: object + description: The shared resource details + required: + - kind + - subject + properties: + kind: + description: The shared resource kind + type: string + enum: [Subject] + subject: + type: string + description: The subject name + cdx.v1.Network: + type: object + description: The shared cluster's network configurations for consumer to setup + private link + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/cdx/v1/networks/n-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-12345 + kafka_bootstrap_url: + type: string + format: uri + description: The kafka cluster bootstrap url + example: SASL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + x-immutable: true + readOnly: true + zones: + type: array + items: + type: string + uniqueItems: true + minItems: 3 + maxItems: 3 + description: | + The 3 availability zones for this network. They can optionally be specified for AWS networks + used with PrivateLink. Otherwise, they are automatically chosen by Confluent Cloud. + + On AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) + (e.g. use1-az3) + + On GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones) + (e.g. us-central1-c). + + On Azure, zones are Confluent-chosen names (e.g. 1, 2, 3) since Azure does not + have universal zone identifiers. + example: [use1-az1, use1-az2, use1-az3] + x-immutable: true + dns_domain: + type: string + description: The root DNS domain for the network if applicable. + example: 00000.us-east-1.aws.glb.confluent.cloud + # zonal_subdomains field is optional because it only applies to v4 networks + readOnly: true + zonal_subdomains: + type: object + additionalProperties: + type: string + description: | + The DNS subdomain for each zone. Present on networks that support PrivateLink. Keys are zones and + values are DNS domains. + example: + use1-az1: use1-az1.00000.us-east-1.aws.confluent.cloud + use1-az4: use1-az4.00000.us-east-1.aws.confluent.cloud + use1-az5: use1-az5.00000.us-east-1.aws.confluent.cloud + readOnly: true + cloud: + oneOf: + - $ref: '#/components/schemas/cdx.v1.AwsNetwork' + - $ref: '#/components/schemas/cdx.v1.AzureNetwork' + - $ref: '#/components/schemas/cdx.v1.GcpNetwork' + description: The cloud-specific network details. These will be populated + when the network reaches the READY state. + discriminator: + propertyName: kind + mapping: + AwsNetwork: '#/components/schemas/cdx.v1.AwsNetwork' + AzureNetwork: '#/components/schemas/cdx.v1.AzureNetwork' + GcpNetwork: '#/components/schemas/cdx.v1.GcpNetwork' + readOnly: true + cdx.v1.AwsNetwork: + type: object + description: The AWS network details. + required: + - kind + properties: + kind: + description: Network kind type. + type: string + enum: [AwsNetwork] + private_link_endpoint_service: + type: string + description: The AWS VPC endpoint service for the network (used for PrivateLink) + if available. + example: com.amazonaws.vpce.eu-west-3.vpce-00000000000000000 + readOnly: true + cdx.v1.AzureNetwork: + type: object + description: The Azure network details. + required: + - kind + properties: + kind: + description: Network kind type. + type: string + enum: [AzureNetwork] + private_link_service_aliases: + type: object + description: | + The mapping of zones to PrivateLink Service Aliases if available. Keys are zones + and values are [Azure PrivateLink Service + Aliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service) + additionalProperties: + type: string + example: + '1': 0-00000-privatelink-1.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '2': 0-00000-privatelink-2.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '3': 0-00000-privatelink-3.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + readOnly: true + cdx.v1.GcpNetwork: + type: object + description: The GCP network details. + required: + - kind + properties: + kind: + description: Network kind type. + type: string + enum: [GcpNetwork] + private_service_connect_service_attachments: + type: object + # yamllint disable-line rule:line-length + description: | + The mapping of zones to Private Service Connect Service + Attachments if available. Keys are zones and values are + [GCP Private Service Connect Service + Attachment](https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#api_7) + additionalProperties: + type: string + example: + # yamllint disable-line rule:line-length + us-central1-a: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-a + # yamllint disable-line rule:line-length + us-central1-b: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-b + # yamllint disable-line rule:line-length + us-central1-c: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-c + readOnly: true + cdx.v1.ConnectionType: + type: string + description: Network connection type. + x-extensible-enum: [PRIVATELINK] + example: PRIVATELINK + cdx.v1.Schema: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + +# Default + BooleanFilter: + type: boolean + description: Filter for whether this value is true or false. + cdx.v1.ProviderSharedResourceList: + type: object + description: |- + `ProviderSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you have shared through Stream Sharing. + + + ## The Provider Shared Resources Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderSharedResourceList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/cdx/v1/provider-shared-resources + last: + example: https://api.confluent.cloud/cdx/v1/provider-shared-resources?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/cdx/v1/provider-shared-resources?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/cdx/v1/provider-shared-resources?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/cdx.v1.ProviderSharedResource' + - type: object + required: + - id + - metadata + - display_name + - organization_name + - environment_name + - cluster_name + - cloud_cluster + uniqueItems: true + cdx.v1.ProviderShareList: + type: object + description: |- + `ProviderShare` object respresents the share that you have created through Stream Sharing. + + + Related guide: [Provider Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares). + + ## The Provider Shares Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderShareList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/cdx/v1/provider-shares + last: + example: https://api.confluent.cloud/cdx/v1/provider-shares?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/cdx/v1/provider-shares?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/cdx/v1/provider-shares?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/cdx.v1.ProviderShare' + - type: object + required: + - id + - metadata + - provider_user_name + - delivery_method + - invited_at + - invite_expires_at + - provider_user + - cloud_cluster + - status + uniqueItems: true + cdx.v1.ConsumerSharedResourceList: + type: object + description: |- + `ConsumerSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you received through Stream Sharing. + + + ## The Consumer Shared Resources Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerSharedResourceList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/cdx/v1/consumer-shared-resources + last: + example: https://api.confluent.cloud/cdx/v1/consumer-shared-resources?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/cdx/v1/consumer-shared-resources?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/cdx/v1/consumer-shared-resources?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/cdx.v1.ConsumerSharedResource' + - type: object + required: + - id + - metadata + - cloud + - display_name + - organization_name + uniqueItems: true + cdx.v1.ConsumerShareList: + type: object + description: |- + `ConsumerShare` object respresents the share that you received through Stream Sharing. + + + Related guide: [Consumer Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html). + + ## The Consumer Shares Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerShareList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/cdx/v1/consumer-shares + last: + example: https://api.confluent.cloud/cdx/v1/consumer-shares?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/cdx/v1/consumer-shares?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/cdx/v1/consumer-shares?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/cdx.v1.ConsumerShare' + - type: object + required: + - id + - metadata + - provider_organization_name + - provider_user_name + - consumer_user + - status + uniqueItems: true + partner.v2.Organization: + type: object + description: '`Organizations` objects represent an entire Confluent Cloud organization.' + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + name: + type: string + description: The name of the organization + example: Acme Organization + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + sso_url: + type: string + format: uri + description: The login URL for the customer to access Confluent Cloud + example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn + readOnly: true + sso_config: + oneOf: + - $ref: '#/components/schemas/AzureSSOConfig' + discriminator: + propertyName: kind + additionalProperties: false + AzureSSOConfig: + type: object + required: + - kind + - tenant_id + properties: + kind: + type: string + example: AzureSSOConfig + tenant_id: + type: string + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: The Azure AD tenant ID + +# Defaults for Org API + partner.v2.OrganizationList: + type: object + description: '`Organizations` objects represent an entire Confluent Cloud organization.' + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OrganizationList + metadata: + $ref: '#/components/schemas/ListMeta' + data: + type: array + items: + allOf: + - $ref: '#/components/schemas/partner.v2.Organization' + - type: object + required: + - id + - metadata + uniqueItems: true + additionalProperties: false + PartnerSignupRequest: + type: object + description: The partner signup request + required: + - organization + - entitlement + properties: + organization: + allOf: + - $ref: '#/components/schemas/partner.v2.Organization' + - required: + - name + - sso_config + user: + allOf: + - $ref: '#/components/schemas/v2.User' + - required: + - given_name + - family_name + - email + entitlement: + oneOf: + - allOf: + - $ref: '#/components/schemas/partner.v2.Entitlement' + - required: + - external_id + - name + - plan_id + - product_id + - allOf: + - $ref: '#/components/schemas/ObjectReference' + - required: + - related + PartnerSignupResponse: + type: object + description: The partner signup response + required: + - organization_id + - sso_url + properties: + organization_id: + type: string + description: The ID of the organization + example: b3a17773-05cc-4431-9560-433fb4613da8 + sso_url: + type: string + format: uri + description: The login URL for the customer to access Confluent Cloud + example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn + display_message: + type: string + description: The display message contains useful information which is shown + on the Marketplace UI to the customers. + example: Your support plan will remain the same, to change the plan, follow + this [link](https://docs.confluent.io/cloud/current/faq.html#how-do-i-change-support-plans). + ActivatePartnerSignupRequest: + type: object + description: The partner signup activation request + required: + - user + - organization_id + properties: + user: + allOf: + - $ref: '#/components/schemas/v2.User' + - required: + - given_name + - family_name + - email + organization_id: + type: string + description: The ID of the organization + example: b3a17773-05cc-4431-9560-433fb4613da8 + PartnerLinkRequest: + type: object + description: The partner linking request + required: + - token + - organization + - entitlement + properties: + token: + type: string + description: The linking token that was generated. + example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c + x-redact: true + organization: + allOf: + - $ref: '#/components/schemas/partner.v2.Organization' + - required: + - sso_config + entitlement: + oneOf: + - allOf: + - $ref: '#/components/schemas/partner.v2.Entitlement' + - required: + - external_id + - name + - plan_id + - product_id + - allOf: + - $ref: '#/components/schemas/ObjectReference' + - required: + - related + v2.User: + type: object + # This is just a stub til cross-API dependencies are better supported. It will be overridden. + networking.v1.Network: + type: object + description: |- + `Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud + provider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters. + Shared networks can contain any cluster type. + + The API allows you to list, create, read, update, and delete your networks. + + + Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + ## The Networks Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `dedicated_networks_per_environment` | Number of dedicated networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/networking/v1/networks/n-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-12345 + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + networking.v1.NetworkStatus: + type: object + required: + - phase + - supported_connection_types + - active_connection_types + description: The status of the Network + properties: + phase: + type: string + x-extensible-enum: [PROVISIONING, READY, FAILED, DEPROVISIONING] + description: | + The lifecyle phase of the network: + + PROVISIONING: network provisioning is in progress; + + READY: network is ready; + + FAILED: provisioning failed; + + DEPROVISIONING: network deprovisioning is in progress; + readOnly: true + example: READY + supported_connection_types: + type: array + description: The connection types this network supports. + items: + $ref: '#/components/schemas/networking.v1.ConnectionType' + uniqueItems: true + minItems: 1 + readOnly: true + active_connection_types: + type: array + description: The connection types requested for use with the network. + items: + $ref: '#/components/schemas/networking.v1.ConnectionType' + uniqueItems: true + minItems: 1 + readOnly: true + error_code: + type: string + # TODO - add link to docs on possible error codes? + description: Error code if network is in a failed state. May be used for + programmatic error checking. + readOnly: true + example: insufficient_capacity + error_message: + type: string + description: Displayable error message if network is in a failed state + readOnly: true + example: Could not provision cloud resources + dns_domain: + type: string + description: The root DNS domain for the network if applicable. Present + on networks that support PrivateLink. + example: 00000.us-east-1.aws.glb.confluent.cloud + readOnly: true + endpoint_suffix: + type: string + description: | + The endpoint suffix for the network, if applicable. Full service endpoints can be constructed by appending + the service identifier to the beginning of the endpoint suffix. For example, the Flink REST endpoint can be + constructed by adding "flink" - 'https://flink' + 'endpoint_suffix'. + example: .00000.us-east-1.aws.glb.confluent.cloud + readOnly: true + # zonal_subdomains field is optional b/c it only applies to v4 networks + zonal_subdomains: + type: object + additionalProperties: + type: string + description: | + The DNS subdomain for each zone. Present on networks that support PrivateLink. Keys are zones and + values are DNS domains. + example: + use1-az1: use1-az1.00000.us-east-1.aws.confluent.cloud + use1-az4: use1-az4.00000.us-east-1.aws.confluent.cloud + use1-az5: use1-az5.00000.us-east-1.aws.confluent.cloud + readOnly: true + # rhoover - not exposing static egress ips yet + # egress_ips field is optional b/c + # it may not be enabled on some networks nor for some orgs/SKUs, etc. + # it is not available immediately after a new creation request is accepted + # - name: egress_ips + # type: array + # items: + # type: string + # description: The list of IPs that will be used for egress from the network (e.g. Connectors + # reaching out to public IPs). Will be populated when the network reaches the READY state + # if the feature is available. + # readOnly: true + # cloud field is optional b/c it is not available immediately after a new creation request is accepted + cloud: + type: object + oneOf: + - $ref: '#/components/schemas/networking.v1.AwsNetwork' + - $ref: '#/components/schemas/networking.v1.GcpNetwork' + - $ref: '#/components/schemas/networking.v1.AzureNetwork' + description: The cloud-specific network details. These will be populated + when the network reaches the READY state. + discriminator: + propertyName: kind + mapping: + AwsNetwork: '#/components/schemas/networking.v1.AwsNetwork' + GcpNetwork: '#/components/schemas/networking.v1.GcpNetwork' + AzureNetwork: '#/components/schemas/networking.v1.AzureNetwork' + readOnly: true + idle_since: + type: string + format: date-time + example: 2024-01-01T00:00:00Z + description: The date and time when the network becomes idle + readOnly: true + readOnly: true + networking.v1.Peering: + type: object + description: |- + Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + * [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + ## The Peerings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/networking/v1/peerings/p-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/peering=p-12345 + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + networking.v1.PeeringStatus: + type: object + required: + - phase + description: The status of the Peering + properties: + phase: + type: string + x-extensible-enum: [PROVISIONING, PENDING_ACCEPT, READY, FAILED, DEPROVISIONING, + DISCONNECTED] + description: | + The lifecycle phase of the peering: + + PROVISIONING: peering provisioning is in progress; + + PENDING_ACCEPT: peering connection request is pending acceptance by the customer; + + READY: peering is ready; + + FAILED: peering is in a failed state; + + DEPROVISIONING: peering deprovisioning is in progress; + + DISCONNECTED: peering has been disconnected in the cloud provider by the customer; + readOnly: true + example: READY + error_code: + type: string + # TODO - add link to docs on possible error codes? + description: Error code if peering is in a failed state. May be used for + programmatic error checking. + readOnly: true + # example: connection_request_expired + error_message: + type: string + description: Displayable error message if peering is in a failed state + readOnly: true + # example: "??" + readOnly: true + networking.v1.TransitGatewayAttachment: + type: object + description: |- + AWS Transit Gateway Attachments + + Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + ## The Transit Gateway Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `tgw_attachments_per_network` | Number of TGW attachments per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/networking/v1/transit-gateway-attachments/tga-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/transit-gateway-attachment=tga-12345 + spec: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentStatus' + networking.v1.TransitGatewayAttachmentStatus: + type: object + required: + - phase + description: The status of the Transit Gateway Attachment + properties: + phase: + type: string + x-extensible-enum: [PROVISIONING, READY, PENDING_ACCEPT, FAILED, DEPROVISIONING, + DISCONNECTED, ERROR] + description: | + The lifecycle phase of the TGW attachment: + + PROVISIONING: attachment provisioning is in progress; + + PENDING_ACCEPT: attachment request is pending acceptance by the customer; + + READY: attachment is ready; + + FAILED: attachment is in a failed state; + + DEPROVISIONING: attachment deprovisioning is in progress; + + DISCONNECTED: attachment was manually deleted directly in the cloud provider by the customer; + + ERROR: invalid customer input during attachment creation. + readOnly: true + example: READY + error_code: + type: string + # TODO - add link to docs on possible error codes? + description: Error code if TGW attachment is in a failed state. May be used + for programmatic error checking. + readOnly: true + # example: attachment_request_rejected + error_message: + type: string + description: Displayable error message if TGW attachment is in a failed + state + readOnly: true + # example: "??" + cloud: + type: object + oneOf: + - $ref: '#/components/schemas/networking.v1.AwsTransitGatewayAttachmentStatus' + # - $ref: '#/components/schemas/networking.v1.GcpTransitGatewayAttachment' + # - $ref: '#/components/schemas/networking.v1.AzureTransitGatewayAttachment' + description: The cloud-specific TGW attachment details. + discriminator: + propertyName: kind + mapping: + AwsTransitGatewayAttachmentStatus: '#/components/schemas/networking.v1.AwsTransitGatewayAttachmentStatus' + # GcpTransitGatewayAttachment: '#/components/schemas/networking.v1.GcpTransitGatewayAttachment' + # AzureTransitGatewayAttachment: '#/components/schemas/networking.v1.AzureTransitGatewayAttachment' + readOnly: true + readOnly: true + networking.v1.PrivateLinkAccess: + type: object + description: |- + Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID. + + Related guides: + * [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + * [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + * [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + ## The Private Link Accesses Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_accounts_per_network` | Number of AWS accounts per network | + | `private_link_subscriptions_per_network` | Number of Azure subscriptions per network | + | `private_service_connect_projects_per_network` | Number of GCP projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/networking/v1/private-link-accesses/pla-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/private-link-access=pla-12345 + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + networking.v1.PrivateLinkAccessStatus: + type: object + required: + - phase + description: The status of the Private Link Access + properties: + phase: + type: string + x-extensible-enum: [PROVISIONING, READY, FAILED, DEPROVISIONING] + description: | + The lifecycle phase of the PrivateLink access configuration: + + PROVISIONING: PrivateLink access provisioning is in progress; + + READY: PrivateLink access is ready; + + FAILED: PrivateLink access is in a failed state; + + DEPROVISIONING: PrivateLink access deprovisioning is in progress; + readOnly: true + example: READY + error_code: + type: string + # TODO - add link to docs on possible error codes? + description: Error code if PrivateLink access is in a failed state. May + be used for programmatic error checking. + readOnly: true + # example: ?? + error_message: + type: string + description: Displayable error message if PrivateLink access is in a failed + state + readOnly: true + # example: "??" + readOnly: true + networking.v1.NetworkLinkService: + type: object + description: |- + Network Link Service is associated with a Private Link Confluent Cloud Network. + It enables connectivity from other Private Link Confluent Cloud Networks based on + the configured accept policies. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Services Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_service_per_network` | Number of network link services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/networking/v1/network-link-services/nls-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/network-link-service=nls-12345 + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceStatus' + networking.v1.NetworkLinkServiceStatus: + type: object + required: + - phase + description: The status of the Network Link Service + properties: + phase: + type: string + x-extensible-enum: [READY] + description: | + The lifecycle phase of the network link service: + + READY: network link service is ready; + readOnly: true + example: READY + error_code: + type: string + description: | + Error code if network link service is in a failed state. + May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if network link service is in a failed + state + readOnly: true + readOnly: true + networking.v1.NetworkLinkEndpoint: + type: object + description: |- + A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a + Network Link Service (associated with another Private Link Confluent Cloud Network) at the target. + It enables connectivity between the origin network and the target network. + It can only be associated with a Private Link network. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Endpoints Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_endpoints_per_network` | Number of network link endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/networking/v1/network-link-endpoints/nle-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/network-link-endpoint=nle-12345 + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointStatus' + networking.v1.NetworkLinkEndpointStatus: + type: object + required: + - phase + description: The status of the Network Link Endpoint + properties: + phase: + type: string + x-extensible-enum: [PROVISIONING, PENDING_ACCEPT, READY, FAILED, DEPROVISIONING, + EXPIRED, DISCONNECTED, DISCONNECTING, INACTIVE] + description: | + The lifecycle phase of the network link endpoint: + + PROVISIONING: network link endpoint provisioning is in progress; + + PENDING_ACCEPT: network link endpoint request is pending acceptance by the the owner of the target; + + READY: network link endpoint is ready; + + FAILED: network link endpoint is in a failed state; + + DEPROVISIONING: network link endpoint deprovisioning is in progress; + + EXPIRED: network link endpoint request is expired, can only be deleted; + + DISCONNECTED: network link endpoint is in a disconnected state, target owner has removed the permissions; + + DISCONNECTING: network link endpoint disconnection is in progress; + + INACTIVE: network link endpoint is created, but not active since there are no clusters in the network; + readOnly: true + example: READY + error_code: + type: string + description: Error code if network link is in a failed state. May be used + for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if network link is in a failed state + readOnly: true + expires_at: + type: string + format: date-time + example: 2024-01-01T00:00:00Z + description: The date and time when the request expires if it is not accepted + by the target network admin. + readOnly: true + readOnly: true + networking.v1.NetworkLinkServiceAssociation: + type: object + description: |- + List of incoming Network Link Enpoints associated with the Network Link Service. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Service Associations Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceAssociation + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/networking/v1/network-link-service-associations/nlsa-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/network-link-service=nls-12345/network-link-endpoint=nle-12345 + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceAssociationSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceAssociationStatus' + networking.v1.NetworkLinkServiceAssociationStatus: + type: object + required: + - phase + description: The status of the Network Link Service Association + properties: + phase: + type: string + x-extensible-enum: [PROVISIONING, PENDING_ACCEPT, READY, FAILED, DEPROVISIONING, + EXPIRED, DISCONNECTED, DISCONNECTING, INACTIVE] + description: | + The lifecycle phase of the network link endpoint: + + PROVISIONING: network link endpoint provisioning is in progress; + + PENDING_ACCEPT: network link endpoint request is pending acceptance by the the owner of the target; + + READY: network link endpoint is ready; + + FAILED: network link endpoint is in a failed state; + + DEPROVISIONING: network link endpoint deprovisioning is in progress; + + EXPIRED: network link endpoint request is expired, can only be deleted; + + DISCONNECTED: network link endpoint is in a disconnected state, target owner has removed the permissions; + + DISCONNECTING: network link endpoint disconnection is in progress; + + INACTIVE: network link endpoint is created, but not active since there are no clusters in the network; + example: READY + readOnly: true + error_code: + type: string + description: Error code if network link is in a failed state. May be used + for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if network link is in a failed state + readOnly: true + expires_at: + type: string + format: date-time + example: 2024-01-01T00:00:00Z + description: The date and time when the request expires if it is not accepted + by the target network admin. + readOnly: true + readOnly: true + networking.v1.Cidr: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+/\d+$ + description: IPv4 CIDR block + example: 10.200.0.0/16 + networking.v1.ConnectionType: + type: string + description: Network connection type. + x-extensible-enum: [PEERING, TRANSITGATEWAY, PRIVATELINK] + example: PRIVATELINK + networking.v1.DnsConfig: + type: object + description: The network DNS config + required: + - resolution + properties: + resolution: + type: string + description: Network DNS resolution type. + x-extensible-enum: [CHASED_PRIVATE, PRIVATE] + networking.v1.AwsNetwork: + type: object + description: The AWS network details. + required: + - kind + - vpc + - account + properties: + kind: + description: Network kind type. + type: string + enum: [AwsNetwork] + vpc: + type: string + description: The Confluent Cloud VPC ID. + example: vpc-00000000000000000 + readOnly: true + account: + type: string + description: The AWS account ID associated with the Confluent Cloud VPC. + example: '000000000000' + readOnly: true + private_link_endpoint_service: + type: string + description: The endpoint service of the Confluent Cloud VPC. (used for + PrivateLink) if available. + example: com.amazonaws.vpce.eu-west-3.vpce-00000000000000000 + readOnly: true + networking.v1.GcpNetwork: + type: object + description: The GCP network details. + required: + - kind + - project + - vpc_network + properties: + kind: + description: Network kind type. + type: string + enum: [GcpNetwork] + project: + type: string + description: The GCP Project ID associated with the Confluent Cloud VPC. + example: cc-prod-3 + readOnly: true + vpc_network: + type: string + description: The network name of the Confluent Cloud VPC. + example: prod-network + readOnly: true + private_service_connect_service_attachments: + type: object + # yamllint disable-line rule:line-length + description: | + The mapping of zones to Private Service Connect Service + Attachments if available. Keys are zones and values are + [GCP Private Service Connect Service + Attachment](https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#api_7) + additionalProperties: + type: string + example: + # yamllint disable-line rule:line-length + us-central1-a: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-a + # yamllint disable-line rule:line-length + us-central1-b: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-b + # yamllint disable-line rule:line-length + us-central1-c: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-c + readOnly: true + networking.v1.AzureNetwork: + type: object + description: The Azure network details. + required: + - kind + - vnet + - subscription + properties: + kind: + description: Network kind type. + type: string + enum: [AzureNetwork] + vnet: + type: string + description: The resource ID of the Confluent Cloud VNet. + # yamllint disable-line rule:line-length + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/prod-group/providers/Microsoft.Network/virtualNetworks/prod-network + readOnly: true + subscription: + type: string + description: The Azure Subscription ID associated with the Confluent Cloud + VPC. + example: 00000000-0000-0000-0000-000000000000 + readOnly: true + private_link_service_aliases: + type: object + description: | + The mapping of zones to Private Link Service Aliases if available. Keys are zones + and values are [Azure Private Link Service + Aliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service). + additionalProperties: + type: string + example: + '1': 0-00000-privatelink-1.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '2': 0-00000-privatelink-2.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '3': 0-00000-privatelink-3.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + readOnly: true + private_link_service_resource_ids: + type: object + description: | + The mapping of zones to Private Link Service Resource IDs if available. Keys are zones + and values are [Azure Private Link Service Resource + IDs](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service). + additionalProperties: + type: string + example: + # yamllint disable-line rule:line-length + '1': /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-1 + # yamllint disable-line rule:line-length + '2': /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-2 + # yamllint disable-line rule:line-length + '3': /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-3 + readOnly: true + networking.v1.AwsPeering: + type: object + title: AWS + description: AWS VPC Peering. + required: + - kind + - account + - vpc + - routes + - customer_region + properties: + kind: + description: Peering kind type. + type: string + enum: [AwsPeering] + account: + type: string + pattern: ^\d{12}$ + example: '000000000000' + description: The AWS account ID associated with the VPC you are peering + with Confluent Cloud network. + vpc: + type: string + minLength: 1 + description: The VPC ID you are peering with Confluent Cloud network. + example: vpc-00000000000000000 + routes: + type: array + items: + $ref: '#/components/schemas/networking.v1.Cidr' + description: | + The [CIDR blocks](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) of the VPC you are peering + with Confluent Cloud network. This is used by Confluent Cloud network to route traffic back to your network. + The CIDR block must be a private range and cannot overlap with the Confluent Cloud CIDR block. + example: [10.108.16.0/21] + customer_region: + type: string + description: The region of the VPC you are peering with Confluent Cloud + network. + example: us-east-1 + networking.v1.GcpPeering: + type: object + title: GCP + description: GCP VPC Peering. + required: + - kind + - project + - vpc_network + properties: + kind: + description: Peering kind type. + type: string + enum: [GcpPeering] + example: GcpPeering + project: + type: string + minLength: 1 + description: | + The Google Cloud project ID associated with the VPC that you are peering with Confluent Cloud network. + example: my-gcp-project + vpc_network: + type: string + minLength: 1 + description: The name of the VPC that you are peering with Confluent Cloud + network. + example: my-gcp-network + import_custom_routes: + type: boolean + description: | + Enable customer route import. For more information, see + [Importing custom routes](https://cloud.google.com/vpc/docs/vpc-peering#importing-exporting-routes). + example: true + default: false + networking.v1.AzurePeering: + type: object + title: AZURE + description: Azure VNet Peering. + required: + - kind + - tenant + - vnet + - customer_region + properties: + kind: + description: Peering kind type. + type: string + enum: [AzurePeering] + tenant: + type: string + minLength: 1 + description: | + The Azure Tenant ID in which your Azure Subscription exists. + Represents an organization in Azure Active Directory. You can find your Azure Tenant ID in the Azure Portal + under + [Azure Active Directory](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview). + Must be a valid **32 character UUID string**. + vnet: + type: string + minLength: 1 + # yamllint disable-line rule:line-length + description: The resource ID of the VNet that you are peering with Confluent + Cloud. You can find the name of your Azure VNet in the [Azure Portal on + the Overview tab of your Azure Virtual Network](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Network%2FvirtualNetworks). + # yamllint disable-line rule:line-length + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet + customer_region: + type: string + description: The region of the VNet you are peering with Confluent Cloud + network. + example: eastus2 + networking.v1.AwsTransitGatewayAttachment: + type: object + title: AWS + description: AWS Transit Gateway Attachment. + required: + - kind + - ram_share_arn + - transit_gateway_id + - routes + properties: + kind: + description: AWS Transit Gateway Attachment kind type. + type: string + enum: [AwsTransitGatewayAttachment] + ram_share_arn: + description: The full AWS Resource Name (ARN) for the AWS Resource Access + Manager (RAM) Share of the Transit Gateways that you want Confluent Cloud + to be attached to. + type: string + example: arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx + transit_gateway_id: + description: The ID of the AWS Transit Gateway that you want Confluent CLoud + to be attached to. + type: string + example: tgw-xxxxxxxxxxxxxxxxx + routes: + type: array + items: + $ref: '#/components/schemas/networking.v1.Cidr' + description: List of destination routes. + example: [100.64.0.0/10, 10.0.0.0/8, 192.168.0.0/16, 172.16.0.0/12] + networking.v1.AwsTransitGatewayAttachmentStatus: + type: object + title: AWS + description: AWS Transit Gateway Attachment details generated by AWS. + required: + - transit_gateway_attachment_id + properties: + kind: + description: AWS Transit Gateway Attachment Status kind type. + type: string + enum: [AwsTransitGatewayAttachmentStatus] + transit_gateway_attachment_id: + description: The ID of the AWS Transit Gateway VPC Attachment that attaches + Confluent VPC to Transit Gateway. + type: string + example: tgw-attach-xxxxx + readOnly: true + networking.v1.AwsPrivateLinkAccess: + type: object + title: AWS + description: AWS PrivateLink access configuration. + required: + - kind + - account + properties: + kind: + description: PrivateLink kind type. + type: string + enum: [AwsPrivateLinkAccess] + account: + type: string + pattern: ^\d{12}$ + example: '000000000000' + description: | + The AWS account ID for the account containing the VPCs you want to connect from using AWS PrivateLink. + You can find your AWS account ID [here](https://console.aws.amazon.com/billing/home?#/account) + under **My Account** in your AWS Management Console. Must be a **12 character string**. + networking.v1.AzurePrivateLinkAccess: + type: object + title: AZURE + description: Azure PrivateLink access configuration. + required: + - kind + - subscription + properties: + kind: + description: PrivateLink kind type. + type: string + enum: [AzurePrivateLinkAccess] + subscription: + type: string + minLength: 1 + description: | + The Azure subscription ID for the account containing the VNets you want to connect from using + Azure Private Link. You can find your Azure subscription ID in the subscription section of your + [Microsoft Azure Portal](https://portal.azure.com/#blade/Microsoft_Azure_Billing/SubscriptionsBlade). + Must be a valid **32 character UUID string**. + networking.v1.GcpPrivateServiceConnectAccess: + type: object + title: GCP + description: GCP Private Service Connect access configuration. + required: + - kind + - project + properties: + kind: + description: PrivateLink kind type. + type: string + enum: [GcpPrivateServiceConnectAccess] + project: + type: string + minLength: 1 + description: | + The GCP project ID for the account containing the VPCs that you want to connect from + using Private Service Connect. You can find your Google Cloud Project ID under **Project ID** section of + your [Google Cloud Console dashboard](https://console.cloud.google.com/home/dashboard). + networking.v1.NetworkLinkServiceAcceptPolicy: + type: object + title: Network Link Service + description: | + List of environments/networks from which connections can be accepted on this network link service. + properties: + environments: + description: | + List of environments from which connections can be accepted. + All networks win the list of environment will be allowed. + type: array + items: + type: string + uniqueItems: true + networks: + description: | + List of networks from which connections can be accepted. + type: array + items: + type: string + uniqueItems: true + + networking.v1.ZoneInfo: + type: object + description: Cloud provider zone metadata. + properties: + zone_id: + description: Cloud provider zone id + type: string + example: use1-az3 + # This attribute is optional since later on it can be used by non-peering networks where CIDR is not required + cidr: + description: | + The IPv4 [CIDR block](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) to used for this network. + Must be a `/27`. Required for VPC peering and AWS TransitGateway. + type: string + example: 10.20.0.0/27 + +# Defaults for Network API + networking.v1.NetworkList: + type: object + description: |- + `Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud + provider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters. + Shared networks can contain any cluster type. + + The API allows you to list, create, read, update, and delete your networks. + + + Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + ## The Networks Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `dedicated_networks_per_environment` | Number of dedicated networks per Confluent Cloud environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/networking/v1/networks + last: + example: https://api.confluent.cloud/networking/v1/networks?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/networking/v1/networks?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/networking/v1/networks?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/networking.v1.Network' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - cloud + - region + - connection_types + - environment + uniqueItems: true + networking.v1.NetworkSpec: + type: object + description: The desired state of the Network + properties: + display_name: + type: string + description: The name of the network + example: prod-aws-us-east1 + cloud: + type: string + description: The cloud service provider in which the network exists. + x-extensible-enum: [AWS, GCP, AZURE] + example: AWS + x-immutable: true + region: + type: string + description: The cloud service provider region in which the network exists. + example: us-east-1 + x-immutable: true + connection_types: + type: array + description: The connection types requested for use with the network. + items: + $ref: '#/components/schemas/networking.v1.ConnectionType' + uniqueItems: true + minItems: 1 + x-immutable: true + cidr: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+/\d+$ + description: | + The IPv4 [CIDR block](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) to used for this network. + Must be `/16`. Required for VPC peering and AWS TransitGateway. + example: 10.200.0.0/16 + x-immutable: true + zones: + type: array + items: + type: string + uniqueItems: true + minItems: 3 + maxItems: 3 + description: | + The 3 availability zones for this network. They can optionally be specified for AWS networks + used with PrivateLink, for GCP networks used with Private Service Connect, and for AWS and GCP + networks used with Peering. + Otherwise, they are automatically chosen by Confluent Cloud. + + On AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) + (e.g. use1-az3) + + On GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones) + (e.g. us-central1-c). + + On Azure, zones are Confluent-chosen names (e.g. 1, 2, 3) since Azure does not + have universal zone identifiers. + example: [use1-az1, use1-az2, use1-az3] + x-immutable: true + zones_info: + type: array + minItems: 3 + maxItems: 3 + uniqueItems: true + items: + $ref: '#/components/schemas/networking.v1.ZoneInfo' + # yamllint disable rule:line-length + description: | + Each item represents information related to a single zone. + + Note - The attribute is in a [Limited Availability lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + x-immutable: true + dns_config: + description: | + DNS config only applies to PrivateLink network connection type. + + When resolution is CHASED_PRIVATE, clusters in this network require both public and private DNS + to resolve cluster endpoints. + + When resolution is PRIVATE, clusters in this network only require private DNS + to resolve cluster endpoints. + + allOf: + - $ref: '#/components/schemas/networking.v1.DnsConfig' + x-immutable: true + reserved_cidr: + type: string + # yamllint disable rule:line-length + description: | + The reserved CIDR config is used only by AWS networks with connection_types = Vpc_Peering or Transit_Gateway + + An IPv4 [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + reserved for Confluent Cloud Network. Must be \24. + If not specified, Confluent Cloud Network uses 172.20.255.0/24 + + Note - The attribute is in a [Limited Availability lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: 172.20.255.0/24 + x-immutable: true + environment: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The environment to which this belongs. + gateway: + allOf: + - $ref: '#/components/schemas/TypedEnvScopedObjectReference' + nullable: true + description: The gateway associated with this object. The gateway can be + one of networking.v1.Gateway. May be `null` or omitted if not associated + with a gateway. + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.PeeringList: + type: object + description: |- + Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + * [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + ## The Peerings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `peerings_per_network` | Number of peerings per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PeeringList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/networking/v1/peerings + last: + example: https://api.confluent.cloud/networking/v1/peerings?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/networking/v1/peerings?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/networking/v1/peerings?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/networking.v1.Peering' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - network + uniqueItems: true + networking.v1.PeeringSpec: + type: object + description: The desired state of the Peering + properties: + display_name: + type: string + description: The name of the peering + example: prod-peering-use1 + cloud: + type: object + oneOf: + - $ref: '#/components/schemas/networking.v1.AwsPeering' + - $ref: '#/components/schemas/networking.v1.GcpPeering' + - $ref: '#/components/schemas/networking.v1.AzurePeering' + discriminator: + propertyName: kind + mapping: + AwsPeering: '#/components/schemas/networking.v1.AwsPeering' + GcpPeering: '#/components/schemas/networking.v1.GcpPeering' + AzurePeering: '#/components/schemas/networking.v1.AzurePeering' + description: The cloud-specific peering details. + x-immutable: true + environment: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The environment to which this belongs. + network: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The network to which this belongs. + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.TransitGatewayAttachmentList: + type: object + description: |- + AWS Transit Gateway Attachments + + Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + ## The Transit Gateway Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `tgw_attachments_per_network` | Number of TGW attachments per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachmentList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/networking/v1/transit-gateway-attachments + last: + example: https://api.confluent.cloud/networking/v1/transit-gateway-attachments?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/networking/v1/transit-gateway-attachments?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/networking/v1/transit-gateway-attachments?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/networking.v1.TransitGatewayAttachment' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - network + uniqueItems: true + networking.v1.TransitGatewayAttachmentSpec: + type: object + description: The desired state of the Transit Gateway Attachment + properties: + display_name: + type: string + description: The name of the TGW attachment + example: prod-tgw-use1 + cloud: + type: object + oneOf: + - $ref: '#/components/schemas/networking.v1.AwsTransitGatewayAttachment' + discriminator: + propertyName: kind + mapping: + AwsTransitGatewayAttachment: '#/components/schemas/networking.v1.AwsTransitGatewayAttachment' + description: The cloud-specific Transit Gateway details. + x-immutable: true + environment: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The environment to which this belongs. + network: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The network to which this belongs. + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.PrivateLinkAccessList: + type: object + description: |- + Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID. + + Related guides: + * [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + * [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + * [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + ## The Private Link Accesses Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_accounts_per_network` | Number of AWS accounts per network | + | `private_link_subscriptions_per_network` | Number of Azure subscriptions per network | + | `private_service_connect_projects_per_network` | Number of GCP projects per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccessList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/networking/v1/private-link-accesses + last: + example: https://api.confluent.cloud/networking/v1/private-link-accesses?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/networking/v1/private-link-accesses?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/networking/v1/private-link-accesses?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAccess' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - network + uniqueItems: true + networking.v1.PrivateLinkAccessSpec: + type: object + description: The desired state of the Private Link Access + properties: + display_name: + type: string + description: The name of the PrivateLink access + example: prod-pl-use1 + cloud: + type: object + oneOf: + - $ref: '#/components/schemas/networking.v1.AwsPrivateLinkAccess' + - $ref: '#/components/schemas/networking.v1.AzurePrivateLinkAccess' + - $ref: '#/components/schemas/networking.v1.GcpPrivateServiceConnectAccess' + discriminator: + propertyName: kind + mapping: + AwsPrivateLinkAccess: '#/components/schemas/networking.v1.AwsPrivateLinkAccess' + AzurePrivateLinkAccess: '#/components/schemas/networking.v1.AzurePrivateLinkAccess' + GcpPrivateServiceConnectAccess: '#/components/schemas/networking.v1.GcpPrivateServiceConnectAccess' + description: The cloud-specific PrivateLink details. + x-immutable: true + environment: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The environment to which this belongs. + network: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The network to which this belongs. + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.NetworkLinkServiceList: + type: object + description: |- + Network Link Service is associated with a Private Link Confluent Cloud Network. + It enables connectivity from other Private Link Confluent Cloud Networks based on + the configured accept policies. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Services Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_service_per_network` | Number of network link services per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/networking/v1/network-link-services + last: + example: https://api.confluent.cloud/networking/v1/network-link-services?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/networking/v1/network-link-services?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/networking/v1/network-link-services?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkService' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - environment + - network + uniqueItems: true + networking.v1.NetworkLinkServiceSpec: + type: object + description: The desired state of the Network Link Service + properties: + display_name: + type: string + description: The name of the network link service + example: prod-net-1-nls + description: + type: string + description: The description of the network link service + example: Allow connections from analytics hub + accept: + description: Network Link Service Accept policy + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkServiceAcceptPolicy' + environment: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The environment to which this belongs. + network: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The network to which this belongs. + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.NetworkLinkEndpointList: + type: object + description: |- + A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a + Network Link Service (associated with another Private Link Confluent Cloud Network) at the target. + It enables connectivity between the origin network and the target network. + It can only be associated with a Private Link network. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Endpoints Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_endpoints_per_network` | Number of network link endpoints per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpointList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/networking/v1/network-link-endpoints + last: + example: https://api.confluent.cloud/networking/v1/network-link-endpoints?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/networking/v1/network-link-endpoints?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/networking/v1/network-link-endpoints?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkEndpoint' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - environment + - network + - network_link_service + uniqueItems: true + networking.v1.NetworkLinkEndpointSpec: + type: object + description: The desired state of the Network Link Endpoint + properties: + display_name: + type: string + description: The name of the network link endpoint + example: prod-net-1-nle + description: + type: string + description: The description of the network link endpoint + example: Connect to Network - analytics hub + environment: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The environment to which this belongs. + network: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The network to which this belongs. + x-immutable: true + network_link_service: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The network_link_service to which this belongs. + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.NetworkLinkServiceAssociationList: + type: object + description: |- + List of incoming Network Link Enpoints associated with the Network Link Service. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Service Associations Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceAssociationList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/networking/v1/network-link-service-associations + last: + example: https://api.confluent.cloud/networking/v1/network-link-service-associations?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/networking/v1/network-link-service-associations?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/networking/v1/network-link-service-associations?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/networking.v1.NetworkLinkServiceAssociation' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - display_name + - network_link_endpoint + - network_link_service + - environment + uniqueItems: true + networking.v1.NetworkLinkServiceAssociationSpec: + type: object + description: The desired state of the Network Link Service Association + properties: + display_name: + type: string + description: The name of the network link endpoint + readOnly: true + example: prod-net-1-nle + description: + type: string + description: The description of the network link endpoint + readOnly: true + example: Connect to Network - analytics hub + network_link_endpoint: + type: string + description: ID of the Network link endpoint. + readOnly: true + example: prod-net-1-nle + network_link_service: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The network_link_service to which this belongs. + x-immutable: true + environment: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The environment to which this belongs. + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.IpAddress: + type: object + description: |- + IP Addresses + + Related guide: [Use Public Egress IP addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + ## The IP Addresses Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpAddress + ip_prefix: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+/\d+$ + description: The IP Address range. + example: 10.200.0.0/28 + cloud: + type: string + description: The cloud service provider in which the address exists. + x-extensible-enum: [AWS, GCP, AZURE, ANY] + example: AWS + region: + type: string + description: The region/location where the IP Address is in use. + example: us-east-1 + services: + type: array + description: The service types that will use the address. + items: + type: string + description: Address service type. + x-extensible-enum: [KAFKA, CONNECT, EXTERNAL_OAUTH] + example: CONNECT + uniqueItems: true + minItems: 1 + address_type: + type: string + description: Whether the address is used for egress or ingress. + x-extensible-enum: [INGRESS, EGRESS] + example: EGRESS + networking.v1.IpAddressList: + type: object + description: |- + IP Addresses + + Related guide: [Use Public Egress IP Addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + ## The IP Addresses Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpAddressList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/networking/v1/ip-addresses + last: + example: https://api.confluent.cloud/networking/v1/ip-addresses?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/networking/v1/ip-addresses?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/networking/v1/ip-addresses?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/networking.v1.IpAddress' + - type: object + uniqueItems: true + networking.v1.PrivateLinkAttachment: + type: object + description: |- + PrivateLink attachment objects represent reservations to establish PrivateLink connections + to a cloud region in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachments. + + + ## The Private Link Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_attachments_per_environment` | Number of PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/networking/v1/private-link-attachments/platt-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/private-link-attachment=platt-12345 + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentStatus' + networking.v1.PrivateLinkAttachmentStatus: + type: object + required: + - phase + description: The status of the Private Link Attachment + properties: + phase: + type: string + x-extensible-enum: [PROVISIONING, WAITING_FOR_CONNECTIONS, READY, FAILED, + EXPIRED, DEPROVISIONING] + description: | + The lifecycle phase of the PrivateLink attachment: + + PROVISIONING: PrivateLink attachment provisioning is in progress; + + WAITING_FOR_CONNECTIONS: PrivateLink attachment is waiting for connections; + + READY: PrivateLink attachment is ready; + + FAILED: PrivateLink attachment is in a failed state; + + EXPIRED: PrivateLink attachment has timed out waiting for connections, can only be deleted; + + DEPROVISIONING: PrivateLink attachment deprovisioning is in progress; + readOnly: true + example: READY + error_code: + type: string + description: Error code if PrivateLink attachment is in a failed state. + May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if PrivateLink attachment is in a + failed state. + readOnly: true + dns_domain: + type: string + description: The root DNS domain for the PrivateLink attachment. + example: us-east-1.aws.private.confluent.cloud + readOnly: true + # cloud field is optional b/c it is not available immediately after a new creation request is accepted + cloud: + type: object + description: The cloud specific status of the PrivateLink attachment. These + will be populated when the PrivateLink attachment reaches the WAITING_FOR_CONNECTIONS + state. + oneOf: + - $ref: '#/components/schemas/networking.v1.AwsPrivateLinkAttachmentStatus' + - $ref: '#/components/schemas/networking.v1.AzurePrivateLinkAttachmentStatus' + - $ref: '#/components/schemas/networking.v1.GcpPrivateLinkAttachmentStatus' + discriminator: + propertyName: kind + mapping: + AwsPrivateLinkAttachmentStatus: '#/components/schemas/networking.v1.AwsPrivateLinkAttachmentStatus' + AzurePrivateLinkAttachmentStatus: '#/components/schemas/networking.v1.AzurePrivateLinkAttachmentStatus' + GcpPrivateLinkAttachmentStatus: '#/components/schemas/networking.v1.GcpPrivateLinkAttachmentStatus' + readOnly: true + readOnly: true + networking.v1.PrivateLinkAttachmentConnection: + type: object + description: |- + PrivateLink attachment connection objects represent connections established to a cloud region + in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachment connections. + + + ## The Private Link Attachment Connections Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/networking/v1/private-link-attachment-connections/plattc-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/private-link-attachment-connection=plattc-12345 + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus' + networking.v1.PrivateLinkAttachmentConnectionStatus: + type: object + required: + - phase + description: The status of the Private Link Attachment Connection + properties: + phase: + type: string + x-extensible-enum: [PROVISIONING, READY, FAILED, DEPROVISIONING, DISCONNECTED] + description: | + The lifecycle phase of the PrivateLink attachment: + + PROVISIONING: PrivateLink attachment connection provisioning is in progress; + + READY: PrivateLink attachment connection is ready; + + FAILED: PrivateLink attachment connection is in a failed state; + + DEPROVISIONING: PrivateLink attachment connection deprovisioning is in progress; + + DISCONNECTED:| + PrivateLink attachment connection is in a disconnected state. This means the + private endpoint associated with this PrivateLink attachment connection has been deleted; + readOnly: true + example: READY + error_code: + type: string + description: Error code if PrivateLink attachment connection is in a failed + state. May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if PrivateLink attachment connection + is in a failed state. + readOnly: true + cloud: + type: object + description: The cloud specific status of the PrivateLink attachment connection. + oneOf: + - $ref: '#/components/schemas/networking.v1.AwsPrivateLinkAttachmentConnectionStatus' + - $ref: '#/components/schemas/networking.v1.AzurePrivateLinkAttachmentConnectionStatus' + - $ref: '#/components/schemas/networking.v1.GcpPrivateLinkAttachmentConnectionStatus' + discriminator: + propertyName: kind + mapping: + AwsPrivateLinkAttachmentConnectionStatus: '#/components/schemas/networking.v1.AwsPrivateLinkAttachmentConnectionStatus' + AzurePrivateLinkAttachmentConnectionStatus: '#/components/schemas/networking.v1.AzurePrivateLinkAttachmentConnectionStatus' + GcpPrivateLinkAttachmentConnectionStatus: '#/components/schemas/networking.v1.GcpPrivateLinkAttachmentConnectionStatus' + readOnly: true + readOnly: true + networking.v1.AwsPrivateLinkAttachmentStatus: + description: | + AWS PrivateLink attachment represents reserved capacity in an + AWS VPC Endpoint Service that can be used to establish PrivateLink + connections. + type: object + required: + - kind + - vpc_endpoint_service + properties: + kind: + type: string + description: PrivateLinkAttachmentStatus kind. + enum: [AwsPrivateLinkAttachmentStatus] + readOnly: true + vpc_endpoint_service: + description: | + AWS VPC Endpoint Service that can be used to establish connections for all zones. + type: object + readOnly: true + allOf: + - $ref: '#/components/schemas/networking.v1.AwsVpcEndpointService' + networking.v1.AwsVpcEndpointService: + description: | + AWS VPC Endpoint service that can be used to create VPC Endpoints. + type: object + required: + - vpc_endpoint_service_name + properties: + vpc_endpoint_service_name: + type: string + description: Id of the VPC Endpoint service. + readOnly: true + networking.v1.AzurePrivateLinkAttachmentStatus: + type: object + description: | + Azure PrivateLink attachment represents reserved capacity in a + PrivateLink service that can be used to establish PrivateLink + required: + - kind + - private_link_service + properties: + kind: + type: string + description: PrivateLinkAttachmentStatus kind. + enum: [AzurePrivateLinkAttachmentStatus] + readOnly: true + private_link_service: + description: | + Azure PrivateLink service that can be used to connect to a PrivateEndpoint. + type: object + readOnly: true + allOf: + - $ref: '#/components/schemas/networking.v1.AzurePrivateLinkService' + networking.v1.AzurePrivateLinkService: + type: object + description: | + Azure Private Link Service with reserved capacity to connect a Private Endpoint. + required: + - private_link_service_alias + - private_link_service_resource_id + properties: + private_link_service_alias: + description: Azure PrivateLink service alias. + type: string + minLength: 1 + readOnly: true + example: pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Azure PrivateLink service resource id. + type: string + minLength: 1 + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef + networking.v1.GcpPrivateLinkAttachmentStatus: + type: object + description: | + GCP PrivateLink attachment represents reserved capacity in a + GCP PSC Service attachment. A PSC Endpoint can be connected to + the Service attachment. + required: + - kind + - service_attachment + properties: + kind: + type: string + description: PrivateLinkAttachmentStatus kind. + enum: [GcpPrivateLinkAttachmentStatus] + readOnly: true + service_attachment: + description: | + GCP PSC Service attachment that can be used to connect + to a PSC Endpoint. + type: object + readOnly: true + allOf: + - $ref: '#/components/schemas/networking.v1.GcpPscServiceAttachment' + networking.v1.GcpPscServiceAttachment: + type: object + description: | + GCP PSC Service attachment with reserved capacity to + connect a PSC Endpoint. + required: + - private_service_connect_service_attachment + properties: + private_service_connect_service_attachment: + description: Id of a Private Service Connect Service Attachment in Confluent + Cloud. + type: string + minLength: 1 + readOnly: true + example: projects/example-project/regions/us-central1/serviceAttachments/plt-abcdef-service-attachment-us-central1 + networking.v1.AwsPrivateLinkAttachmentConnectionStatus: + description: Status of a connection to an AWS PrivateLink attachment. + type: object + required: + - kind + - vpc_endpoint_service_name + - vpc_endpoint_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnectionStatus kind. + enum: [AwsPrivateLinkAttachmentConnectionStatus] + vpc_endpoint_service_name: + description: Id of the VPC Endpoint service used for PrivateLink. + type: string + minLength: 1 + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + readOnly: true + vpc_endpoint_id: + description: Id of the VPC Endpoint (if any) that is connected to the VPC + Endpoint service. + type: string + minLength: 1 + readOnly: true + example: vpce-00000000000000000 + networking.v1.AzurePrivateLinkAttachmentConnectionStatus: + description: Status of a Azure PrivateLink attachment connection. + type: object + required: + - kind + - private_link_service_alias + - private_link_service_resource_id + - private_endpoint_resource_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnectionStatus kind. + enum: [AzurePrivateLinkAttachmentConnectionStatus] + private_link_service_alias: + description: Azure PrivateLink service alias. + type: string + minLength: 1 + readOnly: true + example: pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Azure PrivateLink service resource id. + type: string + minLength: 1 + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3 + private_endpoint_resource_id: + description: | + Resource Id of the PrivateEndpoint (if any) that is connected to + the PrivateLink service. + type: string + minLength: 1 + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3 + networking.v1.GcpPrivateLinkAttachmentConnectionStatus: + description: Status of GCP PrivateLink attachment connection. + type: object + required: + - kind + - private_service_connect_service_attachment + - private_service_connect_connection_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnectionStatus kind. + enum: [GcpPrivateLinkAttachmentConnectionStatus] + private_service_connect_service_attachment: + description: GCP Private Service Connect ServiceAttachment. + type: string + minLength: 1 + readOnly: true + example: projects/example-project/regions/us-central1/serviceAttachments/plt-abcdef-service-attachment-us-central1-a + private_service_connect_connection_id: + description: Id of the Private Service connection. + type: string + minLength: 1 + readOnly: true + example: '00000000000000000' + networking.v1.AwsPrivateLinkAttachmentConnection: + description: Represents a connection between an AWS VPC Endpoint and an Endpoint + service. + type: object + required: + - kind + - vpc_endpoint_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnection kind. + enum: [AwsPrivateLinkAttachmentConnection] + vpc_endpoint_id: + description: Id of a VPC Endpoint that is connected to the VPC Endpoint + service. + type: string + minLength: 1 + example: vpce-00000000000000000 + networking.v1.AzurePrivateLinkAttachmentConnection: + description: Represents a connection between an Azure PrivateLink service and + a PrivateEndpoint. + type: object + required: + - kind + - private_endpoint_resource_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnection kind. + enum: [AzurePrivateLinkAttachmentConnection] + private_endpoint_resource_id: + description: | + Resource Id of the PrivateEndpoint that is connected to the PrivateLink service. + type: string + minLength: 1 + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3 + networking.v1.GcpPrivateLinkAttachmentConnection: + type: object + description: Represents a connection between a GCP PSC Service Attachment and + a PSC Endpoint. + required: + - kind + - private_service_connect_connection_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnection kind. + enum: [GcpPrivateLinkAttachmentConnection] + private_service_connect_connection_id: + description: Id of the Private Service connection. + type: string + minLength: 1 + example: '00000000000000000' + +# default + networking.v1.PrivateLinkAttachmentList: + type: object + description: |- + PrivateLink attachment objects represent reservations to establish PrivateLink connections + to a cloud region in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachments. + + + ## The Private Link Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_attachments_per_environment` | Number of PrivateLink Attachments per environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/networking/v1/private-link-attachments + last: + example: https://api.confluent.cloud/networking/v1/private-link-attachments?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/networking/v1/private-link-attachments?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/networking/v1/private-link-attachments?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAttachment' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - cloud + - region + - environment + uniqueItems: true + networking.v1.PrivateLinkAttachmentSpec: + type: object + description: The desired state of the Private Link Attachment + properties: + display_name: + type: string + description: The name of the PrivateLink attachment. + example: prod-aws-us-east1 + cloud: + type: string + description: | + The cloud service provider that hosts the resources to access with the PrivateLink attachment. + x-extensible-enum: [AWS, GCP, AZURE] + example: AWS + x-immutable: true + region: + type: string + description: | + The cloud service provider region where the resources to be accessed + using the PrivateLink attachment are located. + example: us-east-1 + x-immutable: true + environment: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The environment to which this belongs. + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.PrivateLinkAttachmentConnectionList: + type: object + description: |- + PrivateLink attachment connection objects represent connections established to a cloud region + in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachment connections. + + + ## The Private Link Attachment Connections Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnectionList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/networking/v1/private-link-attachment-connections + last: + example: https://api.confluent.cloud/networking/v1/private-link-attachment-connections?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/networking/v1/private-link-attachment-connections?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/networking/v1/private-link-attachment-connections?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnection' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - cloud + - environment + - private_link_attachment + uniqueItems: true + networking.v1.PrivateLinkAttachmentConnectionSpec: + type: object + description: The desired state of the Private Link Attachment Connection + properties: + display_name: + type: string + description: The name of the PrivateLink attachment connection. + example: prod-gcp-us-central1-a + cloud: + type: object + description: The cloud-specific PrivateLink attachment connection details. + oneOf: + - $ref: '#/components/schemas/networking.v1.AwsPrivateLinkAttachmentConnection' + - $ref: '#/components/schemas/networking.v1.AzurePrivateLinkAttachmentConnection' + - $ref: '#/components/schemas/networking.v1.GcpPrivateLinkAttachmentConnection' + discriminator: + propertyName: kind + mapping: + AwsPrivateLinkAttachmentConnection: '#/components/schemas/networking.v1.AwsPrivateLinkAttachmentConnection' + AzurePrivateLinkAttachmentConnection: '#/components/schemas/networking.v1.AzurePrivateLinkAttachmentConnection' + GcpPrivateLinkAttachmentConnection: '#/components/schemas/networking.v1.GcpPrivateLinkAttachmentConnection' + x-immutable: true + environment: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The environment to which this belongs. + private_link_attachment: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The private_link_attachment to which this belongs. + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + iam.v2.IdentityProvider: + type: object + description: |- + `IdentityProvider` objects represent external OAuth-OIDC providers in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Identity Provider. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Identity Providers Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_providers_per_org` | Number of OAuth identity providers per organization | + | `public_keys_per_provider` | Number of public keys saved per identity provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProvider + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/iam/v2/identity-providers/ip-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/identity-provider=ip-12345 + display_name: + type: string + description: The human-readable name of the OAuth identity provider. + example: My OIDC Provider + description: + type: string + description: A description of the identity provider. + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). This appears + in audit log records. Note: if the client specifies mapping to one identity pool ID, the identity + claim configured with that pool will be used instead. + Note - The attribute is in an [Early Access lifecycle stage] + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: claims.sub + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity provider. + example: ENABLED + readOnly: true + issuer: + type: string + format: uri + description: |- + A publicly accessible URL uniquely identifying the OAuth + identity provider authorized to issue access tokens. + example: https://login.microsoftonline.com/{tenantid}/v2.0 + x-immutable: false + jwks_uri: + type: string + format: uri + description: |- + A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth + identity provider. JWKS provides a set of crypotgraphic keys + used to verify the authenticity and integrity of JSON Web + Tokens (JWTs) issued by the OAuth identity provider. + example: https://login.microsoftonline.com/common/discovery/v2.0/keys + x-immutable: false + keys: + type: array + items: + $ref: '#/components/schemas/iam.v2.JwksObject' + description: |- + The JWKS issued by the OAuth identity provider. Only `kid` (key ID) + and `alg` (algorithm) properties for each key set are included. + readOnly: true + iam.v2.Jwks: + type: object + description: |- + `JWKS` objects represent public key sets for a specific OAuth/OpenID Connect provider within + Confluent Cloud. + + The API allows you to refresh JWKS public key data. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Jwks Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Jwks + spec: + $ref: '#/components/schemas/iam.v2.JwksSpec' + status: + $ref: '#/components/schemas/iam.v2.JwksStatus' + iam.v2.JwksStatus: + description: The status of the Jwks + type: object + properties: + jwks_status: + type: string + x-extensible-enum: + - REFRESHED + - OK + - INVALID_JWKS_URI + - ERROR_FETCHING_JWKS + description: The actual state of the public key data + example: REFRESHED + jwks_last_refresh_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + description: The last successful refresh time for the public key data + readOnly: true + iam.v2.IdentityPool: + type: object + description: |- + `IdentityPool` objects represent groups of identities tied to a given a `IdentityProvider` + that authorizes them to Confluent Cloud resources. + + It provides a mapping functionality of your `Identity Provider` user to a Confluent identity pool that + is then used to provide access to Confluent Resources. + + + Related guide: [Use identity pools with your OAuth provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + ## The Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_provider` | Number of Identity Pools per Identity Provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/iam/v2/identity-pools/ip-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/identity-pool=ip-12345 + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + (see [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) for more details). + This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access + topic A". + example: claims.sub + filter: + type: string + # yamllint disable-line rule:line-length + description: A filter expression in [Supported Common Expression Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) + that specifies which identities can authenticate using your identity pool + (see [Set identity pool filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) + for more details). + maxLength: 300 + example: claims.aud=="confluent" && claims.group!="invalid_group" + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + iam.v2.JwksObject: + type: object + description: '`JWKS` contains the published keys for the given OpenIDProvider' + required: + - kty + - kid + - alg + properties: + kty: + type: string + x-extensible-enum: + - RSA + description: Specifies the cryptographic algorithm family used with the + key + example: RSA + kid: + type: string + description: Specifies the key-id issued by the OpenIDProvider for the particular + tenant + example: nOo3ZDrODXEK1jKWhXslHR_KXEg + alg: + type: string + description: Specifies the algorithm to be used to generate the public key + example: RS256 + use: + type: string + description: Specifies the intended usage of the key + example: sig + n: + type: string + # see https://datatracker.ietf.org/doc/html/rfc7518#page-30 + description: Specifies the modulus of the RSA public key. Represented as + a Base64urlUInt-encoded value + e: + type: string + # see https://datatracker.ietf.org/doc/html/rfc7518#page-30 + description: Specifies the exponent of the RSA public key. + example: AQAB + +# default + iam.v2.IdentityProviderList: + type: object + description: |- + `IdentityProvider` objects represent external OAuth-OIDC providers in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Identity Provider. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Identity Providers Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_providers_per_org` | Number of OAuth identity providers per organization | + | `public_keys_per_provider` | Number of public keys saved per identity provider | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProviderList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/iam/v2/identity-providers + last: + example: https://api.confluent.cloud/iam/v2/identity-providers?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/iam/v2/identity-providers?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/iam/v2/identity-providers?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/iam.v2.IdentityProvider' + - type: object + required: + - id + - metadata + - display_name + - description + - state + - issuer + - jwks_uri + uniqueItems: true + iam.v2.JwksSpec: + type: object + description: The desired state of the Jwks + properties: + jwks_status: + type: string + x-extensible-enum: + - REFRESHED + description: The desired state of the public key data + example: REFRESHED + x-enable-id: false + x-enable-listmeta: true + x-enable-objectmeta: false + iam.v2.IdentityPoolList: + type: object + description: |- + `IdentityPool` objects represent groups of identities tied to a given a `IdentityProvider` + that authorizes them to Confluent Cloud resources. + + It provides a mapping functionality of your `Identity Provider` user to a Confluent identity pool that + is then used to provide access to Confluent Resources. + + + Related guide: [Use identity pools with your OAuth provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + ## The Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_provider` | Number of Identity Pools per Identity Provider | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPoolList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/iam/v2/identity-pools + last: + example: https://api.confluent.cloud/iam/v2/identity-pools?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/iam/v2/identity-pools?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/iam/v2/identity-pools?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/iam.v2.IdentityPool' + - type: object + required: + - id + - metadata + - display_name + - description + - identity_claim + - filter + - principal + - state + uniqueItems: true + sts.v1.TokenExchangeRequest: + type: object + description: token exchange request parameters + properties: + api_version: + type: string + enum: + - sts/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TokenExchangeRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/sts/v1/token-exchange-requests/ter-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/token-exchange-request=ter-12345 + grant_type: + type: string + x-extensible-enum: [urn:ietf:params:oauth:grant-type:token-exchange] + description: | + The grant type. Must be urn:ietf:params:oauth:grant-type:token-exchange, which indicates a token exchange. + example: urn:ietf:params:oauth:grant-type:token-exchange + subject_token: + type: string + description: Confluent Cloud only accepts JSON Web Token (JWT) access tokens + from customer identity provider + example: test_jwt_token + identity_pool_id: + type: string + description: | + Identity pool is a group of external identities that are assigned a certain level of access based on policy + example: pool_1 + subject_token_type: + type: string + x-extensible-enum: [urn:ietf:params:oauth:token-type:jwt] + description: | + An identifier for the type of requested security token. Supported values + is urn:ietf:params:oauth:token-type:jwt. + example: urn:ietf:params:oauth:token-type:jwt + requested_token_type: + type: string + x-extensible-enum: [urn:ietf:params:oauth:token-type:access_token] + description: | + An identifier for the type of requested security token. + Supported values is urn:ietf:params:oauth:token-type:access_token. + example: urn:ietf:params:oauth:token-type:access_token + expires_in: + type: integer + format: int32 + description: | + The amount of time, in seconds, between the time when the access token was issued + and the time when the access token will expire + default: 900 + maximum: 900 + sts.v1.TokenExchangeReply: + type: object + description: token exchange response + required: + - access_token + - issued_token_type + - token_type + - expires_in + properties: + access_token: + type: string + description: | + An JWT access token, issued by Confluent, in response to the token exchange request. + Client application could use the access token to access confluent public api + issued_token_type: + type: string + x-extensible-enum: [urn:ietf:params:oauth:token-type:access_token] + description: The token type. Always matches the value of requested_token_type + from the request. + example: urn:ietf:params:oauth:token-type:access_token + token_type: + type: string + x-extensible-enum: [Bearer] + description: Indicates the token type value. The only type that Confluent + supports is Bearer + example: Bearer + expires_in: + type: integer + format: int32 + description: The length of time, in seconds, that the access token is valid. + example: 3600 + kafka-quotas.v1.ClientQuota: + type: object + description: |- + `ClientQuota` objects represent Client Quotas you can set at the service account level. + + The API allows you to list, create, read, update, and delete your client quotas. + + + Related guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + ## The Client Quotas Model + + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuota + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/kafka-quotas/v1/client-quotas/cq-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/client-quota=cq-12345 + spec: + $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaSpec' + kafka-quotas.v1.Throughput: + description: Quotas on maximum throughput + required: + - ingress_byte_rate + - egress_byte_rate + properties: + ingress_byte_rate: + type: string + format: int64 + example: '5' + description: Ingress throughput limit for principals specified in bytes + per second. + egress_byte_rate: + type: string + format: int64 + example: '5' + description: Egress throughput limit for principals specified in bytes per + second. + +# default + kafka-quotas.v1.ClientQuotaList: + type: object + description: |- + `ClientQuota` objects represent Client Quotas you can set at the service account level. + + The API allows you to list, create, read, update, and delete your client quotas. + + + Related guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + ## The Client Quotas Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuotaList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/kafka-quotas/v1/client-quotas + last: + example: https://api.confluent.cloud/kafka-quotas/v1/client-quotas?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/kafka-quotas/v1/client-quotas?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/kafka-quotas/v1/client-quotas?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/kafka-quotas.v1.ClientQuota' + - type: object + required: + - id + - metadata + - spec + properties: + spec: + type: object + required: + - display_name + - throughput + - cluster + - principals + - environment + uniqueItems: true + kafka-quotas.v1.ClientQuotaSpec: + type: object + description: The desired state of the Client Quota + properties: + display_name: + type: string + description: The name of the client quota. + example: QuotaForSA1 + description: + type: string + example: This quota defines limits on how much the target principals can + use cluster lkc-xxxxx + description: A human readable description for the client quota. + throughput: + type: object + description: Throughput for the client quota. + allOf: + - $ref: '#/components/schemas/kafka-quotas.v1.Throughput' + cluster: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: | + The ID of the Dedicated Kafka cluster where the client quota is applied. + x-immutable: true + principals: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: | + A list of principals to apply a client quota to. + Use `""` to apply a client quota to all service accounts + (see [Control application usage with Client Quotas](https://docs.confluent.io/cloud/current/clusters/client-quotas.html#control-application-usage-with-client-quotas) for more details). + minItems: 1 + environment: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The environment to which this belongs. + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + byok.v1.Key: + type: object + description: |- + `Key` objects represent customer managed keys on dedicated Confluent Cloud clusters. + + Keys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP. + This API allows you to upload and retrieve self-managed keys on Confluent Cloud. + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + ## The Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. | + properties: + api_version: + type: string + enum: + - byok/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Key + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/byok/v1/keys/cck-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/key=cck-12345 + key: + type: object + description: | + The cloud-specific key details. + + For AWS, provide the corresponding `key_arn`. + + For Azure, provide the corresponding `key_id`. + + For GCP, provide the corresponding `key_id`. + discriminator: + propertyName: kind + mapping: + AwsKey: '#/components/schemas/byok.v1.AwsKey' + AzureKey: '#/components/schemas/byok.v1.AzureKey' + GcpKey: '#/components/schemas/byok.v1.GcpKey' + oneOf: + - $ref: '#/components/schemas/byok.v1.AwsKey' + - $ref: '#/components/schemas/byok.v1.AzureKey' + - $ref: '#/components/schemas/byok.v1.GcpKey' + x-immutable: true + display_name: + type: string + description: | + The human-readable name of the key object. + example: Key for billing cluster + x-immutable: false + provider: + type: string + x-extensible-enum: [AWS, Azure, GCP] + description: The cloud provider of the Key. + readOnly: true + example: AWS + state: + type: string + x-extensible-enum: [AVAILABLE, IN_USE] + description: | + The state of the key: + + AVAILABLE: key can be used for a Kafka cluster provisioning. + + IN_USE: key is already in use by a Kafka cluster provisioning. + readOnly: true + example: IN_USE + validation: + description: | + The validation details of the key. + readOnly: true + allOf: + - $ref: '#/components/schemas/byok.v1.KeyValidation' + byok.v1.KeyValidation: + type: object + description: | + The validation details of the key. + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: [INITIALIZING, VALID, INVALID] + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: | + The timestamp since which the key is in the current validation phase. + Changes to the validation message or phase will update this timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: | + The cloud region where the key is deployed. This value is computed by the + API after the key is successfully validated. + example: us-west-2 + readOnly: true + byok.v1.AwsKey: + type: object + description: | + The AWS BYOK details + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: | + The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination. + type: array + items: + type: string + readOnly: true + example: [arn:aws:iam::123456789876:role/block_storage_manager, arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa] + kind: + description: | + BYOK kind type. + type: string + enum: [AwsKey] + x-immutable: true + required: + - key_arn + - kind + byok.v1.AzureKey: + type: object + description: | + The Azure BYOK details. + properties: + application_id: + description: | + The Application ID created for this key-environment combination. + type: string + readOnly: true + key_id: + description: | + The unique Key Object Identifier URL without version of an Azure Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + # yamllint disable-line rule:line-length + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + kind: + description: | + BYOK kind type. + type: string + enum: [AzureKey] + x-immutable: true + tenant_id: + description: | + Tenant ID (uuid) hosting the Key Vault containing the key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + required: + - key_id + - key_vault_id + - kind + - tenant_id + byok.v1.GcpKey: + type: object + description: | + The GCP BYOK details + properties: + key_id: + description: | + The Google Cloud Platform key ID. + type: string + # yamllint disable-line rule:line-length + example: projects/exampleproject/locations/us-central1/keyRings/testkeyring/cryptoKeys/testbyokkey/cryptoKeyVersions/3 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + kind: + description: | + BYOK kind type. + type: string + enum: [GcpKey] + x-immutable: true + required: + - key_id + - kind + +# Default + byok.v1.KeyList: + type: object + description: |- + `Key` objects represent customer managed keys on dedicated Confluent Cloud clusters. + + Keys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP. + This API allows you to upload and retrieve self-managed keys on Confluent Cloud. + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + ## The Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - byok/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KeyList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/byok/v1/keys + last: + example: https://api.confluent.cloud/byok/v1/keys?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/byok/v1/keys?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/byok/v1/keys?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/byok.v1.Key' + - type: object + required: + - id + - metadata + - key + - provider + - state + - validation + uniqueItems: true + billing.v1.Cost: + type: object + description: |- + `Cost` objects represent the aggregated billing costs for an organization + + + Related guide: [Retrieve costs for a range of dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates). + + ## The Costs Model + + properties: + api_version: + type: string + enum: + - billing/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cost + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + start_date: + type: string + format: date + example: '2022-10-12' + description: Start date of time period (inclusive) to retrieve billing costs. + It is represented in RFC3339 format and is in UTC. + end_date: + type: string + format: date + example: '2022-10-15' + description: End date of time period (exclusive) to retrieve billing costs. + It is represented in RFC3339 format and is in UTC. + granularity: + type: string + x-extensible-enum: [DAILY] + default: DAILY + description: Granularity at which each line item is aggregated. + network_access_type: + type: string + x-extensible-enum: [INTERNET, TRANSIT_GATEWAY, PRIVATE_LINK, PEERED_VPC, + PNI, MULTI] + example: INTERNET + description: Network access type for the cluster. + product: + type: string + x-extensible-enum: [KAFKA, CONNECT, KSQL, AUDIT_LOG, STREAM_GOVERNANCE, + CLUSTER_LINK, CUSTOM_CONNECT, FLINK, TABLEFLOW, SUPPORT_CLOUD_BASIC, SUPPORT_CLOUD_DEVELOPER, + SUPPORT_CLOUD_BUSINESS, SUPPORT_CLOUD_PREMIER, USM] + example: KAFKA + description: Product name. + line_type: + type: string + x-extensible-enum: [KAFKA_STORAGE, KAFKA_PARTITION, KAFKA_NETWORK_READ, + KAFKA_NETWORK_WRITE, KAFKA_BASE, KAFKA_NUM_CKUS, KAFKA_REST_PRODUCE, KSQL_NUM_CSUS, + CONNECT_CAPACITY, CONNECT_NUM_TASKS, CONNECT_THROUGHPUT, CONNECT_NUM_RECORDS, + SUPPORT, CLUSTER_LINKING_PER_LINK, CLUSTER_LINKING_WRITE, CLUSTER_LINKING_READ, + AUDIT_LOG_READ, GOVERNANCE_BASE, SCHEMA_REGISTRY, PROMO_CREDIT, CUSTOM_CONNECT_NUM_TASKS, + CUSTOM_CONNECT_THROUGHPUT, NUM_RULES, FLINK_NUM_CFUS, TABLEFLOW_DATA_PROCESSED, + TABLEFLOW_NUM_TOPICS, TABLEFLOW_STORAGE, USM_CONNECTED_NODE, KAFKA_STREAMS] + example: KAFKA_NUM_CKUS + description: Type of the line item. + price: + type: number + format: double + example: 1.50 + description: Price for the line item in dollars. + unit: + type: string + example: GB + description: Unit of the line item. + quantity: + type: number + format: double + example: 99.90 + description: Quantity of the line item. + original_amount: + type: number + format: double + example: 149.85 + description: Original amount accrued for this line item. + discount_amount: + type: number + format: double + example: 20.85 + description: Amount discounted from the original amount in dollars. + amount: + type: number + format: double + example: 129.00 + description: Final amount after deducting discounts. + description: + type: string + example: KAFKA101 + description: Additional details about promotional offers/credits. + tier_dimensions: + type: object + additionalProperties: + type: string + description: Tier dimensions which exist for tiered pricing cost items only. + x-go-type: map[string]string + example: + provider: aws + region: us-east-1 + connector_type: BigQuerySink + resource: + description: The resource for a given object + allOf: + - $ref: '#/components/schemas/billing.v1.Resource' + billing.v1.Resource: + type: object + description: | + The resource associated with this object. The resource can be one of Kafka Cluster ID (example: lkc-12345), + Connector ID (example: + lcc-12345), Schema Registry Cluster ID (example: lsrc-12345), or ksqlDB Cluster ID + (example: lksqlc-12345). + May be null or omitted if not associated with a resource. + properties: + id: + type: string + description: ID of the resource. + example: lkc-12345 + display_name: + type: string + description: Display name of the resource. + example: prod-kafka-cluster + environment: + description: The environment associated with this resource + nullable: true + allOf: + - $ref: '#/components/schemas/billing.v1.Environment' + billing.v1.Environment: + type: object + description: | + The details of the environment for a given resource. + properties: + id: + type: string + description: ID of the environment. + example: env-123 + +# Default + billing.v1.CostList: + type: object + description: |- + `Cost` objects represent the aggregated billing costs for an organization + + + Related guide: [Retrieve costs for a range of dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates). + + ## The Costs Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - billing/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CostList + metadata: + allOf: + - $ref: '#/components/schemas/CostListMeta' + - properties: + next: + example: https://api.confluent.cloud/billing/v1/costs?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/billing.v1.Cost' + - type: object + required: + - id + - start_date + - end_date + - unit + - original_amount + uniqueItems: true + CostListMeta: + type: object + description: CostListMeta describes metadata that resource collections may have + properties: + next: + description: A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + iam.v2.sso.GroupMapping: + type: object + description: |- + `GroupMapping` objects establish relationships between user groups in your SSO + identity provider and specific RBAC roles in Confluent Cloud. + + Group mappings enable automated and secure access control to Confluent Cloud resources, + reducing administrative workload by streamlining user provisioning and authorization. + + + Related guide: [Use group mappings with your SSO identity provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + ## The Group Mappings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `group_mappings_per_org` | Number of group mappings per organization | + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMapping + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/iam.v2/sso/group-mappings/gm-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/group-mapping=gm-12345 + display_name: + type: string + description: The name of the group mapping. + example: Application Developers + description: + type: string + description: A description explaining the purpose and use of the group mapping. + example: Admin access to production environment for Engineering + filter: + type: string + # yamllint disable-line rule:line-length + description: A single group identifier or a condition based on [supported + CEL operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) + that defines which groups are included. + maxLength: 300 + example: '"kafka" in groups && "all" in groups || "everyone" in groups' + principal: + type: string + description: The unique federated identity associated with this group mapping. + example: group-a1b2 + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the group mapping. + example: ENABLED + readOnly: true + iam.v2.sso.GroupMappingList: + type: object + description: |- + `GroupMapping` objects establish relationships between user groups in your SSO + identity provider and specific RBAC roles in Confluent Cloud. + + Group mappings enable automated and secure access control to Confluent Cloud resources, + reducing administrative workload by streamlining user provisioning and authorization. + + + Related guide: [Use group mappings with your SSO identity provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + ## The Group Mappings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `group_mappings_per_org` | Number of group mappings per organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMappingList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/iam.v2/sso/group-mappings + last: + example: https://api.confluent.cloud/iam.v2/sso/group-mappings?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/iam.v2/sso/group-mappings?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/iam.v2/sso/group-mappings?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/iam.v2.sso.GroupMapping' + - type: object + required: + - id + - metadata + - display_name + - description + - filter + - principal + - state + uniqueItems: true + fcpm.v2.ComputePool: + type: object + description: |- + A Compute Pool represents a set of compute resources that is used to run your Queries. + The resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it. + Note that the Compute Pool API supports a limited pagination API, only the `next` field will be populated. + + + ## The Compute Pools Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/fcpm/v2/compute-pools/lfcp-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/flink-region=aws.us-east-2/compute-pool=lfcp-12345 + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + fcpm.v2.ComputePoolStatus: + type: object + required: + - phase + - current_cfu + description: The status of the Compute Pool + properties: + phase: + type: string + x-extensible-enum: [PROVISIONING, PROVISIONED, FAILED, DEPROVISIONING] + description: Status of the Flink compute pool. + example: PROVISIONING + readOnly: true + current_cfu: + type: integer + format: int32 + example: 4 + description: The number of Confluent Flink Units (CFUs) currently allocated + to this Flink compute pool. + readOnly: true + readOnly: true + fcpm.v2.Region: + type: object + description: |- + `Region` objects represent cloud provider regions available when placing Flink compute pools. + The API allows you to list Flink regions. + + + ## The Regions Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/fcpm/v2/regions/r-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/region=r-12345 + display_name: + type: string + description: The display name. + example: Ohio (us-east-2) + x-immutable: true + readOnly: true + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: [AWS, GCP, AZURE] + example: AWS + x-immutable: true + readOnly: true + region_name: + type: string + description: The region name. + example: us-east-2 + x-immutable: true + readOnly: true + http_endpoint: + type: string + description: The regional API endpoint for Flink compute pools. + format: uri + x-immutable: true + readOnly: true + private_http_endpoint: + type: string + description: The private regional API endpoint for Flink compute pools. + format: uri + x-immutable: true + readOnly: true + fcpm.v2.OrgComputePoolConfig: + type: object + description: |- + `OrgComputePoolConfig` manages compute pool configuration settings for an organization. + The API allows you to read and update organization-wide settings such as whether default pools are enabled + and their maximum CFU limits. + + + ## The Org Compute Pool Configs Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OrgComputePoolConfig + organization_id: + type: string + description: The ID of the organization. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + x-immutable: true + readOnly: true + spec: + type: object + description: The desired state of the organization-level Compute Pool configuration + properties: + default_pool_enabled: + type: boolean + default: true + description: | + Whether default compute pools are enabled for the organization. + When enabled, environments can have default compute pools created automatically. + x-immutable: false + default_pool_max_cfu: + type: integer + format: int32 + example: 20 + description: | + Maximum number of Confluent Flink Units (CFUs) that default compute pools + in this organization should auto-scale to. + x-extensible-enum: [5, 10, 20, 30, 40, 50] + x-immutable: false + x-immutable: false + fcpm.v2.ComputePoolList: + type: object + description: |- + A Compute Pool represents a set of compute resources that is used to run your Queries. + The resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it. + Note that the Compute Pool API supports a limited pagination API, only the `next` field will be populated. + + + ## The Compute Pools Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePoolList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/fcpm/v2/compute-pools + last: + example: https://api.confluent.cloud/fcpm/v2/compute-pools?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/fcpm/v2/compute-pools?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/fcpm/v2/compute-pools?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/fcpm.v2.ComputePool' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - display_name + - cloud + - region + - max_cfu + - environment + uniqueItems: true + fcpm.v2.ComputePoolSpec: + type: object + description: The desired state of the Compute Pool + properties: + display_name: + type: string + example: flink_compute_pool_0 + description: The name of the Flink compute pool. + pattern: ^(?:[0-9A-Za-z\-])[\w\.-]{0,63}$ + x-immutable: false + cloud: + type: string + description: The cloud service provider that runs the compute pool. + x-extensible-enum: [AWS, GCP, AZURE] + example: AWS + x-immutable: true + region: + type: string + example: us-west-1 + description: Flink compute pools in the region provided will be able to + use this identity pool + x-immutable: true + max_cfu: + type: integer + format: int32 + example: 5 + description: | + Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to. + x-extensible-enum: [5, 10, 20, 30, 40, 50] + x-immutable: false + enable_ai: + type: boolean + default: false + description: | + The flag to enable AI computing using Ray for the Flink compute pool. It's available in the Early Access API + lifecycle stage only. + x-immutable: true + default_pool: + type: boolean + default: false + description: | + The flag to indicate whether the Flink compute pool is a default compute pool or not. + Only one default compute pool per environment and region is allowed. + x-immutable: false + environment: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The environment to which this belongs. + network: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The network to which this belongs. + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + fcpm.v2.RegionList: + type: object + description: |- + `Region` objects represent cloud provider regions available when placing Flink compute pools. + The API allows you to list Flink regions. + + + ## The Regions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RegionList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/fcpm/v2/regions + last: + example: https://api.confluent.cloud/fcpm/v2/regions?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/fcpm/v2/regions?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/fcpm/v2/regions?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/fcpm.v2.Region' + - type: object + required: + - id + - metadata + - display_name + - cloud + - region_name + - http_endpoint + uniqueItems: true + sql.v1.MaterializedTable: + type: object + description: Represents a Materialized Table resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - MaterializedTable + readOnly: true + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - type: object + properties: + self: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/databases/lkc-123/materialized-tables/high-value-orders + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + resource_name: + example: '' + labels: + type: object + additionalProperties: + type: string + name: + type: string + description: The user-provided name of the resource, unique within this + environment. + pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$ + maxLength: 100 + example: high-value-orders + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.MaterializedTableSpec' + status: + readOnly: true + allOf: + - $ref: '#/components/schemas/sql.v1.MaterializedTableStatus' + + sql.v1.MaterializedTableList: + type: object + description: A list of Materialized Table resources. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + readOnly: true + kind: + type: string + enum: + - MaterializedTableList + readOnly: true + metadata: + $ref: '#/components/schemas/ListMeta' + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTable' + uniqueItems: true + + sql.v1.MaterializedTableSpec: + type: object + description: The specifications of the Materialized Table. + properties: + kafka_cluster_id: + type: string + description: |- + The ID of the Kafka cluster hosting the Materialized Table's topic. + This value must match the `kafka_cluster_id` path parameter. + It is immutable after creation and is ignored or rejected on update if changed. + example: lkc-12345 + x-immutable: true + compute_pool_id: + type: string + description: |- + The id associated with the compute pool in context. + If not specified, the materialized table will use the default compute pool. The default pool is automatically determined by the system. + example: lfcp-123 + principal: + type: string + description: The id of a principal this Materialized Table query runs as. + example: sa-abc123 + maxLength: 255 + stopped: + type: boolean + description: Indicates whether the Materialized Table query should be stopped. + example: false + table_options: + type: object + description: Defines configuration properties for the table, equivalent + to the SQL 'WITH' clause + additionalProperties: + type: string + maxProperties: 8192 + session_options: + type: object + description: Session configurations equivalent to the SQL 'SET' statement. + Only applicable on creation; ignored on update. + additionalProperties: + type: string + maxProperties: 8192 + x-immutable: true + columns: + type: array + description: Details of each column in Materialized Table resource. If columns + are not specified, we infer from query. If it's specified it must be compatible + with the types in the query. + items: + $ref: '#/components/schemas/sql.v1.ColumnDetails' + watermark: + $ref: '#/components/schemas/sql.v1.Watermark' + constraints: + type: array + description: Specify table constraints. + items: + $ref: '#/components/schemas/sql.v1.Constraint' + distribution: + description: Only applicable on creation; ignored on update. + x-immutable: true + allOf: + - $ref: '#/components/schemas/sql.v1.Distribution' + query: + type: string + description: Contains the query section (usually starting with a SELECT) + of the latest Materialized Table. + example: SELECT user_id, product_id, price, quantity FROM orders WHERE price + > 1000; + maxLength: 131072 + + sql.v1.MaterializedTableStatus: + type: object + description: The status of the Materialized Table. + properties: + phase: + type: string + x-extensible-enum: [PENDING, RUNNING, COMPLETED, DELETING, FAILING, FAILED, + CREATING, ALTERING, DEGRADED, STOPPING, STOPPED] + description: The lifecycle phase of the materialized table. + example: RUNNING + detail: + type: string + description: Optional. Human-readable description of phase. + example: Materialized table is running. + warnings: + type: array + description: List of warnings encountered during materialized table execution. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTableWarning' + creation_statement: + type: string + description: Entire Materialized Table statement as submitted by user e.g + CREATE OR ALTER MATERIALIZED TABLE ... + example: CREATE OR ALTER MATERIALIZED TABLE high-value-orders AS SELECT + user_id, product_id, price, quantity FROM orders WHERE price > 1000; + scaling_status: + $ref: '#/components/schemas/sql.v1.ScalingStatus' + version: + type: integer + format: int32 + minimum: 1 + description: Represents the evolution history of the Materialized Table. + The current value indicates the latest version. + example: 3 + latest_version: + type: integer + format: int32 + minimum: 1 + description: Represents the latest submitted version of the Materialized + Table. When a query evolution is accepted, `latest_version` is incremented + immediately and will be greater than `version` until the new query is + fully activated. + example: 4 + + sql.v1.MaterializedTableVersion: + type: object + description: Represents a specific version of a Materialized Table resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - MaterializedTableVersion + readOnly: true + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - type: object + properties: + self: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/organizations/org-123/environments/env-123/databases/lkc-123/materialized-tables/high-value-orders/versions/4 + name: + type: string + description: | + The resource version name, unique within the Kafka cluster. + Name conforms to DNS Subdomain (RFC 1123). + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + maxLength: 100 + example: mt-123-v4 + readOnly: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.MaterializedTableVersionSpec' + + sql.v1.MaterializedTableVersionList: + type: object + description: A list of Materialized Table Version resources. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + readOnly: true + kind: + type: string + enum: + - MaterializedTableVersionList + readOnly: true + metadata: + $ref: '#/components/schemas/ListMeta' + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTableVersion' + uniqueItems: true + + sql.v1.MaterializedTableVersionSpec: + type: object + description: The specifications of the Materialized Table Version. + required: + - version + - statement + properties: + version: + type: integer + format: int32 + minimum: 1 + description: The version number of the Materialized Table. + example: 4 + readOnly: true + statement: + type: string + description: | + The full SQL statement for the materialized table as generated by SHOW CREATE MATERIALIZED TABLE at the time of the evolution. + example: CREATE OR ALTER MATERIALIZED TABLE orders AS SELECT user_id, product_id, + price FROM orders; + readOnly: true + maxLength: 131072 + changes: + type: array + description: Changes affecting resources since the previous version. + items: + $ref: '#/components/schemas/sql.v1.ResourceChange' + readOnly: true + + sql.v1.ResourceChange: + type: object + description: Details of a change to a specific resource. + required: + - kind + - environment_locator + - database_locator + - name + - details + properties: + kind: + type: string + x-extensible-enum: [MATERIALIZED_TABLE, TABLE, VIEW, FUNCTION] + description: The type of resource that was changed. + example: MATERIALIZED_TABLE + environment_locator: + type: string + description: The environment containing the resource. Can be either the + environment name or ID, depending on how it is referenced in the SQL statement + text. + example: env-abc + database_locator: + type: string + description: The database containing the resource. Can be either the database + name or ID, depending on how it is referenced in the SQL statement text. + example: lkc-123 + name: + type: string + description: The name of the resource, unique within its scope (environment + and database). + example: orders + details: + type: array + description: Human-readable descriptions of the changes made to this resource. + items: + type: string + example: ["Column 'product_name: VARCHAR' added", "Column 'product_id: BIGINT'\ + \ added"] + readOnly: true + + sql.v1.ColumnDetails: + type: object + description: Details of a column in the Materialized Table. + discriminator: + propertyName: kind + mapping: + Physical: '#/components/schemas/sql.v1.PhysicalColumn' + Metadata: '#/components/schemas/sql.v1.MetadataColumn' + Computed: '#/components/schemas/sql.v1.ComputedColumn' + oneOf: + - $ref: '#/components/schemas/sql.v1.PhysicalColumn' + - $ref: '#/components/schemas/sql.v1.MetadataColumn' + - $ref: '#/components/schemas/sql.v1.ComputedColumn' + + sql.v1.ColumnCommon: + type: object + required: + - name + - type + properties: + name: + type: string + description: The name of the column. + type: + $ref: '#/components/schemas/DataType' + comment: + type: string + description: A comment or description for the column. + + sql.v1.PhysicalColumn: + description: Physical columns define the structure of the table and the data + types of its fields. + allOf: + - $ref: '#/components/schemas/sql.v1.ColumnCommon' + - type: object + required: + - kind + properties: + name: + example: user_id + type: + example: + type: BIGINT + nullable: false + kind: + type: string + description: The kind of column. + enum: [Physical] + example: Physical + + sql.v1.MetadataColumn: + description: Metadata columns reference system properties. + allOf: + - $ref: '#/components/schemas/sql.v1.ColumnCommon' + - type: object + required: + - kind + - metadata_key + properties: + name: + example: table_offset + type: + example: + type: BIGINT + nullable: false + kind: + type: string + description: The kind of column. + enum: [Metadata] + example: Metadata + metadata_key: + type: string + description: The system metadata key to reference. + example: offset + virtual: + type: boolean + description: Indicates if the metadata column is virtual. + default: false + example: true + + sql.v1.ComputedColumn: + description: Computed columns are generated via an expression. + allOf: + - $ref: '#/components/schemas/sql.v1.ColumnCommon' + - type: object + required: + - kind + - expression + properties: + name: + example: total_price + type: + example: + type: DECIMAL + nullable: false + precision: 10 + scale: 2 + kind: + type: string + description: The kind of column. + enum: [Computed] + example: Computed + expression: + type: string + description: The SQL expression used to compute the column value. + example: quantity * price + virtual: + type: boolean + description: Indicates if the computed column is virtual. + default: false + example: true + + sql.v1.Watermark: + type: object + description: Watermark strategy for the Materialized Table resource. + properties: + column: + type: string + example: event_timestamp + expression: + type: string + example: event_timestamp - INTERVAL '5' SECOND + + sql.v1.Constraint: + type: object + description: A constraint on the materialized table. + properties: + name: + type: string + example: pk_orders + type: + type: string + x-extensible-enum: [PRIMARY_KEY] + description: The type of constraint. + example: PRIMARY_KEY + columns: + type: array + items: + type: string + example: [user_id, product_id] + enforced: + type: boolean + description: Whether the constraint is enforced. + default: false + + sql.v1.Distribution: + type: object + description: Distribution (bucket by) strategy. + properties: + kind: + type: string + x-extensible-enum: [HASH] + description: The kind of distribution. + example: HASH + keys: + type: array + items: + type: string + example: [user_id] + bucket_count: + type: integer + format: int32 + minimum: 1 + default: 6 + description: The number of buckets. + example: 12 + sql.v1.MaterializedTableWarning: + type: object + description: Represents a non-fatal issue encountered during materialized table + processing. + allOf: + - $ref: '#/components/schemas/sql.v1.StatementWarning' + + sql.v1.Connection: + type: object + description: |- + `Connection` models a reusable endpoint and auth token to authenticate the caller to + use that endpoint. + Only `OrganizationAdmins` and `EnvironmentAdmins` will have the permissions to create, update and delete `Connections`. + `FlinkDevelopers` and `ModelResourceOwners` can later reference a `Connection` resource within their Model + creation statements. + The API allows you to list, create, read, and delete your connections. + ## The Connections Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Connection + readOnly: true + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/organizations/org-abc/environments/env-123/connections/my-openai-connection + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + resource_name: + example: '' + name: + type: string + example: my-openai-connection + description: The user provided name of the resource, unique within this + environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ConnectionSpec' + status: + $ref: '#/components/schemas/sql.v1.ConnectionStatus' + + sql.v1.ConnectionList: + type: object + description: |- + `Connection` models a reusable endpoint and auth token to authenticate the caller to + use that endpoint. + Only `OrgAdmins` and `EnvAdmins` will have the permissions to create, update and delete `Connections`. + `FlinkDevelopers` and `ModelResourceOwners` can later reference a `Connection` resource within their Model + creation statements. + The API allows you to list, create, read, and delete your connections. + ## The Connection Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - ConnectionList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + self: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/connections + first: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/connections + last: + example: '' + prev: + example: '' + next: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/connections?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/sql.v1.Connection' + - type: object + required: + - api_version + - kind + - metadata + - spec + - status + - name + - organization_id + - environment_id + properties: + spec: + type: object + required: + - connection_type + - endpoint + uniqueItems: true + + sql.v1.ConnectionStatus: + type: object + required: + - phase + description: The status of the Connection + properties: + phase: + type: string + x-extensible-enum: [ACTIVE, UNREACHABLE, INVALID_AUTH] + description: | + Describes the status of the connection: + + READY: The Connection is usable; + + UNREACHABLE: The Connection endpoint is unreachable; + + INVALID_AUTH: The Connection auth token is invalid; + example: READY + readOnly: true + detail: + type: string + description: Details about why connection transitioned into a given status. + example: 'Lookup failed: ai.openai.com' + readOnly: true + readOnly: true + + sql.v1.PlaintextProvider: + type: object + description: | + Describes a sensitive piece of information passed in plaintext. + + Confluent only accepts authentication tokens of supported model providers from OrgAdmins and EnvAdmins. + For now, only 'PlainText' provider is supported. It stores authentication token details as opaque bytes in an encrypted form. + This option offers limited security as it only provides a single level of encryption. + properties: + kind: + description: | + Plaintext Provider Kind Type + type: string + enum: [PlaintextProvider] + x-immutable: true + data: + description: | + Authentication token in plaintext JSON string. + For composite tokens, provide them as JSON. + This is sensitive piece of information stored as opaque bytes in an encrypted form with single level of encryption. + + Scoped to an endpoint of a `Connection` resource. + type: string + format: byte + + sql.v1.ConnectionSpec: + type: object + description: Encapsulates the model provider access details + properties: + connection_type: + type: string + example: OPENAI + description: The type of this connection. + x-immutable: true + x-extensible-enum: [AZUREML, AZUREOPENAI, A2A, ANTHROPIC, BEDROCK, CONFLUENT_JDBC, + COSMOSDB, COUCHBASE, ELASTIC, FIREWORKSAI, GOOGLEAI, MCP_SERVER, MONGODB, + OPENAI, PINECONE, REST, S3VECTORS, SAGEMAKER, VERTEXAI] + endpoint: + type: string + example: https://api.openai.com/v1/chat/completions + description: The endpoint that is used to run model inferencing. + maxLength: 16384 + x-immutable: true + auth_data: + type: object + description: | + The vendor specific authentication token details + + The contents are stored as opaque bytes given in plaintext by an EnvAdmin. + In future, we would support more secure methods for distributing authentication tokens. + discriminator: + propertyName: kind + mapping: + PlaintextProvider: '#/components/schemas/sql.v1.PlaintextProvider' + oneOf: + - $ref: '#/components/schemas/sql.v1.PlaintextProvider' + x-immutable: false + x-enable-listmeta: true + x-enable-objectmeta: true + + + sql.v1.Agent: + type: object + description: Represents an Agent resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Agent + readOnly: true + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - type: object + properties: + self: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/databases/lkc-123/agents/chat-listener-agent + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + resource_name: + example: '' + labels: + type: object + additionalProperties: + type: string + name: + type: string + description: The user-provided name of the agent, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + maxLength: 100 + example: chat-listener-agent + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.AgentSpec' + status: + readOnly: true + allOf: + - $ref: '#/components/schemas/sql.v1.AgentStatus' + + sql.v1.AgentList: + type: object + description: A list of Agent resources. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + readOnly: true + kind: + type: string + enum: + - AgentList + readOnly: true + metadata: + $ref: '#/components/schemas/ListMeta' + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + $ref: '#/components/schemas/sql.v1.Agent' + uniqueItems: true + + sql.v1.AgentSpec: + type: object + description: The specifications of the Agent. + properties: + description: + type: string + example: An agent that listens to chat messages and creates issues + description: The description of the agent. + model: + type: string + example: chat_listener + description: The name of the model the agent uses for inferencing. + prompt: + type: string + example: Create an issue from the content using bebb0fa3-e084-412d-a000-b02280558318 + as the team ID + description: The instruction prompt that guides the agent's behavior. + maxLength: 65536 + tools: + type: array + description: The list of tools available to the agent. + items: + type: string + example: + - linear-mcp-tool + properties: + type: object + description: A set of key-value option pairs that configure the agent's + behavior. + additionalProperties: + type: string + example: + max_iterations: '5' + + sql.v1.AgentStatus: + type: object + description: The status of the Agent. + properties: + phase: + type: string + x-extensible-enum: [READY, RUNNING] + description: | + Describes the status of the agent: + + READY: The Agent is created; + + RUNNING: The Agent is created and running in a query; + example: RUNNING + + sql.v1.ToolList: + type: object + description: |- + `Tool` models a reusable tool resource backed by a connection that can be referenced + by agents to perform actions. + The API allows you to create your tools. + ## The Tool Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - ToolList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + self: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/organizations/org-abc/environments/env-123/databases/my-database/tools + first: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/organizations/org-abc/environments/env-123/databases/my-database/tools + last: + example: '' + prev: + example: '' + next: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/organizations/org-abc/environments/env-123/databases/my-database/tools?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/sql.v1.Tool' + - type: object + required: + - api_version + - kind + - metadata + - name + - spec + - status + - organization_id + - environment_id + uniqueItems: true + + sql.v1.Tool: + type: object + description: |- + `Tool` models a reusable tool resource backed by a connection that can be referenced + by agents to perform actions. + The API allows you to create your tools. + ## The Tools Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Tool + readOnly: true + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/organizations/org-abc/environments/env-123/tools/linear-mcp-tool + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + resource_name: + example: '' + name: + type: string + example: linear-mcp-tool + description: The user provided name of the tool, unique within this environment. + pattern: '[a-z0-9_]([-a-z0-9_]*[a-z0-9_])?' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ToolSpec' + status: + $ref: '#/components/schemas/sql.v1.ToolStatus' + + sql.v1.ToolSpec: + type: object + description: |- + The spec of the Tool. A tool must reference either a `connection` (for MCP or A2A tools) + or a `function` (for function-based tools), but not both. + properties: + connection: + type: string + example: linear-mcp-connection-streamable + description: The name of the connection this tool uses. Required for MCP + and A2A tools. Mutually exclusive with function. + function: + type: string + example: convert_to_celsius + description: The name of the function this tool wraps. Required for function-based + tools. Mutually exclusive with connection. + comment: + type: string + description: An optional comment describing the tool. + maxLength: 4096 + options: + type: object + description: |- + A set of key-value option pairs that configure the tool's behavior. + Supported options vary by tool type: + - MCP tools: type, allowed_tools, request_timeout, max_retries, headers + - A2A tools: type, agent_card_path, request_timeout, max_retries + - Function tools: type, description + additionalProperties: + type: string + example: + type: mcp + allowed_tools: create_issue, list_issues + request_timeout: '30' + x-enable-listmeta: true + x-enable-objectmeta: true + + sql.v1.ToolStatus: + type: object + required: + - phase + description: The status of the Tool + properties: + phase: + type: string + x-extensible-enum: [ACTIVE, INACTIVE, ERROR] + description: | + Describes the status of the tool: + + ACTIVE: The Tool is usable; + + INACTIVE: The Tool is not currently active; + + ERROR: The Tool encountered an error; + example: ACTIVE + readOnly: true + detail: + type: string + description: Details about why the tool transitioned into a given status. + example: Tool is ready + readOnly: true + readOnly: true + + sql.v1.Statement: + type: object + description: |- + `Statement` represents a core resource used to model SQL statements for execution. + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session + management or any higher-level functionality. + The API allows you to list, create, read, and delete your statements. + ## The Statements Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Statement + readOnly: true + metadata: + allOf: + - $ref: '#/components/schemas/StatementObjectMeta' + - properties: + self: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + resource_name: + example: '' + labels: + type: object + additionalProperties: + type: string + name: + type: string + example: sql123 + description: The user provided name of the resource, unique within this + environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + spec: + $ref: '#/components/schemas/sql.v1.StatementSpec' + status: + $ref: '#/components/schemas/sql.v1.StatementStatus' + result: + $ref: '#/components/schemas/sql.v1.StatementResult' + + sql.v1.StatementStatus: + type: object + required: + - phase + description: The status of the Statement + properties: + phase: + type: string + x-extensible-enum: [PENDING, RUNNING, COMPLETED, DELETING, FAILING, FAILED, + STOPPING, STOPPED, DEGRADED] + description: | + The lifecycle phase of the submitted SQL statement: + + PENDING: SQL statement is pending execution; + + RUNNING: SQL statement execution is in progress; + + COMPLETED: SQL statement is completed; + + DELETING: SQL statement deletion is in progress; + + FAILING: SQL statement is failing; + + FAILED: SQL statement execution has failed; + + STOPPING: SQL statement is being stopped; + + STOPPED: SQL statement execution has successfully been stopped; + + DEGRADED: SQL statement is experiencing reduced performance or partial failure; + example: RUNNING + readOnly: true + scaling_status: + $ref: '#/components/schemas/sql.v1.ScalingStatus' + state_limit_status: + $ref: '#/components/schemas/sql.v1.StateLimitStatus' + detail: + type: string + description: Details about the execution status of this statement. + example: Statement is running successfully + readOnly: true + warnings: + type: array + description: List of warnings encountered during statement execution. + items: + $ref: '#/components/schemas/sql.v1.StatementWarning' + readOnly: true + traits: + $ref: '#/components/schemas/sql.v1.StatementTraits' + network_kind: + type: string + x-extensible-enum: [PUBLIC, PRIVATE] + description: | + The networking type used by the submitted SQL statement: + + PUBLIC: SQL statement is using public networking; + + PRIVATE: SQL statement is using private networking; + example: PUBLIC + readOnly: true + latest_offsets: + type: object + additionalProperties: + type: string + description: | + The last Kafka offsets that a statement has processed. Represented by a mapping from Kafka topic to a + string representation of partitions mapped to offsets. + example: + topic-1: partition:0,offset:100;partition:1,offset:200 + topic-2: partition:0,offset:50 + readOnly: true + latest_offsets_timestamp: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: The date and time at which the Kafka topic offsets were added + to the statement status. It is represented in RFC3339 format and is in + UTC. + readOnly: true + end_time: + type: string + format: date-time + example: '2025-03-19T01:02:03-04:05' + description: | + The date and time in UTC (represented as RFC3339 format) at which the statement reached its final terminal state. + This field is set when the Phase is COMPLETED, FAILED, or STOPPED. + + Note - The attribute is in a [Early Access lifecycle](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + duration: + type: string + format: duration + example: PT2H30M + description: | + The total elapsed time (represented as ISO 8601 format) from when the statement transitioned from + PENDING to RUNNING until it reached a final terminal state. This field is calculated and set when + the Phase is COMPLETED, FAILED, or STOPPED. + + Note - The attribute is in a [Early Access lifecycle](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + affected_resource: + type: object + description: | + A reference to the resource created by this statement, if any. This field is set when a statement + (e.g., CREATE MATERIALIZED TABLE) results in a new user-facing resource. + + Note - The attribute is in a [Early Access lifecycle](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + required: + - kind + - environment_id + - resource_name + properties: + kind: + type: string + x-extensible-enum: [MATERIALIZED_TABLE] + description: The kind of resource that was created. + example: MATERIALIZED_TABLE + environment_id: + type: string + description: The unique identifier for the environment containing the + resource. + example: env-abc + database_id: + type: string + description: | + The unique identifier for the database containing the resource. + Only present for resource kinds that are scoped to a database. + example: lkc-123 + resource_name: + type: string + description: The name of the created resource, unique within its scope. + example: my-materialized-table + readOnly: true + sql.v1.StatementTraits: + type: object + description: StatementTraits contains detailed information about the properties + of a Statement + properties: + sql_kind: + type: string + description: Categorizes the SQL statement. The result is Confluent-specific + but inspired by SQL. It uses underscores for separating concepts e.g. + "CREATE_TABLE". + example: SELECT + is_bounded: + type: boolean + description: Indicates the special case where results of a statement are + bounded. + is_append_only: + type: boolean + description: Indicates the special case where results of a statement are + insert/append only. + upsert_columns: + type: array + description: Defines the column indices clients can use as upsert keys. + items: + type: integer + schema: + $ref: '#/components/schemas/sql.v1.ResultSchema' + connection_refs: + type: array + description: The names of connections that the SQL statement references + (e.g., in FROM clauses). + items: + type: string + example: [my-postgres-connection, my-kafka-connection] + readOnly: true + + sql.v1.StatementList: + type: object + description: |- + `Statement` represents a core resource used to model SQL statements for execution. + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session + management or any higher-level functionality. + The API allows you to list, create, read, and delete your statements. + ## The Statements Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + self: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements + first: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements + last: + example: '' + prev: + example: '' + next: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/sql.v1.Statement' + - type: object + required: + - api_version + - kind + - metadata + - spec + - status + - name + - organization_id + - environment_id + properties: + spec: + type: object + required: + - statement + uniqueItems: true + + sql.v1.StatementResult: + type: object + description: |- + `Statement Result` represents a resource used to model results of SQL statements. + The API allows you to read your SQL statement result. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementResult + metadata: + allOf: + - $ref: '#/components/schemas/ResultListMeta' + results: + allOf: + - $ref: '#/components/schemas/sql.v1.StatementResultResults' + + sql.v1.StatementResultResults: + type: object + description: A results property that contains a data property that contains + an array of results. + properties: + data: + type: array + description: | + A data property that contains an array of results. Each entry in the array is a separate result. + + The value of `op` attribute (if present) represents the kind of change that a row can describe in a changelog: + + `0`: represents `INSERT` (`+I`), i.e. insertion operation; + + `1`: represents `UPDATE_BEFORE` (`-U`), i.e. update operation with the previous content of the updated row. + This kind should occur together with `UPDATE_AFTER` for modelling an update that needs to retract + the previous row first. It is useful in cases of a non-idempotent update, i.e., an update of a row that is not + uniquely identifiable by a key; + + `2`: represents `UPDATE_AFTER` (`+U`), i.e. update operation with new content of the updated row; + This kind CAN occur together with `UPDATE_BEFORE` for modelling an update that + needs to retract the previous row first or it describes an idempotent update, i.e., an + update of a row that is uniquely identifiable by a key; + + `3`: represents `DELETE` (`-D`), i.e. deletion operation; + + Defaults to `0`. + + items: {} + example: [{op: 0, row: ['101', Jay, [null, abc], [null, '456'], 1990-01-12 + 12:00.12, [[null, Alice], ['42', Bob]]]}] + sql.v1.StatementSpec: + type: object + description: The specs of the Statement + properties: + statement: + type: string + example: SELECT * FROM TABLE WHERE VALUE1 = VALUE2; + description: The raw SQL text statement. + x-immutable: true + maxLength: 131072 # 128KB * 1024bytes, assuming 1 char = 1 byte + properties: + type: object + example: + sql.current-catalog: my_environment + sql.current-database: my_kafka_cluster + description: A map (key-value pairs) of statement properties. + additionalProperties: + type: string + maxProperties: 8192 + compute_pool_id: + type: string + example: fcp-00000 + description: |- + The id associated with the compute pool in context. + If not specified, the statement will use the default compute pool. The default pool is automatically determined by the system. + maxLength: 255 + principal: + type: string + example: sa-abc123 + description: The id of a principal this statement runs as. + maxLength: 255 + x-immutable: true + stopped: + type: boolean + description: Indicates whether the statement should be stopped. + example: false + execution_mode: + type: string + example: streaming + description: | + The execution mode of the statement. + + Note - The attribute is in a [Early Access lifecycle](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + maxLength: 255 + readOnly: true + x-enable-listmeta: true + x-enable-objectmeta: true + + StatementObjectMeta: + description: The metadata of the statement. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object + can be addressed. This URL encodes the service location, API version, + and other particulars necessary to locate the resource at a point in time + type: string + format: uri + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: The date and time at which this object was created. It is represented + in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: The date and time at which this object was last updated. It + is represented in RFC3339 format and is in UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: A system generated globally unique identifier for this resource. + resource_version: + type: string + example: a23av + description: A system generated string that uniquely identifies the version + of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + readOnly: true + + ResultListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object + can be addressed. This URL encodes the service location, API version, + and other particulars necessary to locate the resource at a point in time + type: string + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements + next: + description: A URL that can be followed to get the next batch of results. + type: string + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented + in RFC3339 format and is in UTC. + + sql.v1.ScalingStatus: + description: Scaling status for this statement. + type: object + properties: + scaling_state: + description: | + OK: The statement runs at the right scale. + + PENDING_SCALE_DOWN: The statement requires less resources, and will be scaled down in the near future. + + PENDING_SCALE_UP: The statement requires more resources, and will be scaled up in the near future. + + POOL_EXHAUSTED: The statement requires more resources, but not enough resources are available. + example: OK + readOnly: true + type: string + x-extensible-enum: + - OK + - PENDING_SCALE_DOWN + - PENDING_SCALE_UP + - POOL_EXHAUSTED + last_updated: + description: The last time the scaling status was updated. + example: 1996-03-19T01:02:03-04:05 + format: date-time + readOnly: true + type: string + readOnly: true + + sql.v1.StateLimitStatus: + description: State limit status for this statement. + properties: + state_limit_state: + description: | + OK: The statement is within state limits. + + APPROACHING_SOFT_LIMIT: The statement is approaching soft state limits. + + EXCEEDING_SOFT_LIMIT: The statement is exceeding soft state limits. + + APPROACHING_HARD_LIMIT: The statement is approaching hard state limits. + + EXCEEDING_HARD_LIMIT: The statement is exceeding hard state limits. + example: OK + readOnly: true + type: string + x-extensible-enum: + - OK + - APPROACHING_SOFT_LIMIT + - EXCEEDING_SOFT_LIMIT + - APPROACHING_HARD_LIMIT + - EXCEEDING_HARD_LIMIT + last_updated: + description: The last time the state limit status was updated. + example: 1996-03-19T01:02:03-04:05 + format: date-time + readOnly: true + type: string + detail: + description: Details about why state limit status is in its current state. + example: The statement is within state limits. + type: string + readOnly: true + readOnly: true + type: object + + sql.v1.ResultSchema: + type: object + description: The table columns of the results schema. + properties: + columns: + type: array + description: The properties of each SQL column in the schema. + items: + $ref: '#/components/schemas/ColumnDetails' + + ColumnDetails: + type: object + description: A column in the results schema. + required: + - name + - type + properties: + name: + type: string + description: The name of the SQL table column. + example: Column_Name + type: + allOf: + - $ref: '#/components/schemas/DataType' + description: JSON object in TableSchema format; describes the data returned + by the results serving API. + example: + type: CHAR + nullable: true + length: 8 + + DataType: + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + allOf: + - $ref: '#/components/schemas/DataType' + description: The type of the key in the data type (if applicable). + value_type: + allOf: + - $ref: '#/components/schemas/DataType' + description: The type of the value in the data type (if applicable). + element_type: + allOf: + - $ref: '#/components/schemas/DataType' + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + + RowFieldType: + type: object + properties: + name: + type: string + description: The name of the field. + field_type: + allOf: + - $ref: '#/components/schemas/DataType' + description: The data type of the field. + description: + type: string + description: The description of the field. + required: + - name + - field_type + + sql.v1.StatementWarning: + type: object + description: Represents a non-fatal issue encountered during statement processing. + required: + - severity + - created_at + - reason + - message + properties: + severity: + $ref: '#/components/schemas/sql.v1.WarningSeverity' + created_at: + type: string + format: date-time + description: The timestamp when the warning was created. It is represented + in RFC3339 format and is in UTC. + example: '2025-11-10T16:20:00Z' + readOnly: true + reason: + type: string + description: A machine-readable short, upper case summary delimited by underscore. + example: MISSING_WINDOW_START_END + message: + type: string + description: A human-readable string containing the description of the warning. + example: The statement is missing window start and end bounds which may + lead to unbounded state growth. + + sql.v1.WarningSeverity: + type: string + x-extensible-enum: + - LOW + - MODERATE + - CRITICAL + description: | + Indicates the severity of the warning. + + LOW: Indicates a low severity warning and for informing the user. + + MODERATE: Indicates a moderate severity warning and may require user action. Could cause degraded statements if certain conditions apply. + + CRITICAL: Indicates a critical severity warning and requires user action. It will cause degraded statements eventually. + example: MODERATE + + # Exceptions API Components + + ExceptionListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object + can be addressed. This URL encodes the service location, API version, + and other particulars necessary to locate the resource at a point in time + type: string + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/sql123/exceptions + + sql.v1.StatementExceptionList: + type: object + description: |- + StatementExceptionList is a list of exceptions coming from FAILED or FAILING Statements created by + the SQL Statements API. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementExceptionList + metadata: + allOf: + - $ref: '#/components/schemas/ExceptionListMeta' + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/sql.v1.StatementException' + + sql.v1.StatementException: + type: object + properties: + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementException + name: + type: string + description: Name of the SQL statement exception. + example: java.lang.RuntimeException + readOnly: true + message: + type: string + description: Error message of the statement exception. + example: 'java.lang.RuntimeException: An error occurred' + readOnly: true + timestamp: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: The date and time at which the exception occurred. It is represented + in RFC3339 format and is in UTC. + readOnly: true + x-enable-objectmeta: true + PatchRequest: + type: array + description: PatchRequest represent a json-patch request to be applied to the + Statement. See https://tools.ietf.org/html/rfc6902 + items: + oneOf: + - $ref: '#/components/schemas/JsonPatchRequestAddReplace' + - $ref: '#/components/schemas/JsonPatchRequestRemove' + - $ref: '#/components/schemas/JsonPatchRequestMoveCopy' + JsonPatchRequestAddReplace: + type: object + description: This option is used to add or replace a value for a field + additionalProperties: false + required: + - value + - op + - path + properties: + path: + description: A JSON Pointer path. + type: string + value: + description: The value to add, replace or test. + op: + description: The operation to perform. + type: string + enum: + - ADD + - REPLACE + - TEST + JsonPatchRequestRemove: + type: object + description: This option is used to remove a field + additionalProperties: false + required: + - op + - path + properties: + path: + description: A JSON Pointer path. + type: string + op: + description: The operation to perform. + type: string + enum: + - REMOVE + JsonPatchRequestMoveCopy: + type: object + description: This option is used to move or copy a field + additionalProperties: false + required: + - from + - op + - path + properties: + path: + description: A JSON Pointer path. + type: string + op: + description: The operation to perform. + type: string + enum: + - MOVE + - COPY + from: + description: A JSON Pointer path. + type: string + + networking.v1.DnsForwarder: + type: object + description: |- + Add, remove, and update DNS forwarder for your gateway. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + ## The DNS Forwarders Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/networking/v1/dns-forwarders/df-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-456xyz/dns-forwarder=df-12345 + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + networking.v1.DnsForwarderStatus: + type: object + required: + - phase + description: The status of the Dns Forwarder + properties: + phase: + type: string + x-extensible-enum: [PROVISIONING, CREATED, READY, DEGRADED, FAILED, DEPROVISIONING] + description: | + The lifecycle phase of the DNS forwarder: + + PROVISIONING: DNS forwarder provisioning is in progress; + + CREATED: DNS forwarder is created. It will automatically become ready once a Kafka cluster is provisioned; + + READY: DNS forwarder is ready; + + FAILED: DNS forwarder is in a failed state; + + DEGRADED: DNS forwarder is in a degraded state, transitioning from 'READY' due to unreachable DNS resolvers; + + DEPROVISIONING: DNS forwarder deprovisioning is in progress; + readOnly: true + example: READY + error_code: + type: string + description: Error code if dns forwarder is in a failed state. May be used + for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if dns forwarder is in a failed state + readOnly: true + readOnly: true + networking.v1.Ip: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+$ + description: IPv4 Address + example: 10.200.0.0 + networking.v1.ForwardViaIp: + type: object + title: ForwardViaIp + description: DNS Forwarder Configured via DNS Server IPs. + required: + - kind + - dns_server_ips + properties: + kind: + description: DNS Forwarder Configured via DNS Server IPs kind type. + type: string + enum: [ForwardViaIp] + dns_server_ips: + type: array + items: + $ref: '#/components/schemas/networking.v1.Ip' + uniqueItems: true + minItems: 1 + maxItems: 3 + description: List of IP addresses of the DNS server + example: [10.200.0.0, 10.200.0.1] + networking.v1.DnsForwarderList: + type: object + description: |- + Add, remove, and update DNS forwarder for your gateway. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + ## The DNS Forwarders Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarderList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/networking/v1/dns-forwarders + last: + example: https://api.confluent.cloud/networking/v1/dns-forwarders?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/networking/v1/dns-forwarders?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/networking/v1/dns-forwarders?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/networking.v1.DnsForwarder' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - domains + - config + - environment + - gateway + uniqueItems: true + networking.v1.DnsForwarderSpec: + type: object + description: The desired state of the Dns Forwarder + properties: + display_name: + type: string + description: The name of the DNS forwarder + example: prod-dnsf-1 + domains: + type: array + items: + type: string + uniqueItems: true + minItems: 0 + maxItems: 10 + description: List of domains for the DNS forwarder to use + example: [example.com, domainname.com] + config: + type: object + oneOf: + - $ref: '#/components/schemas/networking.v1.ForwardViaIp' + discriminator: + propertyName: kind + mapping: + ForwardViaIp: '#/components/schemas/networking.v1.ForwardViaIp' + description: The specific details of different kinds of configuration for + DNS Forwarder. + environment: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The environment to which this belongs. + gateway: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The gateway to which this belongs. + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.AccessPoint: + type: object + description: |- + AccessPoint objects represent network connections in and out of Gateways. + This API allows you to list, create, read, update, and delete your access points. + + + ## The Access Points Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/networking/v1/access-points/ap-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-456xyz/access-point=ap-12345 + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + networking.v1.AccessPointStatus: + type: object + required: + - phase + description: The status of the Access Point + properties: + phase: + type: string + x-extensible-enum: [PROVISIONING, PENDING_ACCEPT, READY, FAILED, DEPROVISIONING, + DISCONNECTED, DEGRADED, ERROR] + description: | + The lifecycle phase of the access point: + + PROVISIONING: Access point provisioning is in progress; + + PENDING_ACCEPT: Access point connection request is pending acceptance by the customer; + + READY: Access point is ready; + + FAILED: Access point is in a failed state; + + DEPROVISIONING: Access point deprovisioning is in progress; + + DISCONNECTED: Access Point has been disconnected in the cloud provider by the customer; + + DEGRADED: Access Point is experiencing reduced performance or partial failure; + + ERROR: Invalid customer input during Access Point creation; + readOnly: true + example: READY + error_code: + type: string + description: Error code if access point is in a failed state. May be used + for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if access point is in a failed state. + readOnly: true + config: + type: object + oneOf: + - $ref: '#/components/schemas/networking.v1.AwsEgressPrivateLinkEndpointStatus' + - $ref: '#/components/schemas/networking.v1.AwsIngressPrivateLinkEndpointStatus' + - $ref: '#/components/schemas/networking.v1.AzureEgressPrivateLinkEndpointStatus' + - $ref: '#/components/schemas/networking.v1.AzureIngressPrivateLinkEndpointStatus' + - $ref: '#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectEndpointStatus' + - $ref: '#/components/schemas/networking.v1.GcpIngressPrivateServiceConnectEndpointStatus' + description: Cloud specific status of the access point. + discriminator: + propertyName: kind + mapping: + AwsEgressPrivateLinkEndpointStatus: '#/components/schemas/networking.v1.AwsEgressPrivateLinkEndpointStatus' + AwsIngressPrivateLinkEndpointStatus: '#/components/schemas/networking.v1.AwsIngressPrivateLinkEndpointStatus' + AzureEgressPrivateLinkEndpointStatus: '#/components/schemas/networking.v1.AzureEgressPrivateLinkEndpointStatus' + AzureIngressPrivateLinkEndpointStatus: '#/components/schemas/networking.v1.AzureIngressPrivateLinkEndpointStatus' + GcpEgressPrivateServiceConnectEndpointStatus: '#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectEndpointStatus' + GcpIngressPrivateServiceConnectEndpointStatus: '#/components/schemas/networking.v1.GcpIngressPrivateServiceConnectEndpointStatus' + readOnly: true + readOnly: true + networking.v1.DnsRecord: + type: object + description: |- + DNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records. + + ## The DNS Records Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/networking/v1/dns-records/dnsrec-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-456xyz/dns-record=dnsrec-12345 + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + networking.v1.DnsRecordStatus: + type: object + required: + - phase + description: The status of the Dns Record + properties: + phase: + type: string + x-extensible-enum: [PROVISIONING, CREATED, READY, FAILED, DEPROVISIONING] + description: | + The lifecycle phase of the DNS record: + + PROVISIONING: DNS record provisioning is in progress; + + CREATED: DNS record is created. It will automatically become ready once a Kafka cluster is provisioned; + + READY: DNS record is ready; + + FAILED: DNS record is in a failed state; + + DEPROVISIONING: DNS record deprovisioning is in progress; + readOnly: true + example: READY + error_code: + type: string + description: Error code if the DNS record is in a failed state. May be used + for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if the DNS record is in a failed + state. + readOnly: true + readOnly: true + networking.v1.AwsEgressPrivateLinkEndpoint: + type: object + description: AWS VPC Endpoint. + required: + - kind + - vpc_endpoint_service_name + properties: + kind: + type: string + description: AwsEgressPrivateLinkEndpoint kind. + enum: [AwsEgressPrivateLinkEndpoint] + vpc_endpoint_service_name: + description: ID of the VPC Endpoint service used for PrivateLink. + type: string + minLength: 1 + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + enable_high_availability: + type: boolean + description: Whether a resource should be provisioned with high availability. + Endpoints deployed with high availability have network interfaces deployed + in multiple AZs. + example: false + x-immutable: true + target_system: + type: string + description: '[Used by the Confluent Cloud Console] The target system or + service that the PrivateLink Endpoint connects to (e.g. "MONGODB" or "SNOWFLAKE").' + example: S3 + networking.v1.AwsIngressPrivateLinkEndpoint: + type: object + description: AWS Ingress Private Link Endpoint. + required: + - kind + - vpc_endpoint_id + properties: + kind: + type: string + description: AwsIngressPrivateLinkEndpoint kind. + enum: [AwsIngressPrivateLinkEndpoint] + vpc_endpoint_id: + description: ID of a VPC Endpoint that will be connected to the VPC Endpoint + service. + type: string + minLength: 1 + example: vpce-00000000000000000 + x-immutable: true + networking.v1.AzureEgressPrivateLinkEndpoint: + type: object + description: Azure Private Endpoint. + required: + - kind + - private_link_service_resource_id + properties: + kind: + type: string + description: AzureEgressPrivateLinkEndpoint kind. + enum: [AzureEgressPrivateLinkEndpoint] + private_link_service_resource_id: + description: Resource ID of the Azure Private Link service. + type: string + minLength: 1 + # yamllint disable-line rule:line-length + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3 + private_link_subresource_name: + type: string + description: Name of the subresource for the Private Endpoint to connect + to. + example: sqlServer + target_system: + type: string + description: '[Used by the Confluent Cloud Console] The target system or + service that the PrivateLink Endpoint connects to (e.g. "MONGODB" or "SNOWFLAKE").' + example: SNOWFLAKE + networking.v1.AzureIngressPrivateLinkEndpoint: + type: object + description: Azure Ingress Private Link Endpoint. + required: + - kind + - private_endpoint_resource_id + properties: + kind: + type: string + description: AzureIngressPrivateLinkEndpoint kind. + enum: [AzureIngressPrivateLinkEndpoint] + private_endpoint_resource_id: + description: Resource ID of a Private Endpoint that will be connected to + the Private Link service. + type: string + minLength: 1 + # yamllint disable-line rule:line-length + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-centralus-rg/providers/Microsoft.Network/privateEndpoints/private-endpoint-azure-centralus + x-immutable: true + networking.v1.GcpEgressPrivateServiceConnectEndpoint: + type: object + description: GCP Private Service Connect Endpoint. + required: + - kind + - private_service_connect_endpoint_target + properties: + kind: + type: string + description: GcpEgressPrivateServiceConnectEndpoint kind. + enum: [GcpEgressPrivateServiceConnectEndpoint] + private_service_connect_endpoint_target: + description: URI of the service attachment for the published service that + the Private Service Connect Endpoint connects to or "ALL_GOOGLE_APIS" + for global Google APIs. + type: string + minLength: 1 + example: projects/project-name/regions/us-central1/serviceAttachments/service-attachment-name + target_system: + type: string + description: '[Used by the Confluent Cloud Console] The target system or + service that the PrivateLink Endpoint connects to (e.g. "GCS" or "SNOWFLAKE").' + example: GCS + networking.v1.GcpIngressPrivateServiceConnectEndpoint: + type: object + description: GCP Ingress Private Service Connect Endpoint. + required: + - kind + - private_service_connect_connection_id + properties: + kind: + type: string + description: GcpIngressPrivateServiceConnectEndpoint kind. + enum: [GcpIngressPrivateServiceConnectEndpoint] + private_service_connect_connection_id: + description: The ID of the Private Service Connect connection. + type: string + minLength: 1 + example: '00000000000000000' + networking.v1.AwsEgressPrivateLinkEndpointStatus: + type: object + title: AWS + description: Status of an AWS PrivateLink Endpoint. + required: + - kind + - vpc_endpoint_id + - vpc_endpoint_dns_name + properties: + kind: + description: AwsEgressPrivateLinkEndpointStatus kind. + type: string + enum: [AwsEgressPrivateLinkEndpointStatus] + vpc_endpoint_id: + description: ID of a VPC Endpoint (if any) that is connected to the VPC + Endpoint service. + type: string + example: vpce-00000000000000000 + readOnly: true + vpc_endpoint_dns_name: + description: DNS name of a VPC Endpoint (if any) that is connected to the + VPC Endpoint service. + type: string + example: vpce-00000000000000000-00000000.vpce-svc-00000000000000000.us-west-2.vpce.amazonaws.com + readOnly: true + networking.v1.AwsIngressPrivateLinkEndpointStatus: + type: object + description: Status of an AWS Ingress Private Link Endpoint. + required: + - kind + - vpc_endpoint_service_name + - vpc_endpoint_id + properties: + kind: + description: AwsIngressPrivateLinkEndpointStatus kind. + type: string + enum: [AwsIngressPrivateLinkEndpointStatus] + vpc_endpoint_service_name: + description: ID of the Confluent Cloud VPC Endpoint service used for PrivateLink. + type: string + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + readOnly: true + vpc_endpoint_id: + description: ID of the VPC Endpoint used for connecting to the VPC Endpoint + service. + type: string + example: vpce-00000000000000000 + readOnly: true + dns_domain: + description: DNS domain name used to configure the Private Hosted Zone for + the Access Point. + type: string + example: ap123abc.us-west-2.aws.accesspoint.confluent.cloud + readOnly: true + networking.v1.AzureEgressPrivateLinkEndpointStatus: + type: object + description: Status of an Azure Private Endpoint. + required: + - kind + - private_endpoint_resource_id + - private_endpoint_ip_address + properties: + kind: + description: AzureEgressPrivateLinkEndpointStatus kind. + type: string + enum: [AzureEgressPrivateLinkEndpointStatus] + private_endpoint_resource_id: + description: Resource ID of the Private Endpoint (if any) that is connected + to the Private Link service. + type: string + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3 + private_endpoint_domain: + description: Domain of the Private Endpoint (if any) that is connected to + the Private Link service. + type: string + readOnly: true + example: dbname.database.windows.net + private_endpoint_ip_address: + description: IP address of the Private Endpoint (if any) that is connected + to the Private Link service. + type: string + readOnly: true + example: 10.2.0.68 + private_endpoint_custom_dns_config_domains: + description: Domains of the Private Endpoint (if any) based off FQDNs in + Azure custom DNS configs, which are required in your private DNS setup. + type: array + items: + type: string + readOnly: true + example: [dbname.database.windows.net, dbname-region.database.windows.net] + networking.v1.AzureIngressPrivateLinkEndpointStatus: + type: object + description: Status of an Azure Ingress Private Link Endpoint. + required: + - kind + - private_link_service_alias + - private_link_service_resource_id + - private_endpoint_resource_id + properties: + kind: + description: AzureIngressPrivateLinkEndpointStatus kind. + type: string + enum: [AzureIngressPrivateLinkEndpointStatus] + private_link_service_alias: + description: Alias of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: plattg-123abc-privatelink.00000000-0000-0000-0000-000000000000.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Resource ID of the Confluent Cloud Private Link Service. + type: string + readOnly: true + # yamllint disable-line rule:line-length + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/plattg-123abc/providers/Microsoft.Network/privateLinkServices/plattg-123abc-privatelink + private_endpoint_resource_id: + description: Resource ID of the Private Endpoint used for connecting to + the Private Link Service. + type: string + readOnly: true + # yamllint disable-line rule:line-length + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-centralus-rg/providers/Microsoft.Network/privateEndpoints/private-endpoint-azure-centralus + dns_domain: + description: DNS domain name used to configure the Private DNS Zone for + the Access Point. + type: string + example: ap123abc.centralus.azure.accesspoint.confluent.cloud + readOnly: true + networking.v1.GcpEgressPrivateServiceConnectEndpointStatus: + type: object + description: Status of a GCP Private Service Connect Endpoint. + required: + - kind + - private_service_connect_endpoint_connection_id + - private_service_connect_endpoint_name + - private_service_connect_endpoint_ip_address + properties: + kind: + description: GcpEgressPrivateServiceConnectEndpointStatus kind. + type: string + enum: [GcpEgressPrivateServiceConnectEndpointStatus] + private_service_connect_endpoint_connection_id: + description: Connection ID of the Private Service Connect Endpoint (if any) + that is connected to the endpoint target. + type: string + readOnly: true + example: '' + private_service_connect_endpoint_name: + description: Name of the Private Service Connect Endpoint (if any) that + is connected to the endpoint target. + type: string + readOnly: true + example: plap-123456 + private_service_connect_endpoint_ip_address: + description: IP address of the Private Service Connect Endpoint (if any) + that is connected to the endpoint target. + type: string + readOnly: true + example: 10.2.0.68 + networking.v1.GcpIngressPrivateServiceConnectEndpointStatus: + type: object + description: Status of a GCP Ingress Private Service Connect Endpoint. + required: + - kind + - private_service_connect_service_attachment + - private_service_connect_connection_id + properties: + kind: + description: GcpIngressPrivateServiceConnectEndpointStatus kind. + type: string + enum: [GcpIngressPrivateServiceConnectEndpointStatus] + private_service_connect_service_attachment: + description: URI of the Private Service Connect Service Attachment in Confluent + Cloud. + type: string + readOnly: true + example: projects/traffic-prod/regions/us-central1/serviceAttachments/plattg-abc123-service-attachment + private_service_connect_connection_id: + description: The ID of the Private Service Connect connection. + type: string + readOnly: true + example: '00000000000000000' + dns_domain: + description: DNS domain name used to configure the DNS Zone for the Access + Point. + type: string + example: ap123abc.us-central1.gcp.accesspoint.confluent.cloud + readOnly: true + networking.v1.PrivateLinkAccessPoint: + type: object + description: DNS record that is associated with a PrivateLink access point. + required: + - kind + - resource_id + properties: + kind: + description: PrivateLinkAccessPoint kind. + type: string + enum: [PrivateLinkAccessPoint] + resource_id: + description: ID of the target resource. + type: string + minLength: 1 + example: ap-12345 + networking.v1.AwsPrivateNetworkInterface: + type: object + description: Confluent Private Network Interface powered by AWS ENI. + required: + - kind + properties: + kind: + type: string + description: AwsPrivateNetworkInterface kind. + enum: [AwsPrivateNetworkInterface] + network_interfaces: + description: List of the IDs of the Elastic Network Interfaces. + type: array + items: + type: string + uniqueItems: true + minItems: 51 + example: [eni-00000000000000000, eni-00000000000000001, eni-00000000000000002, + eni-00000000000000003, eni-00000000000000004, eni-00000000000000005, eni-00000000000000006, + eni-00000000000000007, eni-00000000000000008, eni-00000000000000009, eni-00000000000000010, + eni-00000000000000011, eni-00000000000000012, eni-00000000000000013, eni-00000000000000014, + eni-00000000000000015, eni-00000000000000016, eni-00000000000000017, eni-00000000000000018, + eni-00000000000000019, eni-00000000000000020, eni-00000000000000021, eni-00000000000000022, + eni-00000000000000023, eni-00000000000000024, eni-00000000000000025, eni-00000000000000026, + eni-00000000000000027, eni-00000000000000028, eni-00000000000000029, eni-00000000000000030, + eni-00000000000000031, eni-00000000000000032, eni-00000000000000033, eni-00000000000000034, + eni-00000000000000035, eni-00000000000000036, eni-00000000000000037, eni-00000000000000038, + eni-00000000000000039, eni-00000000000000040, eni-00000000000000041, eni-00000000000000042, + eni-00000000000000043, eni-00000000000000044, eni-00000000000000045, eni-00000000000000046, + eni-00000000000000047, eni-00000000000000048, eni-00000000000000049, eni-00000000000000050] + account: + type: string + pattern: ^\d{12}$ + example: '000000000000' + description: |- + The AWS account ID associated with the ENIs you are using for the Confluent Private Network Interface. + x-immutable: true + egress_routes: + type: array + description: List of egress CIDRs (IPv4) for egress PNI. + items: + type: string + uniqueItems: true + example: [10.0.0.0/16, 10.1.0.0/16, 10.2.0.0/16, 172.16.0.0/16] + networking.v1.AccessPointList: + type: object + description: |- + AccessPoint objects represent network connections in and out of Gateways. + This API allows you to list, create, read, update, and delete your access points. + + + ## The Access Points Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPointList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/networking/v1/access-points + last: + example: https://api.confluent.cloud/networking/v1/access-points?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/networking/v1/access-points?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/networking/v1/access-points?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/networking.v1.AccessPoint' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - config + - environment + - gateway + uniqueItems: true + networking.v1.AccessPointSpec: + type: object + description: The desired state of the Access Point + properties: + display_name: + type: string + description: The name of the access point. + example: prod-ap-egress-usw2 + config: + type: object + oneOf: + - $ref: '#/components/schemas/networking.v1.AwsEgressPrivateLinkEndpoint' + - $ref: '#/components/schemas/networking.v1.AwsIngressPrivateLinkEndpoint' + - $ref: '#/components/schemas/networking.v1.AzureEgressPrivateLinkEndpoint' + - $ref: '#/components/schemas/networking.v1.AzureIngressPrivateLinkEndpoint' + - $ref: '#/components/schemas/networking.v1.AwsPrivateNetworkInterface' + - $ref: '#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectEndpoint' + - $ref: '#/components/schemas/networking.v1.GcpIngressPrivateServiceConnectEndpoint' + discriminator: + propertyName: kind + mapping: + AwsEgressPrivateLinkEndpoint: '#/components/schemas/networking.v1.AwsEgressPrivateLinkEndpoint' + AwsIngressPrivateLinkEndpoint: '#/components/schemas/networking.v1.AwsIngressPrivateLinkEndpoint' + AzureEgressPrivateLinkEndpoint: '#/components/schemas/networking.v1.AzureEgressPrivateLinkEndpoint' + AzureIngressPrivateLinkEndpoint: '#/components/schemas/networking.v1.AzureIngressPrivateLinkEndpoint' + AwsPrivateNetworkInterface: '#/components/schemas/networking.v1.AwsPrivateNetworkInterface' + GcpEgressPrivateServiceConnectEndpoint: '#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectEndpoint' + GcpIngressPrivateServiceConnectEndpoint: '#/components/schemas/networking.v1.GcpIngressPrivateServiceConnectEndpoint' + description: The specific details of the different access point configurations. + environment: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The environment to which this belongs. + gateway: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The gateway to which this belongs. + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.DnsRecordList: + type: object + description: |- + DNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records. + + ## The DNS Records Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecordList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/networking/v1/dns-records + last: + example: https://api.confluent.cloud/networking/v1/dns-records?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/networking/v1/dns-records?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/networking/v1/dns-records?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/networking.v1.DnsRecord' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - domain + - config + - environment + - gateway + uniqueItems: true + networking.v1.DnsRecordSpec: + type: object + description: The desired state of the Dns Record + properties: + display_name: + type: string + description: The name of the DNS record. + example: prod-dnsrec-1 + domain: + type: string + description: The fully qualified domain name of the DNS record. + example: example.com + x-immutable: true + config: + type: object + description: The config of the DNS record. + oneOf: + - $ref: '#/components/schemas/networking.v1.PrivateLinkAccessPoint' + discriminator: + propertyName: kind + mapping: + PrivateLinkAccessPoint: '#/components/schemas/networking.v1.PrivateLinkAccessPoint' + environment: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The environment to which this belongs. + gateway: + allOf: + - $ref: '#/components/schemas/TypedEnvScopedObjectReference' + description: The gateway to which this belongs. + x-immutable: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + iam.v2.CertificateAuthority: + type: object + description: | + `CertificateAuthority` objects represent signing certificate authorities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Certificate Authority. + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthority + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/iam/v2/certificate-authorities/op-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/certificate-authority=op-12345 + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + fingerprints: + type: array + items: + type: string + description: |- + The fingerprints for each certificate in the certificate chain. These are SHA-1 encoded + strings that act as unique identifiers for the certificates in the chain. + example: [B1BC968BD4f49D622AA89A81F2150152A41D829C] + readOnly: true + expiration_dates: + type: array + items: + type: string + format: date-time + description: The expiration dates of certificates in the chain. + example: [2017-07-21T17:32:28Z] + readOnly: true + serial_numbers: + type: array + items: + type: string + description: |- + The serial numbers for each certificate in the certificate chain. + example: [219C542DE8f6EC7177FA4EE8C3705797] + readOnly: true + certificate_chain_filename: + type: string + description: The file name of the uploaded pem file for this certificate + authority. + example: certificate.pem + readOnly: true + crl_source: + type: string + description: |- + The source specifies whether the Certificate Revocation List (CRL) is updated from + either local file uploaded (LOCAL) or from url of CRL (URL). + x-extensible-enum: [LOCAL, URL] + example: LOCAL + readOnly: true + crl_url: + type: string + format: uri + description: |- + The url from which to fetch the CRL for the certificate authority if crl_source is URL. + readOnly: true + crl_updated_at: + type: string + format: date-time + description: The timestamp for when CRL was last updated. + example: 2017-07-21T17:32:28Z + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the certificate authority. + example: ENABLED + readOnly: true + iam.v2.CertificateIdentityPool: + type: object + description: |- + `Identitypool` objects represent workload identities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your identity pools associated + with Certificate Authorities + + + Related guide: [Manage Certificate Identity Pools for Granular Client Access Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + ## The Certificate Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_certificate_authority` | Number of Identity Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/iam/v2/certificate-identity-pools/pool-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/certificate-identity-pool=pool-12345 + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + # yamllint disable-line rule:line-length + description: A filter expression in [Supported Common Expression Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + that specifies which identities can authenticate using your certificate + identity pool (see [CEL filter for mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + iam.v2.CreateCertRequest: + type: object + description: This contains the json schema used to create a Certificate Authority + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CreateCertRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/iam/v2/create-cert-requests/ccr-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/create-cert-request=ccr-12345 + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + certificate_chain: + type: string + description: |- + The PEM encoded string containing the signing certificate chain + used to validate client certs. + example: |- + -----BEGIN CERTIFICATE----- + MIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx + GTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds + b2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV + BAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD + VQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa + DuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc + THAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb + Kk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP + c1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX + gzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV + HRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF + AAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj + Y1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG + j/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH + hm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC + X4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A== + -----END CERTIFICATE----- + certificate_chain_filename: + type: string + description: The name of the certificate file. + example: certificate.pem + crl_url: + type: string + format: uri + description: |- + The url from which to fetch the CRL for the certificate authority if crl_source is URL. + crl_chain: + type: string + description: |- + The PEM encoded string containing the CRL for this certificate authority. + Defaults to this over `crl_url` if available. + example: |- + -----BEGIN X509 CRL----- + MIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD + VQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1 + ZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0 + eS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt + MS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl + AhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U + BAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX + CKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4 + xqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl + gIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE + jatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6 + cGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg= + -----END X509 CRL----- + iam.v2.UpdateCertRequest: + type: object + description: This contains the form fields used to update a Certificate Authority + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - UpdateCertRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/iam/v2/update-cert-requests/ucr-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/update-cert-request=ucr-12345 + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + certificate_chain: + type: string + description: |- + The PEM encoded string containing the signing certificate chain + used to validate client certs. + example: |- + -----BEGIN CERTIFICATE----- + MIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx + GTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds + b2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV + BAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD + VQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa + DuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc + THAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb + Kk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP + c1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX + gzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV + HRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF + AAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj + Y1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG + j/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH + hm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC + X4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A== + -----END CERTIFICATE----- + certificate_chain_filename: + type: string + description: The name of the certificate file. Must be set if certificate + is updated. + example: certificate.pem + crl_url: + type: string + format: uri + description: |- + The url from which to fetch the CRL for the certificate authority if crl_source is URL. + crl_chain: + type: string + description: |- + The PEM encoded string containing the CRL for this certificate authority. + Defaults to this over `crl_url` if available. + example: |- + -----BEGIN X509 CRL----- + MIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD + VQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1 + ZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0 + eS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt + MS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl + AhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U + BAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX + CKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4 + xqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl + gIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE + jatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6 + cGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg= + -----END X509 CRL----- + +# default + iam.v2.CertificateAuthorityList: + type: object + description: | + `CertificateAuthority` objects represent signing certificate authorities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Certificate Authority. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthorityList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/iam/v2/certificate-authorities + last: + example: https://api.confluent.cloud/iam/v2/certificate-authorities?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/iam/v2/certificate-authorities?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/iam/v2/certificate-authorities?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/iam.v2.CertificateAuthority' + - type: object + required: + - id + - metadata + - display_name + - description + - fingerprints + - expiration_dates + - serial_numbers + - certificate_chain_filename + - state + uniqueItems: true + iam.v2.CertificateIdentityPoolList: + type: object + description: |- + `Identitypool` objects represent workload identities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your identity pools associated + with Certificate Authorities + + + Related guide: [Manage Certificate Identity Pools for Granular Client Access Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + ## The Certificate Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_certificate_authority` | Number of Identity Pools per Certificate Authority | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPoolList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/iam/v2/certificate-identity-pools + last: + example: https://api.confluent.cloud/iam/v2/certificate-identity-pools?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/iam/v2/certificate-identity-pools?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/iam/v2/certificate-identity-pools?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/iam.v2.CertificateIdentityPool' + - type: object + required: + - id + - metadata + - display_name + - description + - external_identifier + - filter + - principal + - state + uniqueItems: true + pim.v1.Integration: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, and delete individual integrations, and also obtain a + list of all your provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: s3_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider + integration. + example: AWS + default: AWS + x-extensible-enum: [AWS] + config: + type: object + description: Cloud provider specific configs for provider integration + discriminator: + propertyName: kind + mapping: + AwsIntegrationConfig: '#/components/schemas/pim.v1.AwsIntegrationConfig' + oneOf: + - $ref: '#/components/schemas/pim.v1.AwsIntegrationConfig' + x-immutable: true + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + # yamllint disable-line rule:line-length + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + + environment: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The environment to which this belongs. + x-immutable: true' + pim.v1.AwsIntegrationConfig: + type: object + description: | + config schema for AWS cloud service provider. + properties: + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: Cloud provider specific config to which access is provided + through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: [AwsIntegrationConfig] + required: [kind] + pim.v1.IntegrationList: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, and delete individual integrations, and also obtain a + list of all your provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - pim/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/pim/v1/integrations + last: + example: https://api.confluent.cloud/pim/v1/integrations?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/pim/v1/integrations?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/pim/v1/integrations?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/pim.v1.Integration' + - type: object + required: + - id + - config + - environment + uniqueItems: true + pim.v2.Integration: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, update, delete, and validate individual integrations, and also obtain a + list of all your provider integrations. + + Note: The pim/v2 API currently supports only Azure and GCP provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider + integration. + example: GCP + default: GCP + x-extensible-enum: [GCP] + x-immutable: true + config: + type: object + description: | + Cloud provider specific configuration for the provider integration. + Required only when updating integrations with `DRAFT` status. Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + oneOf: + - $ref: '#/components/schemas/pim.v2.GcpIntegrationConfig' + - $ref: '#/components/schemas/pim.v2.AzureIntegrationConfig' + - $ref: '#/components/schemas/pim.v2.AwsIntegrationConfig' + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + # yamllint disable-line rule:line-length + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: | + Status of the provider integration. + - `DRAFT`: Integration exists but is not associated with customer configuration + - `CREATED`: Integration has been associated with customer configuration + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: [DRAFT, CREATED, ACTIVE] + readOnly: true + environment: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The environment to which this belongs. + pim.v2.GcpIntegrationConfig: + type: object + description: | + config schema for GCP cloud service provider. + properties: + google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud uses to impersonate + customer Google Service Account when it accesses resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud impersonates + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: Cloud provider specific config to which access is provided + through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: [GcpIntegrationConfig] + required: [kind] + pim.v2.AzureIntegrationConfig: + type: object + description: | + config schema for Azure cloud service provider. + properties: + confluent_multi_tenant_app_id: + type: string + description: | + The ID of the Confluent Multi-Tenant App that Confluent Cloud uses to impersonate + customer Azure App when it accesses resources in your Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: | + The ID of the customer's Azure Active Directory (Azure AD) tenant + example: 12345678-1234-1234-1234-123456789abc + kind: + type: string + description: Cloud provider specific config to which access is provided + through provider integration. + example: AzureIntegrationConfig + x-extensible-enum: [AzureIntegrationConfig] + required: [kind] + pim.v2.AwsIntegrationConfig: + type: object + description: | + config schema for AWS cloud service provider. + properties: + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: Cloud provider specific config to which access is provided + through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: [AwsIntegrationConfig] + required: [kind] + pim.v2.IntegrationValidateRequest: + type: object + description: Request to validate the provider integration configuration. + properties: + api_version: + type: string + enum: + - pim/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationValidateRequest + id: + type: string + description: The ID of the provider integration to validate. + example: cspi-00000 + maxLength: 255 + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/pim/v2/integration-validate-requests/ivr-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/integration-validate-request=ivr-12345 + config: + type: object + description: | + Cloud provider specific configuration for the provider integration. + Required only for integrations in `DRAFT` status. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + oneOf: + - $ref: '#/components/schemas/pim.v2.GcpIntegrationConfig' + - $ref: '#/components/schemas/pim.v2.AzureIntegrationConfig' + - $ref: '#/components/schemas/pim.v2.AwsIntegrationConfig' + environment: + description: The environment to which this belongs. +# Default + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + pim.v2.IntegrationList: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, update, delete, and validate individual integrations, and also obtain a + list of all your provider integrations. + + Note: The pim/v2 API currently supports only Azure and GCP provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - pim/v2 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/pim/v2/integrations + last: + example: https://api.confluent.cloud/pim/v2/integrations?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/pim/v2/integrations?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/pim/v2/integrations?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/pim.v2.Integration' + - type: object + required: + - id + - status + - environment + uniqueItems: true + artifact.v1.FlinkArtifact: + type: object + description: |- + FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. + + + ## The Flink Artifacts Model + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifact + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/artifact/v1/flink-artifacts/fa-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/flink-artifact=fa-12345 + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: [AWS, GCP, AZURE] + region: + type: string + description: The Cloud provider region the Flink Artifact archive is uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: Unique name of the Flink Artifact per cloud, region, environment + scope. + maxLength: 60 + class: + type: string + description: Java class or alias for the artifact as provided by developer. + Deprecated + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + x-immutable: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: [ZIP, JAR] + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: [JAVA, PYTHON] + versions: + type: array + description: Versions associated with this Flink Artifact. + items: + $ref: '#/components/schemas/artifact.v1.FlinkArtifactVersion' + artifact.v1.PresignedUrl: + type: object + description: |- + Request a presigned upload URL for new Flink Artifact. Note that + the URL policy expires in one hour. If the policy expires, you can request + a new presigned upload URL. + + + ## The Presigned Urls Model + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Flink Artifact archive. + example: JAR + x-extensible-enum: [ZIP, JAR] + readOnly: true + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + x-extensible-enum: [AWS, GCP, AZURE] + readOnly: true + region: + type: string + description: The Cloud provider region the Flink Artifact archive is uploaded. + example: us-east-1 + readOnly: true + environment: + type: string + description: The Environment the uploaded Flink Artifact belongs to. + example: env-00000 + readOnly: true + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Flink Artifact archive. + example: https://confluent-flink-artifacts-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: object + description: Upload form data of the Flink Artifact. All values should be + strings. + example: + bucket: confluent-flink-artifacts-stag-us-west-2 + # yamllint disable-line rule:line-length + key: staging/flink-artifact/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/flink-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/artifact.jar + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + readOnly: true + artifact.v1.FlinkArtifactVersion: + type: object + description: | + Version of the Flink Artifact + properties: + version: + type: string + description: Version id of the Flink Artifact. + example: cfa-ver-001 + maxLength: 60 + release_notes: + type: string + description: Release Notes of the Flink Artifact version. + maxLength: 256 + is_beta: + type: boolean + description: Flag to specify stability of the version + artifact_id: + type: object + description: The Flink Artifact this version belongs to. + allOf: + - $ref: '#/components/schemas/artifact.v1.FlinkArtifact' + upload_source: + type: object + oneOf: + - $ref: '#/components/schemas/artifact.v1.UploadSource.PresignedUrl' + # yamllint disable-line rule:line-length + description: Upload source of the Flink Artifact Version. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/artifact.v1.UploadSource.PresignedUrl' + required: + - version + - artifact_id + - upload_source + artifact.v1.PresignedUrlRequest: + type: object + description: | + Request schema of the presigned upload URL. + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrlRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/artifact/v1/presigned-url-requests/pur-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/presigned-url-request=pur-12345 + content_format: + type: string + example: JAR + description: Archive format of the Flink Artifact. + x-extensible-enum: [JAR, ZIP] + cloud: + type: string + example: AWS + description: Cloud provider where the Flink Artifact archive is uploaded. + x-extensible-enum: [AWS, GCP, AZURE] + region: + type: string + example: us-east-1 + description: The Cloud provider region the Flink Artifact archive is uploaded. + maxLength: 60 + environment: + type: string + example: env-00000 + description: The Environment the uploaded Flink Artifact belongs to. + maxLength: 255 + artifact.v1.UploadSource.PresignedUrl: + type: object + description: |- + Request a presigned upload URL for new Flink Artifact. Note that + the URL policy expires in one hour. If the policy expires, you can request + a new presigned upload URL. + + + ## The Presigned Urls Model + + properties: + api_version: + type: string + enum: + - artifact.v1/UploadSource + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/artifact.v1/UploadSource/presigned-urls/pu-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/presigned-url=pu-12345 + location: + type: string + description: | + Location of the Flink Artifact source. + x-extensible-enum: [PRESIGNED_URL_LOCATION] + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + # yamllint disable-line rule:line-length + description: Upload ID returned by the `/presigned-upload-url` API. This + field returns an empty string in all responses. + artifact.v1.FlinkArtifactList: + type: object + description: |- + FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. + + + ## The Flink Artifacts Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifactList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/artifact/v1/flink-artifacts + last: + example: https://api.confluent.cloud/artifact/v1/flink-artifacts?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/artifact/v1/flink-artifacts?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/artifact/v1/flink-artifacts?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/artifact.v1.FlinkArtifact' + - type: object + required: + - id + - metadata + - cloud + - region + - environment + - display_name + uniqueItems: true + networking.v1.Gateway: + type: object + description: |- + A Gateway represents a slice of traffic capacity in a region that is reserved for a customer. + + + ## The Gateways Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `gateways_per_region_per_environment` | Number of Gateways per region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/networking/v1/gateways/gw-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-12345 + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + networking.v1.GatewayStatus: + type: object + required: + - phase + description: The status of the Gateway + properties: + phase: + type: string + x-extensible-enum: [CREATED, PROVISIONING, READY, FAILED, DEPROVISIONING, + EXPIRED] + description: | + The lifecycle phase of the gateway: + + CREATED: gateway exists without an Access Point. + + PROVISIONING: gateway provisioning is in progress; + + READY: gateway is ready; + + FAILED: gateway is in a failed state; + + DEPROVISIONING: gateway deprovisioning is in progress; + + EXPIRED: gateway has timed out waiting for connections, can only be deleted; + readOnly: true + example: READY + error_code: + type: string + description: Error code if gateway is in a failed state. May be used for + programmatic error checking. + readOnly: true + + error_message: + type: string + description: Displayable error message if gateway is in a failed state + readOnly: true + + cloud_gateway: + type: object + description: Gateway type specific status. + oneOf: + - $ref: '#/components/schemas/networking.v1.AwsEgressPrivateLinkGatewayStatus' + - $ref: '#/components/schemas/networking.v1.AwsIngressPrivateLinkGatewayStatus' + - $ref: '#/components/schemas/networking.v1.AwsPrivateNetworkInterfaceGatewayStatus' + - $ref: '#/components/schemas/networking.v1.AzureEgressPrivateLinkGatewayStatus' + - $ref: '#/components/schemas/networking.v1.AzureIngressPrivateLinkGatewayStatus' + - $ref: '#/components/schemas/networking.v1.GcpPeeringGatewayStatus' + - $ref: '#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectGatewayStatus' + - $ref: '#/components/schemas/networking.v1.GcpIngressPrivateServiceConnectGatewayStatus' + readOnly: true + discriminator: + propertyName: kind + mapping: + AwsPrivateNetworkInterfaceGatewayStatus: '#/components/schemas/networking.v1.AwsPrivateNetworkInterfaceGatewayStatus' + AwsEgressPrivateLinkGatewayStatus: '#/components/schemas/networking.v1.AwsEgressPrivateLinkGatewayStatus' + AwsIngressPrivateLinkGatewayStatus: '#/components/schemas/networking.v1.AwsIngressPrivateLinkGatewayStatus' + AzureEgressPrivateLinkGatewayStatus: '#/components/schemas/networking.v1.AzureEgressPrivateLinkGatewayStatus' + AzureIngressPrivateLinkGatewayStatus: '#/components/schemas/networking.v1.AzureIngressPrivateLinkGatewayStatus' + GcpPeeringGatewayStatus: '#/components/schemas/networking.v1.GcpPeeringGatewayStatus' + GcpEgressPrivateServiceConnectGatewayStatus: '#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectGatewayStatus' + GcpIngressPrivateServiceConnectGatewayStatus: '#/components/schemas/networking.v1.GcpIngressPrivateServiceConnectGatewayStatus' + readOnly: true + networking.v1.AwsPrivateNetworkInterfaceGatewaySpec: + type: object + description: AWS Private Network Interface Gateway details from AWS. + required: + - kind + - region + - zones + properties: + kind: + description: AWS Private Network Interface Gateway Spec kind type. + type: string + enum: [AwsPrivateNetworkInterfaceGatewaySpec] + region: + type: string + description: AWS region of the Private Network Interface Gateway. + zones: + type: array + items: + type: string + description: AWS availability zone ids of the Private Network Interface + Gateway. + networking.v1.AwsPeeringGatewaySpec: + type: object + description: AWS Peering Gateway details from AWS. + required: + - kind + - region + properties: + kind: + description: AWS Peering Gateway Spec kind type. + type: string + enum: [AwsPeeringGatewaySpec] + region: + type: string + description: AWS region of the Peering Gateway. + networking.v1.AzurePeeringGatewaySpec: + type: object + description: Azure Peering Gateway details from Azure. + required: + - kind + - region + properties: + kind: + description: Azure Peering Gateway Spec kind type. + type: string + enum: [AzurePeeringGatewaySpec] + region: + type: string + description: Azure region of the Peering Gateway. + networking.v1.AwsEgressPrivateLinkGatewaySpec: + type: object + description: AWS Egress Private Link Gateway details from AWS. + required: + - kind + - region + properties: + kind: + description: AWS Egress Private Link Gateway Spec kind type. + type: string + enum: [AwsEgressPrivateLinkGatewaySpec] + region: + type: string + description: AWS region of the Egress Private Link Gateway. + networking.v1.AwsIngressPrivateLinkGatewaySpec: + type: object + description: AWS Ingress Private Link Gateway details from AWS. + required: + - kind + - region + properties: + kind: + description: AWS Ingress Private Link Gateway Spec kind type. + type: string + enum: [AwsIngressPrivateLinkGatewaySpec] + region: + type: string + description: AWS region of the Ingress Private Link Gateway. + networking.v1.AzureEgressPrivateLinkGatewaySpec: + type: object + description: Azure Egress Private Link Gateway details from Azure. + required: + - kind + - region + properties: + kind: + description: Azure Egress Private Link Gateway Spec kind type. + type: string + enum: [AzureEgressPrivateLinkGatewaySpec] + region: + type: string + description: Azure region of the Egress Private Link Gateway. + networking.v1.AzureIngressPrivateLinkGatewaySpec: + type: object + description: Azure Ingress Private Link Gateway details from Azure. + required: + - kind + - region + properties: + kind: + description: Azure Ingress Private Link Gateway Spec kind type. + type: string + enum: [AzureIngressPrivateLinkGatewaySpec] + region: + type: string + description: Azure region of the Ingress Private Link Gateway. + networking.v1.GcpPeeringGatewaySpec: + type: object + description: GCP Peering Gateway details. + required: + - kind + - region + properties: + kind: + description: GCP Peering Gateway Spec kind type. + type: string + enum: [GcpPeeringGatewaySpec] + region: + type: string + description: GCP region of the Peering Gateway. + networking.v1.GcpEgressPrivateServiceConnectGatewaySpec: + type: object + description: GCP Private Service Connect Gateway details from GCP. + required: + - kind + - region + properties: + kind: + description: GCP Private Service Connect Gateway Spec kind type. + type: string + enum: [GcpEgressPrivateServiceConnectGatewaySpec] + region: + type: string + description: GCP region of the Egress Private Service Connect Gateway. + networking.v1.GcpIngressPrivateServiceConnectGatewaySpec: + type: object + description: GCP Ingress Private Service Connect Gateway details from GCP. + required: + - kind + - region + properties: + kind: + description: GCP Ingress Private Service Connect Gateway Spec kind type. + type: string + enum: [GcpIngressPrivateServiceConnectGatewaySpec] + region: + type: string + description: GCP region of the Ingress Private Service Connect Gateway. + networking.v1.AwsPrivateNetworkInterfaceGatewayStatus: + type: object + required: + - kind + description: AWS Private Network Interface Gateway details from AWS. + properties: + kind: + description: AWS Private Network Interface Gateway Status kind type. + type: string + enum: [AwsPrivateNetworkInterfaceGatewayStatus] + account: + description: The AWS account ID associated with the Private Network Interface + Gateway. + type: string + example: '000000000000' + readOnly: true + networking.v1.AwsEgressPrivateLinkGatewayStatus: + type: object + required: + - kind + description: AWS Egress Private Link Gateway details from AWS. + properties: + kind: + description: AWS Egress Private Link Gateway Status kind type. + type: string + enum: [AwsEgressPrivateLinkGatewayStatus] + principal_arn: + description: The principal ARN used by the AWS Egress Private Link Gateway. + type: string + example: arn:aws:iam::123456789012:cc-tenant-1-role + readOnly: true + networking.v1.AwsIngressPrivateLinkGatewayStatus: + type: object + required: + - kind + description: AWS Ingress Private Link Gateway details from AWS. + properties: + kind: + description: AWS Ingress Private Link Gateway Status kind type. + type: string + enum: [AwsIngressPrivateLinkGatewayStatus] + vpc_endpoint_service_name: + description: The ID of the AWS VPC Endpoint Service that can be used to + establish connections for all zones. + type: string + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + readOnly: true + networking.v1.AzureEgressPrivateLinkGatewayStatus: + type: object + required: + - kind + description: Azure Egress Private Link Gateway details from Azure. + properties: + kind: + description: Azure Egress Private Link Gateway Status kind type. + type: string + enum: [AzureEgressPrivateLinkGatewayStatus] + subscription: + type: string + description: The Azure Subscription ID associated with the Confluent Cloud + VPC. + example: 00000000-0000-0000-0000-000000000000 + readOnly: true + networking.v1.AzureIngressPrivateLinkGatewayStatus: + type: object + required: + - kind + description: Azure Ingress Private Link Gateway details from Azure. + properties: + kind: + description: Azure Ingress Private Link Gateway Status kind type. + type: string + enum: [AzureIngressPrivateLinkGatewayStatus] + private_link_service_alias: + description: Alias of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: plattg-123abc-privatelink.00000000-0000-0000-0000-000000000000.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Resource ID of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/plattg-123abc/providers/Microsoft.Network/privateLinkServices/plattg-123abc-privatelink + networking.v1.GcpPeeringGatewayStatus: + type: object + required: + - kind + description: GCP Peering Gateway details from GCP. + properties: + kind: + description: GCP Peering Gateway Status kind type. + type: string + enum: [GcpPeeringGatewayStatus] + iam_principal: + description: The IAM principal email used by the GCP Peering Gateway. + type: string + example: my-service-account@my-project.iam.gserviceaccount.com + readOnly: true + networking.v1.GcpEgressPrivateServiceConnectGatewayStatus: + type: object + required: + - kind + description: GCP Private Service Connect Gateway details from GCP. + properties: + kind: + description: GCP Private Service Connect Gateway Status kind type. + type: string + enum: [GcpEgressPrivateServiceConnectGatewayStatus] + project: + type: string + description: The GCP project used by the GCP Private Service Connect Gateway. + example: proj-tenant-1 + readOnly: true + networking.v1.GcpIngressPrivateServiceConnectGatewayStatus: + type: object + required: + - kind + description: GCP Ingress Private Service Connect Gateway details from GCP. + properties: + kind: + description: GCP Ingress Private Service Connect Gateway Status kind type. + type: string + enum: [GcpIngressPrivateServiceConnectGatewayStatus] + private_service_connect_service_attachment: + description: URI of the Private Service Connect Service Attachment in Confluent + Cloud. + type: string + readOnly: true + example: projects/traffic-prod/regions/us-central1/serviceAttachments/plattg-abc123-service-attachment +# Defaults for Network API + networking.v1.GatewayList: + type: object + description: |- + A Gateway represents a slice of traffic capacity in a region that is reserved for a customer. + + + ## The Gateways Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `gateways_per_region_per_environment` | Number of Gateways per region per environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GatewayList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/networking/v1/gateways + last: + example: https://api.confluent.cloud/networking/v1/gateways?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/networking/v1/gateways?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/networking/v1/gateways?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/networking.v1.Gateway' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - config + - environment + uniqueItems: true + networking.v1.GatewaySpec: + type: object + description: The desired state of the Gateway + properties: + display_name: + type: string + description: The name of the gateway. + example: prod-gateway + config: + type: object + description: Gateway type specific configuration. Please note that Peering + configs are not supported in Create requests. + oneOf: + - $ref: '#/components/schemas/networking.v1.AwsEgressPrivateLinkGatewaySpec' + - $ref: '#/components/schemas/networking.v1.AwsPrivateNetworkInterfaceGatewaySpec' + - $ref: '#/components/schemas/networking.v1.AwsIngressPrivateLinkGatewaySpec' + - $ref: '#/components/schemas/networking.v1.AwsPeeringGatewaySpec' + - $ref: '#/components/schemas/networking.v1.AzurePeeringGatewaySpec' + - $ref: '#/components/schemas/networking.v1.AzureEgressPrivateLinkGatewaySpec' + - $ref: '#/components/schemas/networking.v1.AzureIngressPrivateLinkGatewaySpec' + - $ref: '#/components/schemas/networking.v1.GcpPeeringGatewaySpec' + - $ref: '#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectGatewaySpec' + - $ref: '#/components/schemas/networking.v1.GcpIngressPrivateServiceConnectGatewaySpec' + discriminator: + propertyName: kind + mapping: + AwsPrivateNetworkInterfaceGatewaySpec: '#/components/schemas/networking.v1.AwsPrivateNetworkInterfaceGatewaySpec' + AwsPeeringGatewaySpec: '#/components/schemas/networking.v1.AwsPeeringGatewaySpec' + AwsEgressPrivateLinkGatewaySpec: '#/components/schemas/networking.v1.AwsEgressPrivateLinkGatewaySpec' + AwsIngressPrivateLinkGatewaySpec: '#/components/schemas/networking.v1.AwsIngressPrivateLinkGatewaySpec' + AzurePeeringGatewaySpec: '#/components/schemas/networking.v1.AzurePeeringGatewaySpec' + AzureEgressPrivateLinkGatewaySpec: '#/components/schemas/networking.v1.AzureEgressPrivateLinkGatewaySpec' + AzureIngressPrivateLinkGatewaySpec: '#/components/schemas/networking.v1.AzureIngressPrivateLinkGatewaySpec' + GcpPeeringGatewaySpec: '#/components/schemas/networking.v1.GcpPeeringGatewaySpec' + GcpEgressPrivateServiceConnectGatewaySpec: '#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectGatewaySpec' + GcpIngressPrivateServiceConnectGatewaySpec: '#/components/schemas/networking.v1.GcpIngressPrivateServiceConnectGatewaySpec' + x-immutable: true + environment: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The environment to which this belongs. + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + ccl.v1.CustomCodeLogging: + type: object + description: |- + CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Code Logging. + + + ## The Custom Code Loggings Model + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/ccl/v1/custom-code-loggings/ccl-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/custom-code-logging=ccl-12345 + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: [AWS, GCP, AZURE] + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + oneOf: + - $ref: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + environment: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The environment to which this belongs. + ccl.v1.KafkaDestinationSettings: + type: object + description: | + Kafka Destination Settings of the Custom Code Logging. + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: [Kafka] + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: The kafka cluster id where Custom Code Logging is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: [ERROR, WARN, INFO, DEBUG] + maxLength: 60 + required: + - kind + - cluster_id + - topic + + ccl.v1.CustomCodeLoggingList: + type: object + description: |- + CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Code Logging. + + + ## The Custom Code Loggings Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ccl/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLoggingList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/ccl/v1/custom-code-loggings + last: + example: https://api.confluent.cloud/ccl/v1/custom-code-loggings?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/ccl/v1/custom-code-loggings?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/ccl/v1/custom-code-loggings?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/ccl.v1.CustomCodeLogging' + - type: object + required: + - id + - metadata + - cloud + - region + - destination_settings + - environment + uniqueItems: true + tableflow.v1.Region: + type: object + description: |- + `Region` objects represent cloud provider regions where Tableflow can be enabled. + This API allows you to list all supported Tableflow regions. + + + ## The Regions Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/tableflow/v1/regions/r-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/region=r-12345 + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: [AWS] + example: AWS + x-immutable: true + readOnly: true + region: + type: string + description: The cloud service provider region. + example: us-east-2 + x-immutable: true + readOnly: true + tableflow.v1.TableflowTopic: + type: object + description: |- + A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic + + + ## The Tableflow Topics Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/tableflow/v1/tableflow-topics/tt-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/tableflow-topic=tt-12345 + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + tableflow.v1.TableflowTopicStatus: + type: object + required: + - write_mode + description: The status of the Tableflow Topic + properties: + phase: + type: string + x-extensible-enum: [PENDING, RUNNING, FAILED] + description: | + The lifecycle phase of the Tableflow: + + PENDING: Tableflow setup is pending; + + RUNNING: Tableflow is currently running; + + FAILED: Tableflow failed + example: PENDING + readOnly: true + error_message: + type: string + description: Displayable error message if Tableflow topic is in an error + state + example: Could not enable catalog integration + readOnly: true + catalog_sync_statuses: + type: array + description: | + List of associated catalogs and their synchronization statuses for this Tableflow topic. + items: + $ref: '#/components/schemas/tableflow.v1.CatalogSyncStatus' + readOnly: true + failing_table_formats: + type: array + items: + type: object + properties: + format: + type: string + description: The name of the table format (e.g., DELTA, ICEBERG). + x-extensible-enum: [DELTA, ICEBERG] + error_message: + type: string + description: The error message for the failing table format. + required: + - format + - error_message + description: | + List of failing table formats for the Tableflow-enabled topic, including error details. + example: + - format: ICEBERG + error_message: Schema validation failed + - format: DELTA + error_message: Connection timeout + readOnly: true + write_mode: + type: string + description: | + The write mode for the Tableflow-enabled topic, determining how data is written to the table. + x-extensible-enum: [APPEND, UPSERT, UPSERT_HISTORY] + example: APPEND + readOnly: true + readOnly: true + tableflow.v1.CatalogIntegration: + type: object + description: |- + A Catalog Integration represents configuration related to a catalog integration + + + ## The Catalog Integrations Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/tableflow/v1/catalog-integrations/tci-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/catalog-integration=tci-12345 + spec: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSpec' + status: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationStatus' + tableflow.v1.CatalogIntegrationStatus: + description: The status of the Catalog Integration + type: object + properties: + phase: + type: string + x-extensible-enum: [PENDING, CONNECTED, FAILED] + description: | + The lifecycle phase of the catalog integration: + + PENDING: sync to catalog integration is pending; + + CONNECTED: catalog integration is connected and syncing; + + FAILED: catalog integration failed. + example: CONNECTED + readOnly: true + error_message: + type: string + description: Displayable error message if catalog integration is in a failed + state. + example: Could not enable catalog integration + readOnly: true + last_sync_at: + type: string + description: | + The date and time at which the catalog was last synced. It is represented in RFC3339 format and is in UTC. + readOnly: true + readOnly: true + tableflow.v1.TableFlowTopicConfigsSpec: + type: object + description: The configs for the Tableflow enabled topic + properties: + enable_compaction: + description: This flag determines whether to enable compaction for the Tableflow + enabled topic. + type: boolean + example: true + x-immutable: true + readOnly: true + enable_partitioning: + description: This flag determines whether to enable partitioning for the + Tableflow enabled topic. + type: boolean + example: true + x-immutable: true + readOnly: true + retention_ms: + description: | + The maximum age, in milliseconds, of snapshots (for Iceberg) or versions (for Delta) + to retain in the table for the Tableflow-enabled topic (snapshot/version expiration). + + The default value is "604800000" milliseconds (equivalent to 7 days). + + The minimum allowed value is "86400000" milliseconds (equivalent to 24 hours). + type: string + format: int64 + example: '7776000000' + data_retention_ms: + description: | + The maximum age, in milliseconds, of data to retain in the table for the Tableflow-enabled topic. + + The minimum allowed non-zero value is "2592000000" milliseconds (equivalent to 30 days). + + Set to "0" to disable data retention (keep all data indefinitely). + type: string + format: int64 + example: '2592000000' + record_failure_strategy: + description: | + The strategy to handle record failures in the Tableflow enabled topic during materialization. + + For `SKIP`, we skip the bad records and move to the next record, + + and for `SUSPEND`, we suspend the materialization of the topic. + type: string + x-extensible-enum: [SUSPEND, SKIP] + default: SUSPEND + deprecated: true + error_handling: + type: object + description: | + The error mode to handle record failures in the Tableflow enabled topic during materialization. + + for `SKIP`, we skip the bad records and move to the next record, + + for `SUSPEND`, we suspend the materialization of the topic, + + and for `LOG`, we log the bad records to the DLQ and continue processing the rest of the records. + oneOf: + - $ref: '#/components/schemas/tableflow.v1.ErrorHandlingSuspend' + - $ref: '#/components/schemas/tableflow.v1.ErrorHandlingSkip' + - $ref: '#/components/schemas/tableflow.v1.ErrorHandlingLog' + discriminator: + propertyName: mode + mapping: + SUSPEND: '#/components/schemas/tableflow.v1.ErrorHandlingSuspend' + SKIP: '#/components/schemas/tableflow.v1.ErrorHandlingSkip' + LOG: '#/components/schemas/tableflow.v1.ErrorHandlingLog' + + tableflow.v1.ByobAwsSpec: + type: object + description: The Tableflow storage config for BYOB enabled topic in AWS + required: + - kind + - bucket_name + - provider_integration_id + properties: + kind: + type: string + enum: [ByobAws] + description: | + The storage type + x-immutable: true + bucket_name: + description: Bucket name + type: string + example: bucket_1 + x-immutable: true + bucket_region: + description: Bucket region + type: string + example: us-east-1 + x-immutable: true + readOnly: true + provider_integration_id: + type: string + description: The provider integration id + example: cspi-stgce89r7 + x-immutable: true + table_path: + type: string + description: The current storage path where the data and metadata is stored + for this table + example: s3://dummy-bucket-name-1/10011010/11101100/org-1/env-2/lkc-3/v1/tableId + readOnly: true + tableflow.v1.ManagedStorageSpec: + type: object + description: The storage config for confluent managed Tableflow enabled topic. + required: + - kind + properties: + kind: + type: string + enum: [Managed] + description: | + The storage type. + x-immutable: true + table_path: + type: string + description: The current storage path where the data and metadata is stored + for this table + example: s3://dummy-bucket-name-1/10011010/11101100/org-1/env-2/lkc-3/v1/tableId + readOnly: true + tableflow.v1.AzureAdlsSpec: + type: object + description: The Tableflow storage config for customer-owned Azure Data Lake + Storage Gen2 + required: + - kind + - storage_account_name + - container_name + - provider_integration_id + properties: + kind: + type: string + enum: [AzureDataLakeStorageGen2] + description: | + The storage type. + x-immutable: true + storage_account_name: + description: Storage Account Name + type: string + example: confluentstorage1 + x-immutable: true + container_name: + description: Container name + type: string + example: container-tableflow + x-immutable: true + storage_region: + description: Storage account region + type: string + example: centralus + readOnly: true + provider_integration_id: + type: string + description: The provider integration id + example: cspi-6nxn5 + x-immutable: true + table_path: + type: string + description: The current storage path where the data and metadata is stored + for this table + example: abfss://container@account.dfs.core.windows.net/10011010/11101100/org/env/lkc/v1/tableId + readOnly: true + tableflow.v1.CatalogIntegrationAwsGlueSpec: + type: object + description: The catalog integration Glue connection config. + required: + - kind + - provider_integration_id + properties: + kind: + type: string + enum: [AwsGlue] + description: The type of the catalog integration. + x-immutable: true + provider_integration_id: + type: string + description: The provider integration id. + example: cspi-stgce89r7 + x-immutable: true + tableflow.v1.CatalogIntegrationSnowflakeSpec: + type: object + description: The catalog integration connection config for Snowflake Open Catalog. + required: + - kind + - endpoint + - client_id + - client_secret + - warehouse + - allowed_scope + properties: + kind: + type: string + enum: [Snowflake] + description: The type of the catalog integration. + endpoint: + description: | + The catalog integration connection endpoint for Snowflake Open Catalog. + type: string + example: https://vuser1_polaris.snowflakecomputing.com/ + client_id: + description: The client ID of the catalog integration. + type: string + client_secret: + description: The client secret of the catalog integration. + type: string + warehouse: + description: Warehouse name of the Snowflake Open Catalog. + type: string + allowed_scope: + description: Allowed scope of the Snowflake Open Catalog. + type: string + tableflow.v1.CatalogIntegrationUnitySpec: + type: object + description: The catalog integration connection config for Unity Catalog. + required: + - kind + - workspace_endpoint + - catalog_name + - client_id + - client_secret + properties: + kind: + type: string + enum: [Unity] + description: The type of the catalog integration. + workspace_endpoint: + type: string + description: The Databricks workspace URL associated with the Unity Catalog. + example: https://user1.cloud.databricks.com + catalog_name: + type: string + description: The name of the catalog within Unity Catalog. + client_id: + type: string + description: The OAuth client ID used to authenticate with the Unity Catalog. + client_secret: + type: string + description: The OAuth client secret used for authentication with the Unity + Catalog. + tableflow.v1.CatalogIntegrationSnowflakeUpdateSpec: + type: object + description: The catalog integration connection config for Snowflake Open Catalog + (update operations). + required: + - kind + properties: + kind: + type: string + enum: [Snowflake] + description: The type of the catalog integration. + endpoint: + description: The catalog integration connection endpoint for Snowflake Open + Catalog. + type: string + example: https://vuser1_polaris.snowflakecomputing.com/ + client_id: + description: The client ID of the catalog integration. + type: string + client_secret: + description: The client secret of the catalog integration. + type: string + warehouse: + description: Warehouse name of the Snowflake Open Catalog. + type: string + allowed_scope: + description: Allowed scope of the Snowflake Open Catalog. + type: string + tableflow.v1.CatalogIntegrationAwsGlueUpdateSpec: + type: object + description: The catalog integration Glue connection config for update operations. + required: + - kind + properties: + kind: + type: string + enum: [AwsGlue] + description: The type of the catalog integration. + x-immutable: true + tableflow.v1.CatalogIntegrationUnityUpdateSpec: + type: object + description: The catalog integration connection config for Unity Catalog. + required: + - kind + properties: + kind: + type: string + enum: [Unity] + description: The type of the catalog integration. + workspace_endpoint: + type: string + description: The Databricks workspace URL associated with the Unity Catalog. + example: https://user1.cloud.databricks.com + catalog_name: + type: string + description: The name of the catalog within Unity Catalog. + client_id: + type: string + description: The OAuth client ID used to authenticate with the Unity Catalog. + client_secret: + type: string + description: The OAuth client secret used for authentication with the Unity + Catalog. + tableflow.v1.CatalogIntegrationUpdateRequest: + type: object + description: The desired state of the Catalog Integration + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegrationUpdateRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/tableflow/v1/catalog-integration-update-requests/ciur-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/catalog-integration-update-request=ciur-12345 + spec: + allOf: + - $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationUpdateSpec' + tableflow.v1.CatalogIntegrationUpdateSpec: + type: object + description: The desired state of the Catalog Integration + required: + - environment + - kafka_cluster + properties: + display_name: + type: string + description: The name of the catalog integration + example: catalog_integration_1 + suspended: + type: boolean + description: Indicates whether the Catalog Integration should be suspended. + example: false + config: + type: object + description: The integration config + oneOf: + - $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationAwsGlueUpdateSpec' + - $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSnowflakeUpdateSpec' + - $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationUnityUpdateSpec' + discriminator: + propertyName: kind + mapping: + AwsGlue: '#/components/schemas/tableflow.v1.CatalogIntegrationAwsGlueUpdateSpec' + Snowflake: '#/components/schemas/tableflow.v1.CatalogIntegrationSnowflakeUpdateSpec' + Unity: '#/components/schemas/tableflow.v1.CatalogIntegrationUnityUpdateSpec' + environment: + description: The environment to which the target Kafka cluster belongs. + example: + id: env-00000 + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + kafka_cluster: + description: The kafka cluster of the topic for which Tableflow is enabled + example: + id: lkc-00000 + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + tableflow.v1.ErrorHandlingSuspend: + type: object + description: | + Configuration for the `SUSPEND` error handling mode. + properties: + mode: + type: string + enum: [SUSPEND] + description: | + The error handling mode for the Tableflow enabled topic. + + In this mode, the materialization of the topic is suspended in case of record failures. + required: + - mode + tableflow.v1.ErrorHandlingSkip: + type: object + description: | + Configuration for the `SKIP` error handling mode. + properties: + mode: + type: string + enum: [SKIP] + description: | + The error handling mode for the Tableflow enabled topic. + + In this mode, the bad records are skipped and the materialization continues with the next record. + required: + - mode + tableflow.v1.ErrorHandlingLog: + type: object + description: | + Configuration for the `LOG` error handling mode. + properties: + mode: + type: string + enum: [LOG] + description: | + The error handling mode for the Tableflow enabled topic. + + In this mode, the bad records are logged to a dead-letter queue (DLQ) topic and the + + materialization continues with the next record. + target: + type: string + description: | + The topic to which the bad records will be logged in case of `LOG` error handling mode. + + Creates the topic if it doesn't already exist; otherwise, the operation is idempotent and no action is taken. + + Default topic is `error_log`. + default: error_log + required: + - mode + + tableflow.v1.CatalogSyncStatus: + type: object + description: The synchronization status of an external catalog for a Tableflow + topic + properties: + catalog_integration_id: + type: string + description: The ID of the catalog integration + example: tci-12345 + catalog_type: + type: string + description: The type of the external catalog + x-extensible-enum: [AWS_GLUE, SNOWFLAKE, UNITY] + example: AWS_GLUE + sync_status: + type: string + description: | + The current synchronization status: + + PENDING: sync is pending; + + SYNCED: successfully synced; + + FAILED: sync failed; + + DISCONNECTED: catalog integration is disconnected. + x-extensible-enum: [PENDING, SYNCED, FAILED, DISCONNECTED] + example: SYNCED + error_message: + type: string + nullable: true + description: | + Error message if the sync failed. This field is only present when `sync_status` is `FAILED`. + example: 'Failed to connect to catalog: authentication error' + + tableflow.v1.RegionList: + type: object + description: |- + `Region` objects represent cloud provider regions where Tableflow can be enabled. + This API allows you to list all supported Tableflow regions. + + + ## The Regions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RegionList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/tableflow/v1/regions + last: + example: https://api.confluent.cloud/tableflow/v1/regions?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/tableflow/v1/regions?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/tableflow/v1/regions?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/tableflow.v1.Region' + - type: object + required: + - id + - metadata + - cloud + - region + uniqueItems: true + tableflow.v1.TableflowTopicList: + type: object + description: |- + A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic + + + ## The Tableflow Topics Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopicList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/tableflow/v1/tableflow-topics + last: + example: https://api.confluent.cloud/tableflow/v1/tableflow-topics?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/tableflow/v1/tableflow-topics?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/tableflow/v1/tableflow-topics?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/tableflow.v1.TableflowTopic' + - type: object + required: + - metadata + - spec + - status + properties: + spec: + type: object + required: + - display_name + - storage + - environment + - kafka_cluster + uniqueItems: true + tableflow.v1.TableflowTopicSpec: + type: object + description: The desired state of the Tableflow Topic + properties: + display_name: + type: string + description: The name of the Kafka topic for which Tableflow is enabled. + example: topic_1 + x-immutable: true + suspended: + type: boolean + description: Indicates whether the Tableflow should be suspended. The API + allows setting it only to `false` i.e., to resume the Tableflow. Pausing + the Tableflow on-demand is not currently supported. + example: false + config: + type: object + description: The config for the Tableflow enabled topic + allOf: + - $ref: '#/components/schemas/tableflow.v1.TableFlowTopicConfigsSpec' + storage: + type: object + description: The storage config + oneOf: + - $ref: '#/components/schemas/tableflow.v1.ByobAwsSpec' + - $ref: '#/components/schemas/tableflow.v1.ManagedStorageSpec' + - $ref: '#/components/schemas/tableflow.v1.AzureAdlsSpec' + discriminator: + propertyName: kind + mapping: + ByobAws: '#/components/schemas/tableflow.v1.ByobAwsSpec' + Managed: '#/components/schemas/tableflow.v1.ManagedStorageSpec' + AzureDataLakeStorageGen2: '#/components/schemas/tableflow.v1.AzureAdlsSpec' + x-immutable: true + table_formats: + type: array + description: | + The supported table formats for the Tableflow-enabled topic. + items: + type: string + x-extensible-enum: [DELTA, ICEBERG] + minItems: 1 + uniqueItems: true + example: [DELTA] + default: [ICEBERG] + environment: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The environment to which the target Kafka cluster belongs. + kafka_cluster: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The kafka cluster of the topic for which Tableflow is enabled + x-enable-id: false + x-enable-listmeta: true + x-enable-objectmeta: true + tableflow.v1.CatalogIntegrationList: + type: object + description: |- + A Catalog Integration represents configuration related to a catalog integration + + + ## The Catalog Integrations Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegrationList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/tableflow/v1/catalog-integrations + last: + example: https://api.confluent.cloud/tableflow/v1/catalog-integrations?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/tableflow/v1/catalog-integrations?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/tableflow/v1/catalog-integrations?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/tableflow.v1.CatalogIntegration' + - type: object + required: + - id + - metadata + - spec + properties: + spec: + type: object + required: + - display_name + - config + - environment + - kafka_cluster + uniqueItems: true + tableflow.v1.CatalogIntegrationSpec: + type: object + description: The desired state of the Catalog Integration + properties: + display_name: + type: string + description: The name of the catalog integration + example: catalog_integration_1 + suspended: + type: boolean + description: Indicates whether the Catalog Integration should be suspended. + The API allows setting it only to `false` i.e., to resume the Catalog + Integration. Pausing the Catalog Integration on-demand is not currently + supported. + example: false + config: + type: object + description: The integration config + oneOf: + - $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationAwsGlueSpec' + - $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSnowflakeSpec' + - $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationUnitySpec' + discriminator: + propertyName: kind + mapping: + AwsGlue: '#/components/schemas/tableflow.v1.CatalogIntegrationAwsGlueSpec' + Snowflake: '#/components/schemas/tableflow.v1.CatalogIntegrationSnowflakeSpec' + Unity: '#/components/schemas/tableflow.v1.CatalogIntegrationUnitySpec' + environment: + allOf: + - $ref: '#/components/schemas/GlobalObjectReference' + description: The environment to which the target Kafka cluster belongs. + kafka_cluster: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The kafka cluster of the topic for which Tableflow is enabled + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + ccpm.v1.CustomConnectPlugin: + type: object + description: |- + CustomConnectPlugins objects represent Custom Connect artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugins. + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connect Plugins Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/ccpm/v1/plugins/ccp-12345?environment=env-abc123 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/custom-connect-plugin=ccp-12345 + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + ccpm.v1.PresignedUrl: + type: object + description: |- + Request a presigned upload URL for new Custom Connect Plugin. Note that + the URL policy expires in one hour. If the policy expires, you can request + a new presigned upload URL. + + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Presigned Urls Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Custom Connect Plugin archive. + example: ZIP + x-extensible-enum: [ZIP, JAR] + cloud: + type: string + description: Cloud provider where the Custom Connect Plugin archive is uploaded. + example: AWS + x-extensible-enum: [AWS, GCP, AZURE] + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Custom Connect Plugin archive. + example: https://confluent-custom-connectors-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: object + description: Upload form data of the Custom Connect Plugin. All values should + be strings. + example: + bucket: confluent-custom-connectors-stag-us-west-2 + # yamllint disable-line rule:line-length + key: staging/custom-plugin/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/connect-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/plugin.zip + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + # You can add other constraints or properties specific to this example if needed + readOnly: true + environment: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The environment to which this belongs. + ccpm.v1.CustomConnectPluginVersion: + type: object + description: |- + CustomConnectPluginVersion objects represent Custom Connect Plugin Versions on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugin Versions. + + + ## The Custom Connect Plugin Versions Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersion + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/ccpm/v1/plugins/ccp-12345/versions/ver-12345?environment=env-abc123 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/custom-connect-plugin=ccp-12345/version=ver-12345 + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionSpec' + status: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionStatus' + ccpm.v1.CustomConnectPluginVersionStatus: + type: object + required: + - phase + description: The status of the Custom Connect Plugin Version + properties: + phase: + type: string + maxLength: 50 + x-extensible-enum: [PROCESSING, READY, FAILED] + description: Phase of the Custom Connect Plugin Version. + x-immutable: true + example: PROCESSING + error_message: + type: string + maxLength: 256 + description: Displayable error message if version is in a failed state + x-immutable: true + example: Version creation failed due to invalid plugin archive. + readOnly: true + ccpm.v1.ConnectorClass: + type: object + description: | + Java class of the Connector. + properties: + class_name: + type: string + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + # yamllint disable-line rule:line-length + description: Java class or alias for connector. You can get connector class + from connector documentation provided by developer. + x-immutable: true + example: io.confluent.kafka.connect.datagen.DatagenConnector + type: + type: string + description: | + Type of the connector class. Should be either `SOURCE` or `SINK`. + example: SOURCE + x-extensible-enum: [SOURCE, SINK] + required: + - class_name + - type + + ccpm.v1.UploadSource.PresignedUrl: + type: object + description: Presigned URL of the uploaded Custom Connect Plugin archive. + properties: + location: + type: string + description: | + Location of the Custom Connect Plugin source. + x-extensible-enum: [PRESIGNED_URL_LOCATION] + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + # yamllint disable-line rule:line-length + description: Upload ID returned by the `/presigned-upload-url` API. This + field returns an empty string in all responses. + required: + - location + - upload_id + ccpm.v1.CustomConnectPluginList: + type: object + description: |- + CustomConnectPlugins objects represent Custom Connect artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugins. + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connect Plugins Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/ccpm/v1/plugins + last: + example: https://api.confluent.cloud/ccpm/v1/plugins?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/ccpm/v1/plugins?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/ccpm/v1/plugins?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/ccpm.v1.CustomConnectPlugin' + - type: object + required: + - id + - metadata + - spec + properties: + spec: + type: object + required: + - cloud + - display_name + - environment + uniqueItems: true + ccpm.v1.CustomConnectPluginSpec: + type: object + description: The desired state of the Custom Connect Plugin + properties: + cloud: + type: string + description: Cloud provider where the Custom Connect Plugin archive is uploaded. + example: AWS + x-extensible-enum: [AWS, GCP, AZURE] + x-immutable: true + display_name: + type: string + description: Display name of Custom Connect Plugin. + maxLength: 60 + description: + type: string + description: Description of Custom Connect Plugin. + maxLength: 256 + runtime_language: + type: string + example: JAVA + description: Runtime language of Custom Connect Plugin. + readOnly: true + environment: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The environment to which this belongs. + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + ccpm.v1.CustomConnectPluginVersionList: + type: object + description: |- + CustomConnectPluginVersion objects represent Custom Connect Plugin Versions on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugin Versions. + + + ## The Custom Connect Plugin Versions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersionList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/ccpm/v1/plugins/ccp-12345/versions + last: + example: https://api.confluent.cloud/ccpm/v1/plugins/ccp-12345/versions?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/ccpm/v1/plugins/ccp-12345/versions?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/ccpm/v1/plugins/ccp-12345/versions?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersion' + - type: object + required: + - id + - metadata + - spec + - status + properties: + spec: + type: object + required: + - version + - connector_classes + - upload_source + - environment + uniqueItems: true + ccpm.v1.CustomConnectPluginVersionSpec: + type: object + description: The desired state of the Custom Connect Plugin Version + properties: + version: + type: string + description: | + Version of the Custom Connect Plugin. + The version must comply with SemVer (e.g., `1.2.3`, `1.2.3-beta`, `1.2.3-rc.123`, `1.2.3-rc.123+build.456`). + maxLength: 60 + x-immutable: true + sensitive_config_properties: + type: array + description: | + A sensitive property is a connector configuration property that must be hidden after a user enters property + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: [passwords, keys, tokens] + x-immutable: true + documentation_link: + type: string + maxLength: 512 + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connect Plugin. + x-immutable: true + content_format: + type: string + example: ZIP + description: Archive format of Custom Connect Plugin. + x-extensible-enum: [ZIP, JAR] + readOnly: true + connector_classes: + type: array + description: | + List of connector classes. + The connector class must be a valid Java class name or alias for the connector. + You can get the connector class from the connector documentation provided by the developer. + items: + $ref: '#/components/schemas/ccpm.v1.ConnectorClass' + minItems: 1 + maxItems: 10 + x-immutable: true + upload_source: + type: object + oneOf: + - $ref: '#/components/schemas/ccpm.v1.UploadSource.PresignedUrl' + description: | + Upload source of Custom Connect Plugin Version. Only required in `create` request, + will be ignored in `read`, `update` or `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/ccpm.v1.UploadSource.PresignedUrl' + x-immutable: true + environment: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The environment to which this belongs. + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + usm.v1.KafkaCluster: + type: object + description: |- + `KafkaCluster` object represent Confluent Platform Kafka clusters registered with Confluent Cloud. + The API allows you to create and delete KafkaCluster. + + + ## The Kafka Clusters Model + + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaCluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + description: A human-readable name for the Confluent Platform Kafka cluster. + example: My-Prod-CP-Cluster + confluent_platform_kafka_cluster_id: + type: string + description: The unique identifier of the Kafka cluster within the Confluent + Platform environment. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: The cloud service provider where the metadata for the Kafka + Cluster should be stored. + x-extensible-enum: [AWS, GCP, AZURE] + example: AWS + x-immutable: true + region: + type: string + description: The home region of the Confluent Platform Kafka cluster where + the metadata should be stored. + example: us-east-1 + x-immutable: true + environment: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The environment to which this belongs. + x-immutable: true + usm.v1.ConnectCluster: + type: object + description: |- + `ConnectCluster` object represent Confluent Platform Connect clusters registered with Confluent Cloud. + The API allows you to create and delete ConnectCluster. + + + ## The Connect Clusters Model + + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectCluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + confluent_platform_connect_cluster_id: + type: string + description: The unique identifier of the Connect cluster within the Confluent + Platform environment. + example: connect-group-xyz123 + x-immutable: true + kafka_cluster_id: + type: string + description: | + The unique identifier of the metadata Kafka cluster for the Connect Cluster. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: | + The cloud service provider where the metadata for the Connect Cluster should be stored. + This field is optional. If provided, 'region' must also be provided. + If neither 'cloud' nor 'region' are provided, the cloud provider of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + x-extensible-enum: [AWS, GCP, AZURE] + example: AWS + x-immutable: true + region: + type: string + description: | + The home region of the Confluent Platform Connect cluster where the metadata should be stored. + This field is optional. If provided, 'cloud' must also be provided. + If neither 'cloud' nor 'region' are provided, the home region of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + example: us-east-1 + x-immutable: true + environment: + allOf: + - $ref: '#/components/schemas/EnvScopedObjectReference' + description: The environment to which this belongs. + x-immutable: true + usm.v1.KafkaClusterList: + type: object + description: |- + `KafkaCluster` object represent Confluent Platform Kafka clusters registered with Confluent Cloud. + The API allows you to create and delete KafkaCluster. + + + ## The Kafka Clusters Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaClusterList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/usm/v1/kafka-clusters + last: + example: https://api.confluent.cloud/usm/v1/kafka-clusters?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/usm/v1/kafka-clusters?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/usm/v1/kafka-clusters?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/usm.v1.KafkaCluster' + - type: object + required: + - id + - display_name + - confluent_platform_kafka_cluster_id + - cloud + - region + - environment + uniqueItems: true + usm.v1.ConnectClusterList: + type: object + description: |- + `ConnectCluster` object represent Confluent Platform Connect clusters registered with Confluent Cloud. + The API allows you to create and delete ConnectCluster. + + + ## The Connect Clusters Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectClusterList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/usm/v1/connect-clusters + last: + example: https://api.confluent.cloud/usm/v1/connect-clusters?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/usm/v1/connect-clusters?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/usm/v1/connect-clusters?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/usm.v1.ConnectCluster' + - type: object + required: + - id + - confluent_platform_connect_cluster_id + - kafka_cluster_id + - environment + uniqueItems: true + endpoint.v1.Endpoint: + type: object + description: |- + An Endpoint object represents a Fully Qualified Domain Name (FQDN) for a Confluent service resource + via a specific networking solution for a given Confluent Cloud environment. + This API provides a list of Confluent Cloud endpoints filtered by service, cloud provider, region, etc. + + + Related guides: + * [Resource Overview in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/resource-overview.html). + * [Manage Networking on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Endpoints Model + + properties: + api_version: + type: string + enum: + - endpoint/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Endpoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; + it is normally unique across time but not space. That is, you can assume + that the ID will not be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + allOf: + - $ref: '#/components/schemas/ObjectMeta' + - properties: + self: + example: https://api.confluent.cloud/endpoint/v1/endpoints/e-12345 + resource_name: + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/endpoint=e-12345 + cloud: + type: string + description: The cloud service provider. + x-extensible-enum: [AWS, GCP, AZURE] + example: AWS + readOnly: true + region: + type: string + description: The cloud service provider region in which the resource is + located. + example: us-west-2 + readOnly: true + service: + type: string + description: The Confluent Cloud service. + x-extensible-enum: [KAFKA, SCHEMA_REGISTRY, FLINK] + example: KAFKA + readOnly: true + is_private: + type: boolean + description: Whether the endpoint is private (true) or public (false). + example: true + readOnly: true + connection_type: + type: string + description: The network connection type. + x-extensible-enum: [PUBLIC, PRIVATE_LINK, PEERING, TRANSIT_GATEWAY, PRIVATE_NETWORK_INTERFACE] + example: PRIVATE_LINK + readOnly: true + endpoint: + type: string + description: The endpoint URL or address. + example: https://lkc-abc123-ap12345.us-west-2.aws.accesspoint.glb.confluent.cloud:443 + readOnly: true + endpoint_type: + type: string + description: | + The endpoint type enum values: + * `REST` - REST API endpoint for HTTP/HTTPS access, used by Kafka/Flink/Schema Registry services. + * `BOOTSTRAP` - Kafka native protocol bootstrap servers for direct client connections, used by Kafka only. + * `LANGUAGE_SERVICE` - Flink language service endpoint for SQL/Table API, used by Flink only. + x-extensible-enum: [REST, BOOTSTRAP, LANGUAGE_SERVICE] + readOnly: true + environment: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The environment to which this belongs. + resource: + allOf: + - $ref: '#/components/schemas/TypedEnvScopedObjectReference' + description: | + The resource associated with the endpoint. + The resource can be one of Kafka Cluster ID (example: lkc-12345), + or Schema Registry Cluster ID (example: lsrc-12345). + May be null or omitted if not associated with a resource. + gateway: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The gateway to which this belongs. + access_point: + allOf: + - $ref: '#/components/schemas/ObjectReference' + description: The access_point to which this belongs. + endpoint.v1.EndpointList: + type: object + description: |- + An Endpoint object represents a Fully Qualified Domain Name (FQDN) for a Confluent service resource + via a specific networking solution for a given Confluent Cloud environment. + This API provides a list of Confluent Cloud endpoints filtered by service, cloud provider, region, etc. + + + Related guides: + * [Resource Overview in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/resource-overview.html). + * [Manage Networking on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Endpoints Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - endpoint/v1 + description: APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - EndpointList + metadata: + allOf: + - $ref: '#/components/schemas/ListMeta' + - properties: + first: + example: https://api.confluent.cloud/endpoint/v1/endpoints + last: + example: https://api.confluent.cloud/endpoint/v1/endpoints?page_token=bcAOehAY8F16YD84Z1wT + prev: + example: https://api.confluent.cloud/endpoint/v1/endpoints?page_token=YIXRY97wWYmwzrax4dld + next: + example: https://api.confluent.cloud/endpoint/v1/endpoints?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each + entry in the array is a separate resource. + items: + allOf: + - $ref: '#/components/schemas/endpoint.v1.Endpoint' + - type: object + required: + - id + - metadata + - cloud + - region + - service + - is_private + - connection_type + - endpoint + - endpoint_type + - environment + uniqueItems: true + securitySchemes: + cloud-api-key: + type: http + scheme: basic + description: Authenticate with Cloud API Keys using HTTP Basic Auth. Treat the + Cloud API Key ID as the username and Cloud API Key Secret as the password. + confluent-sts-access-token: + type: oauth2 + description: Authenticate with Confluent API using this credentials (JSON Web + Tokens) following OAuth 2.0. + flows: + clientCredentials: + tokenUrl: https://api.confluent.cloud/sts/v1/oauth2/token + scopes: {} + resource-api-key: + type: http + scheme: basic + description: |- + Authenticate with resource-specific API Keys using HTTP Basic Auth. Treat the resource-specific API Key ID as the username and resource-specific API Key Secret as the password. + external-access-token: + type: oauth2 + description: Authenticate with OAuth 2.0. + flows: + clientCredentials: + tokenUrl: https:///token + scopes: {} + oauth: + type: oauth2 + description: Authenticate with OAuth 2.0. Currently this is only supported for + partner APIs. + flows: + clientCredentials: + tokenUrl: /oauth2/token + scopes: + partner:alter: enables partners to alter entitlements + partner:create: enables partners to create entitlements and signup on + behalf of customers + partner:delete: enables partners to delete entitlements and organizations + partner:describe: enables partners to read and list entitlements and organizations + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + OverQuotaError: + x-summary: Over Quota + description: The request would exceed one or more quotas. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '402' + code: quota_exceeded + title: Kafka Clusters Per Org Quota Exceeded + detail: 'The request would exceed the quota: kafka_clusters_per_environment' + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource + without the 'plutonium' role. + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: "The property '/cluster/storage_size' of type string did not\ + \ match the following type: integer" + source: + pointer: /cluster/storage_size + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per + time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: "The relative time in seconds until the current rate-limit\ + \ window resets. \n \n**Important:** This differs from Github and Twitter's\ + \ same-named header which uses UTC epoch seconds. We use relative time\ + \ to avoid client/server time synchronization issues." + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + connect.v1.UnauthenticatedError: + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 401 + message: Unauthorized + connect.v1.ForbiddenError: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 403 + message: Forbidden + connect.v1.AccountNotFoundError: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 404 + message: account not found + connect.v1.ResourceNotFoundError: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 404 + message: resource not found + connect.v1.DefaultSystemError: + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 500 + message: Oops, something went wrong + connect.v1.BadRequestError: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 400 + message: Bad Request + connect.v1.OK: + description: OK + content: + application/json: + schema: + type: object + properties: + error: + type: object + nullable: true + example: + error: + CreateTopicResponse: + description: The created topic. + content: + application/json: + schema: + $ref: '#/components/schemas/TopicData' + example: + kind: KafkaTopic + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X + resource_name: crn:///kafka=cluster-1/topic=topic-X + cluster_id: cluster-1 + topic_name: topic-X + is_internal: false + replication_factor: 3 + partitions_count: 1 + partitions: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X/partitions + configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X/configs + partition_reassignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X/partitions/-/reassignments + + DeleteAclsResponse: + description: The list of deleted ACLs. + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/AclData' + example: + data: + - kind: KafkaAcl + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=TOPIC&resource_name=topic-&pattern_type=PREFIXED&principal=User%3Aalice&host=*&operation=ALL&permission=ALLOW + cluster_id: cluster-1 + resource_type: TOPIC + resource_name: topic- + pattern_type: PREFIXED + principal: User:alice + host: '*' + operation: ALL + permission: ALLOW + - kind: KafkaAcl + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=CLUSTER&resource_name=kafka-cluster&pattern_type=LITERAL&principal=User%3Aalice&host=*&operation=DESCRIBE&permission=DENY + cluster_id: cluster-1 + resource_type: CLUSTER + resource_name: kafka-cluster + pattern_type: LITERAL + principal: User:alice + host: '*' + operation: DESCRIBE + permission: DENY + + GetBrokerConfigResponse: + description: The broker configuration parameter. + content: + application/json: + schema: + $ref: '#/components/schemas/BrokerConfigData' + example: + kind: KafkaBrokerConfig + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1/configs/compression.type + resource_name: crn:///kafka=cluster-1/broker=1/config=compression.type + cluster_id: cluster-1 + broker_id: 1 + name: compression.type + value: gzip + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_BROKER_CONFIG + synonyms: + - name: compression.type + value: gzip + source: DYNAMIC_BROKER_CONFIG + - name: compression.type + value: producer + source: DEFAULT_CONFIG + + GetBrokerResponse: + description: The broker. + content: + application/json: + schema: + $ref: '#/components/schemas/BrokerData' + example: + kind: KafkaBroker + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + resource_name: crn:///kafka=cluster-1/broker=1 + cluster_id: cluster-1 + broker_id: 1 + host: localhost + port: 9291 + configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1/configs + partition_replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1/partition-replicas + + GetClusterConfigResponse: + description: The cluster configuration parameter. + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterConfigData' + example: + kind: KafkaClusterConfig + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type + resource_name: crn:///kafka=cluster-1/broker-config=compression.type + cluster_id: cluster-1 + config_type: BROKER + name: compression.type + value: gzip + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_DEFAULT_BROKER_CONFIG + synonyms: + - name: compression.type + value: gzip + source: DYNAMIC_DEFAULT_BROKER_CONFIG + - name: compression.type + value: producer + source: DEFAULT_CONFIG + + GetClusterResponse: + description: The Kafka cluster. + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterData' + example: + kind: KafkaCluster + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1 + resource_name: crn:///kafka=cluster-1 + cluster_id: cluster-1 + controller: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + acls: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls + brokers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers + broker_configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs + consumer_groups: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups + topics: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics + partition_reassignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/-/partitions/-/reassignment + + GetConsumerAssignmentResponse: + description: The consumer group assignment. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerAssignmentData' + example: + kind: KafkaConsumerAssignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1/assignments/topic-1/partitions/1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-1/assignment=topic=1/partition=1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-1 + topic_name: topic-1 + partition_id: 1 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + lag: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/1 + + GetConsumerGroupResponse: + description: The consumer group. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerGroupData' + example: + kind: KafkaConsumerGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + is_simple: false + partition_assignor: org.apache.kafka.clients.consumer.RoundRobinAssignor + state: STABLE + type: CLASSIC + is_mixed_consumer_group: false + coordinator: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + consumers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers + lag_summary: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary + + GetConsumerGroupLagSummaryResponse: + description: The max and total consumer lag in a consumer group. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerGroupLagSummaryData' + example: + kind: KafkaConsumerGroupLagSummary + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary + resource_name: crn:///kafka=cluster-1/consumer-groups=consumer-group-1/lag-summary + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + max_lag_consumer_id: consumer-1 + max_lag_instance_id: consumer-instance-1 + max_lag_client_id: client-1 + max_lag_topic_name: topic-1 + max_lag_partition_id: 1 + max_lag: 100 + total_lag: 110 + max_lag_consumer: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1 + max_lag_partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + + GetConsumerLagResponse: + description: The consumer lag. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerLagData' + example: + kind: KafkaConsumerLag + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + topic_name: topic-1 + partition_id: 1 + consumer_id: consumer-1 + instance_id: consumer-instance-1 + client_id: client-1 + current_offset: 1 + log_end_offset: 101 + lag: 100 + + GetConsumerResponse: + description: The consumer. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerData' + example: + kind: KafkaConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-1 + instance_id: consumer-instance-1 + client_id: client-1 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1/assignments + + GetPartitionResponse: + description: The partition + content: + application/json: + schema: + $ref: '#/components/schemas/PartitionData' + example: + kind: KafkaPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=1 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + leader: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas/1 + replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas + reassignment: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/reassignment + + GetReassignmentResponse: + description: The ongoing replicas reassignments. + content: + application/json: + schema: + $ref: '#/components/schemas/ReassignmentData' + example: + kind: KafkaReassignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/reassignment + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=1/reassignment + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + adding_replicas: + - 1 + - 2 + removing_replicas: + - 3 + replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas + + GetReplicaResponse: + description: The replica. + content: + application/json: + schema: + $ref: '#/components/schemas/ReplicaData' + example: + kind: KafkaReplica + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas/1 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=1/replica=1 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + broker_id: 1 + is_leader: true + is_in_sync: true + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + + GetShareGroupResponse: + description: The share group. + content: + application/json: + schema: + $ref: '#/components/schemas/ShareGroupData' + example: + kind: KafkaShareGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1 + cluster_id: cluster-1 + share_group_id: share-group-1 + state: STABLE + coordinator: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + consumers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers + consumer_count: 2 + partition_count: 3 + assigned_topic_partitions: + - kind: KafkaShareGroupTopicPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/assigned-topic-partitions/topic-1/0 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/topic-partition=topic-1:0 + topic_name: topic-1 + partition_id: 0 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0 + - kind: KafkaShareGroupTopicPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/assigned-topic-partitions/topic-1/1 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/topic-partition=topic-1:1 + topic_name: topic-1 + partition_id: 1 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + + GetShareGroupConsumerResponse: + description: The consumer. + content: + application/json: + schema: + $ref: '#/components/schemas/ShareGroupConsumerData' + example: + kind: KafkaShareGroupConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-1 + client_id: client-1 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments + + GetTopicConfigResponse: + description: The topic configuration parameter. + content: + application/json: + schema: + $ref: '#/components/schemas/TopicConfigData' + example: + kind: KafkaTopicConfig + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/compression.type + resource_name: crn:///kafka=cluster-1/topic=topic-1/config=compression.type + cluster_id: cluster-1 + topic_name: topic-1 + name: compression.type + value: gzip + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_TOPIC_CONFIG + synonyms: + - name: compression.type + value: gzip + source: DYNAMIC_TOPIC_CONFIG + - name: compression.type + value: producer + source: DEFAULT_CONFIG + + GetTopicResponse: + description: The topic. + content: + application/json: + schema: + $ref: '#/components/schemas/TopicData' + example: + kind: KafkaTopic + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1 + resource_name: crn:///kafka=cluster-1/topic=topic-1 + cluster_id: cluster-1 + topic_name: topic-1 + is_internal: false + replication_factor: 3 + partitions_count: 1 + partitions: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions + configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs + partition_reassignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/-/reassignments + + ListAllReassignmentsResponse: + description: The ongoing replicas reassignments. + content: + application/json: + schema: + $ref: '#/components/schemas/ReassignmentDataList' + example: + kind: KafkaReassignmentList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/-/partitions/-/reassignment + next: + data: + - kind: KafkaReassignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/reassignment + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=1/reassignment + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + adding_replicas: + - 1 + - 2 + removing_replicas: + - 3 + replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas + - kind: KafkaReassignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions/2/reassignment + resource_name: crn:///kafka=cluster-1/topic=topic-2/partition=2/reassignment + cluster_id: cluster-1 + topic_name: topic-2 + partition_id: 2 + adding_replicas: + - 1 + removing_replicas: + - 2 + - 3 + replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions/2/replicas + - kind: KafkaReassignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions/3/reassignment + resource_name: crn:///kafka=cluster-1/topic=topic-3/partition=3/reassignment + cluster_id: cluster-1 + topic_name: topic-3 + partition_id: 3 + adding_replicas: + - 3 + removing_replicas: + - 1 + - 2 + replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions/3/replicas + + ListBrokerConfigsResponse: + description: The list of broker configs. + content: + application/json: + schema: + $ref: '#/components/schemas/BrokerConfigDataList' + example: + kind: KafkaBrokerConfigList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1/configs + next: + data: + - kind: KafkaBrokerConfig + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1/configs/max.connections + resource_name: crn:///kafka=cluster-1/broker=1/config=max.connections + cluster_id: cluster-1 + broker_id: 1 + name: max.connections + value: '1000' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_BROKER_CONFIG + synonyms: + - name: max.connections + value: '1000' + source: DYNAMIC_BROKER_CONFIG + - name: max.connections + value: '2147483647' + source: DEFAULT_CONFIG + - kind: KafkaBrokerConfig + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1/configs/compression.type + resource_name: crn:///kafka=cluster-1/broker=1/config=compression.type + cluster_id: cluster-1 + broker_id: 1 + name: compression.type + value: gzip + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_BROKER_CONFIG + synonyms: + - name: compression.type + value: gzip + source: DYNAMIC_BROKER_CONFIG + - name: compression.type + value: producer + source: DEFAULT_CONFIG + + ListBrokersResponse: + description: The list of brokers. + content: + application/json: + schema: + $ref: '#/components/schemas/BrokerDataList' + example: + kind: KafkaBrokerList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers + next: + data: + - kind: KafkaBroker + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + resource_name: crn:///kafka=cluster-1/broker=1 + cluster_id: cluster-1 + broker_id: 1 + host: localhost + port: 9291 + configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1/configs + partition_replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1/partition-replicas + - kind: KafkaBroker + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 + resource_name: crn:///kafka=cluster-1/broker=2 + cluster_id: cluster-1 + broker_id: 2 + host: localhost + port: 9292 + configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2/configs + partition_replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2/partition-replicas + - kind: KafkaBroker + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/3 + resource_name: crn:///kafka=cluster-1/broker=3 + cluster_id: cluster-1 + broker_id: 3 + host: localhost + port: 9293 + configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/3/configs + partition_replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/3/partition-replicas + + ListClusterConfigsResponse: + description: The list of cluster configs. + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterConfigDataList' + example: + kind: KafkaClusterConfigList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs + next: + data: + - kind: KafkaClusterConfig + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/max.connections + resource_name: crn:///kafka=cluster-1/broker-config=max.connections + cluster_id: cluster-1 + config_type: BROKER + name: max.connections + value: '1000' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_DEFAULT_BROKER_CONFIG + synonyms: + - name: max.connections + value: '1000' + source: DYNAMIC_DEFAULT_BROKER_CONFIG + - name: max.connections + value: '2147483647' + source: DEFAULT_CONFIG + - kind: KafkaClusterConfig + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type + resource_name: crn:///kafka=cluster-1/broker-config=compression.type + cluster_id: cluster-1 + config_type: BROKER + name: compression.type + value: gzip + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_DEFAULT_BROKER_CONFIG + synonyms: + - name: compression.type + value: gzip + source: DYNAMIC_DEFAULT_BROKER_CONFIG + - name: compression.type + value: producer + source: DEFAULT_CONFIG + + ListClustersResponse: + description: The list of Kafka clusters. + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterDataList' + example: + kind: KafkaClusterList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters + next: + data: + - kind: KafkaCluster + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1 + resource_name: crn:///kafka=cluster-1 + cluster_id: cluster-1 + controller: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + acls: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls + brokers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers + broker_configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs + consumer_groups: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups + topics: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics + partition_reassignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/-/partitions/-/reassignment + + ListConsumerAssignmentsResponse: + description: The list of consumer group assignments. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerAssignmentDataList' + example: + kind: KafkaConsumerAssignmentList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1/assignments + next: + data: + - kind: KafkaConsumerAssignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1/assignments/topic-1/partitions/1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-1/assignment=topic=1/partition=1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-1 + topic_name: topic-1 + partition_id: 1 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + lag: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/1 + - kind: KafkaConsumerAssignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1/assignments/topic-2/partitions/2 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-1/assignment=topic=2/partition=2 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-1 + topic_name: topic-2 + partition_id: 2 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions/2 + lag: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-2/partitions/2 + - kind: KafkaConsumerAssignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1/assignments/topic-3/partitions/3 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-1/assignment=topic=3/partition=3 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-1 + topic_name: topic-3 + partition_id: 3 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions/3 + lag: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-3/partitions/3 + + ListConsumerGroupsResponse: + description: The list of consumer groups. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerGroupDataList' + example: + kind: KafkaConsumerGroupList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups + next: + data: + - kind: KafkaConsumerGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + is_simple: false + partition_assignor: org.apache.kafka.clients.consumer.RoundRobinAssignor + state: STABLE + type: CLASSIC + is_mixed_consumer_group: false + coordinator: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + consumers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers + lag_summary: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary + - kind: KafkaConsumerGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-2 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-2 + cluster_id: cluster-1 + consumer_group_id: consumer-group-2 + is_simple: false + partition_assignor: org.apache.kafka.clients.consumer.StickyAssignor + state: PREPARING_REBALANCE + type: CLASSIC + is_mixed_consumer_group: false + coordinator: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 + consumers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-2/consumers + lag_summary: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-2/lag-summary + - kind: KafkaConsumerGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-3 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-3 + cluster_id: cluster-1 + consumer_group_id: consumer-group-3 + is_simple: false + partition_assignor: org.apache.kafka.clients.consumer.RangeAssignor + state: DEAD + type: CLASSIC + is_mixed_consumer_group: false + coordinator: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/3 + consumers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-3/consumers + lag_summary: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-3/lag-summary + + ListConsumerLagsResponse: + description: The list of consumer lags. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerLagDataList' + example: + kind: KafkaConsumerLagList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags + next: + data: + - kind: KafkaConsumerLag + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + topic_name: topic-1 + partition_id: 1 + consumer_id: consumer-1 + instance_id: consumer-instance-1 + client_id: client-1 + current_offset: 1 + log_end_offset: 101 + lag: 100 + - kind: KafkaConsumerLag + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/2 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=2 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + topic_name: topic-1 + partition_id: 2 + consumer_id: consumer-2 + instance_id: consumer-instance-2 + client_id: client-2 + current_offset: 1 + log_end_offset: 11 + lag: 10 + - kind: KafkaConsumerLag + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/3 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=3 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + topic_name: topic-1 + partition_id: 3 + consumer_id: consumer-3 + instance_id: consumer-instance-3 + client_id: client-3 + current_offset: 1 + log_end_offset: 1 + lag: 0 + + ListConsumersResponse: + description: The list of consumers. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerDataList' + example: + kind: KafkaConsumerList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers + next: + data: + - kind: KafkaConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-1 + instance_id: consumer-instance-1 + client_id: client-1 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1/assignments + - kind: KafkaConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-2 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-2 + instance_id: consumer-instance-2 + client_id: client-2 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2/assignments + - kind: KafkaConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-2 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-2 + instance_id: consumer-instance-2 + client_id: client-2 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2/assignments + + ListPartitionsResponse: + description: The list of partitions. + content: + application/json: + schema: + $ref: '#/components/schemas/PartitionDataList' + example: + kind: KafkaPartitionList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions + next: + data: + - kind: KafkaPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=1 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + leader: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas/1 + replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas + reassignment: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/reassignment + - kind: KafkaPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=2 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 2 + leader: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/replicas/2 + replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/replicas + reassignment: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/reassignment + - kind: KafkaPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=3 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 3 + leader: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/replicas/3 + replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/replicas + reassignment: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/reassignment + + ListReplicasResponse: + description: The list of replicas. + content: + application/json: + schema: + $ref: '#/components/schemas/ReplicaDataList' + example: + kind: KafkaReplicaList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas + next: + data: + - kind: KafkaReplica + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas/1 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=1/replica=1 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + broker_id: 1 + is_leader: true + is_in_sync: true + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + - kind: KafkaReplica + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas/2 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=1/replica=2 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + broker_id: 2 + is_leader: false + is_in_sync: true + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 + - kind: KafkaReplica + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas/3 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=1/replica=3 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + broker_id: 3 + is_leader: false + is_in_sync: false + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/3 + + ListShareGroupConsumerAssignmentsResponse: + description: The list of share group assignments. + content: + application/json: + schema: + $ref: '#/components/schemas/ShareGroupConsumerAssignmentDataList' + example: + kind: KafkaConsumerAssignmentList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments + next: + data: + - kind: KafkaShareGroupConsumerAssignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments/topic-1/partitions/1 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1/assignment=topic=1/partition=1 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-1 + topic_name: topic-1 + partition_id: 1 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + - kind: KafkaShareGroupConsumerAssignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments/topic-2/partitions/2 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1/assignment=topic=2/partition=2 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-1 + topic_name: topic-2 + partition_id: 2 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions/2 + - kind: KafkaShareGroupConsumerAssignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments/topic-3/partitions/3 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1/assignment=topic=3/partition=3 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-1 + topic_name: topic-3 + partition_id: 3 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions/3 + + ListShareGroupsResponse: + description: The list of share groups. + content: + application/json: + schema: + $ref: '#/components/schemas/ShareGroupDataList' + example: + kind: KafkaShareGroupList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups + next: + data: + - kind: KafkaShareGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1 + cluster_id: cluster-1 + share_group_id: share-group-1 + state: STABLE + coordinator: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + consumers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers + consumer_count: 2 + partition_count: 3 + assigned_topic_partitions: + - kind: KafkaShareGroupTopicPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/assigned-topic-partitions/topic-1/0 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/topic-partition=topic-1:0 + topic_name: topic-1 + partition_id: 0 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0 + - kind: KafkaShareGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-2 + resource_name: crn:///kafka=cluster-1/share-group=share-group-2 + cluster_id: cluster-1 + share_group_id: share-group-2 + state: EMPTY + coordinator: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 + consumers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-2/consumers + consumer_count: 2 + partition_count: 3 + assigned_topic_partitions: + - kind: KafkaShareGroupTopicPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-2/assigned-topic-partitions/topic-1/0 + resource_name: crn:///kafka=cluster-1/share-group=share-group-2/topic-partition=topic-1:0 + topic_name: topic-1 + partition_id: 0 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0 + + ListShareGroupConsumersResponse: + description: The list of consumers. + content: + application/json: + schema: + $ref: '#/components/schemas/ShareGroupConsumerDataList' + example: + kind: KafkaShareConsumerList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers + next: + data: + - kind: KafkaShareGroupConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-1 + client_id: client-1 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments + - kind: KafkaShareGroupConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-2 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-2 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-2 + client_id: client-2 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-2/assignments + - kind: KafkaShareGroupConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-3 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-3 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-3 + client_id: client-3 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-3/assignments + + ListGroupConfigsResponse: + description: Config name and value for group configurations. + content: + application/json: + schema: + $ref: '#/components/schemas/GroupConfigDataList' + example: + kind: KafkaGroupConfigDataList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs + next: + data: + - kind: KafkaGroupConfigData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs/share.session.timeout.ms + resource_name: crn:///kafka=cluster-1/group=group-1/config=share.session.timeout.ms + cluster_id: cluster-1 + group_id: group-1 + name: share.session.timeout.ms + value: '45000' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_GROUP_CONFIG + synonyms: + - name: share.session.timeout.ms + value: '45000' + source: DYNAMIC_GROUP_CONFIG + - name: share.session.timeout.ms + value: '30000' + source: DEFAULT_CONFIG + - kind: KafkaGroupConfigData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs/share.heartbeat.interval.ms + resource_name: crn:///kafka=cluster-1/group=group-1/config=share.heartbeat.interval.ms + cluster_id: cluster-1 + group_id: group-1 + name: share.heartbeat.interval.ms + value: + is_default: true + is_read_only: false + is_sensitive: false + source: DEFAULT_CONFIG + synonyms: + - name: share.heartbeat.interval.ms + value: '3000' + source: DEFAULT_CONFIG + + GetGroupConfigResponse: + description: Config name and value for group configuration. + content: + application/json: + schema: + $ref: '#/components/schemas/GroupConfigData' + example: + kind: KafkaGroupConfigData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs/share.session.timeout.ms + resource_name: crn:///kafka=cluster-1/group=group-1/config=share.session.timeout.ms + cluster_id: cluster-1 + group_id: group-1 + name: share.session.timeout.ms + value: '45000' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_GROUP_CONFIG + synonyms: + - name: share.session.timeout.ms + value: '45000' + source: DYNAMIC_GROUP_CONFIG + - name: share.session.timeout.ms + value: '30000' + source: DEFAULT_CONFIG + + ListStreamsGroupsResponse: + description: The list of streams groups. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupDataList' + example: + kind: KafkaStreamsGroupList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups + next: + data: + - kind: KafkaStreamsGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1 + cluster_id: cluster-1 + group_id: streams-group-1 + group_epoch: 1 + target_assignment_epoch: 1 + topology_epoch: 1 + state: STABLE + member_count: 2 + subtopology_count: 1 + members: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members + subtopologies: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/subtopologies + + GetStreamsGroupResponse: + description: The streams group. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupData' + example: + kind: KafkaStreamsGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1 + cluster_id: cluster-1 + group_id: streams-group-1 + group_epoch: 1 + target_assignment_epoch: 1 + topology_epoch: 1 + state: STABLE + member_count: 2 + subtopology_count: 1 + members: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members + subtopologies: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/subtopologies + + ListStreamsGroupSubtopologiesResponse: + description: The list of subtoplogies of the streams group + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupSubtopologyDataList' + example: + kind: KafkaStreamsGroupSubtopologyList + metadata: + self: http://localhost:8082/v3/clusters/cluster-1/streams-groups/streams-group-1/subtopologies + data: + - kind: KafkaStreamsSubtopology + metadata: + self: http://localhost:8082/v3/clusters/cluster-1/streams-groups/streams-group-1/subtopologies/subtopology-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/subtopology=subtopology-1 + cluster_id: cluster-1 + group_id: streams-group-1 + subtopology_id: subtopology-1 + source_topics: [topic-1, topic-2] + + GetStreamsGroupSubtopologyResponse: + description: The streams group subtopology. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupSubtopologyData' + example: + kind: KafkaStreamsGroupSubtopology + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/subtopologies/subtopology-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/subtopology=subtopology-1 + cluster_id: cluster-1 + group_id: streams-group-1 + subtopology_id: subtopology-1 + source_topics: [topic-1, topic-2] + ListStreamsGroupMembersResponse: + description: The list of members of the streams group + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupMemberDataList' + example: + kind: KafkaStreamsGroupMemberList + metadata: + self: http://localhost:8082/v3/clusters/cluster-1/streams-groups/streams-group-1/members + data: + - kind: KafkaStreamsMember + metadata: + self: http://localhost:8082/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1 + cluster_id: cluster-1 + group_id: streams-group-1 + member_id: member-1 + process_id: process-1 + client_id: client-1 + instance_id: instance-1 + member_epoch: 2 + topology_epoch: 1 + is_classic: false + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments + target_assignment: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/target-assignment + + + GetStreamsGroupMemberResponse: + description: The streams group member. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupMemberData' + example: + kind: KafkaStreamsGroupMember + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1 + cluster_id: cluster-1 + group_id: streams-group-1 + member_id: member-1 + process_id: process-1 + client_id: client-1 + instance_id: instance-1 + member_epoch: 2 + topology_epoch: 1 + is_classic: false + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments + target_assignment: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/target-assignment + + GetStreamsGroupMemberAssignmentsResponse: + description: The streams group member assignments. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupMemberAssignmentData' + example: + kind: KafkaStreamsGroupMemberAssignments + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1/assignments + cluster_id: cluster-1 + group_id: streams-group-1 + member_id: member-1 + active_tasks: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments/active + standby_tasks: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignment/standby + warmup_tasks: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignment/warmup + + ListStreamsTasksResponse: + description: The streams group member assignments of specific type. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsTaskDataList' + example: + kind: KafkaStreamsGroupMemberAssignments + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments/active/subtopologies/subtopology-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1/assignments=active/subtopology=subtopology-1 + data: + - kind: GetStreamsTaskResponse + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments/active/subtopologies/subtopology-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1/assignments=active/subtopology=subtopology-1 + subtopology_id: subtopology-1 + partition_ids: [0, 1, 2] + + GetStreamsTaskResponse: + description: The partitions of a streams member task. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsTaskData' + example: + kind: KafkaStreamsGroupMemberAssignments + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments/active/subtopologies/subtopology-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1/assignments=active/subtopology=subtopology-1 + subtopology_id: subtopology-1 + partition_ids: [0, 1, 2] + ListTopicConfigsResponse: + description: The list of cluster configs. + content: + application/json: + schema: + $ref: '#/components/schemas/TopicConfigDataList' + example: + kind: KafkaTopicConfigList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs + next: + data: + - kind: KafkaTopicConfig + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/cleanup.policy + resource_name: crn:///kafka=cluster-1/topic=topic-1/config=cleanup.policy + cluster_id: cluster-1 + topic_name: topic-1 + name: cleanup.policy + value: compact + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_TOPIC_CONFIG + synonyms: + - name: cleanup.policy + value: compact + source: DYNAMIC_TOPIC_CONFIG + - name: cleanup.policy + value: delete + source: DEFAULT_CONFIG + - kind: KafkaTopicConfig + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type + resource_name: crn:///kafka=cluster-1/topic=topic-1/config=compression.type + cluster_id: cluster-1 + topic_name: topic-1 + name: compression.type + value: gzip + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_TOPIC_CONFIG + synonyms: + - name: compression.type + value: gzip + source: DYNAMIC_TOPIC_CONFIG + - name: compression.type + value: producer + source: DEFAULT_CONFIG + # Currently the aggregator script doesn't merge correctly some + # otherwise identical parts of duplicate components defined in + # both kafka-rest and ce-kafka-rest's OpenAPI specs. + # In some cases this can be handled by slightly tweaking the + # input specs, but in other cases this requires manual + # intervention in the consolidated specs after the generation. + # We should eventually fix the aggregator script, but in the + # meantime, we should be careful during reviews, making sure + # that comments like this do not get replaced by wrongly + # merged autogenerated content. + # See https://github.com/confluentinc/ce-kafka-rest/pull/227. + + ListTopicsResponse: + description: The list of topics. + content: + application/json: + schema: + $ref: '#/components/schemas/TopicDataList' + example: + kind: KafkaTopicList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics + next: + data: + - kind: KafkaTopic + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1 + resource_name: crn:///kafka=cluster-1/topic=topic-1 + cluster_id: cluster-1 + topic_name: topic-1 + is_internal: false + replication_factor: 3 + partitions_count: 1 + partitions: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions + configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs + partition_reassignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/-/reassignments + - kind: KafkaTopic + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2 + resource_name: crn:///kafka=cluster-1/topic=topic-2 + cluster_id: cluster-1 + topic_name: topic-2 + is_internal: true + replication_factor: 4 + partitions_count: 1 + partitions: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions + configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/configs + partition_reassignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions/-/reassignments + - kind: KafkaTopic + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3 + resource_name: crn:///kafka=cluster-1/topic=topic-3 + cluster_id: cluster-1 + topic_name: topic-3 + is_internal: false + replication_factor: 5 + partitions_count: 1 + partitions: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions + configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/configs + partition_reassignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions/-/reassignments + + ProduceResponse: + description: |- + The response containing a delivery report for a record produced to a topic. In streaming mode, + for each record sent, a separate delivery report will be returned, in the same order, + each with its own error_code. + content: + application/json: + schema: + $ref: '#/components/schemas/ProduceResponse' + examples: + produce_record_success: + description: The record was successfully produced to the topic. + value: + error_code: 200 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + offset: 0 + timestamp: '2021-02-05T19:14:42Z' + key: + type: BINARY + size: 7 + value: + type: JSON + size: 15 + produce_record_bad_binary_data: + description: Thrown when sending a BINARY value which is not a base64-encoded + string. + value: + error_code: 400 + message: 'Bad Request: data=1 is not a base64 string.' + + SearchAclsResponse: + description: The list of ACLs. + content: + application/json: + schema: + $ref: '#/components/schemas/AclDataList' + example: + kind: KafkaAclList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?principal=User%3Aalice + data: + - kind: KafkaAcl + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=TOPIC&resource_name=topic-&pattern_type=PREFIXED&principal=User%3Aalice&host=*&operation=ALL&permission=ALLOW + cluster_id: cluster-1 + resource_type: TOPIC + resource_name: topic- + pattern_type: PREFIXED + principal: User:alice + host: '*' + operation: ALL + permission: ALLOW + - kind: KafkaAcl + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=CLUSTER&resource_name=kafka-cluster&pattern_type=LITERAL&principal=User%3Aalice&host=*&operation=DESCRIBE&permission=DENY + cluster_id: cluster-1 + resource_type: CLUSTER + resource_name: kafka-cluster + pattern_type: LITERAL + principal: User:alice + host: '*' + operation: DESCRIBE + permission: DENY + + SearchReassignmentsByTopicResponse: + description: The ongoing replicas reassignments. + content: + application/json: + schema: + $ref: '#/components/schemas/ReassignmentDataList' + example: + kind: KafkaReassignmentList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/-/partitions/-/reassignment + next: + data: + - kind: KafkaReassignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/reassignment + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=1/reassignment + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + adding_replicas: + - 1 + - 2 + removing_replicas: + - 3 + replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas + - kind: KafkaReassignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/reassignment + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=2/reassignment + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 2 + adding_replicas: + - 1 + removing_replicas: + - 2 + - 3 + replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/replicas + - kind: KafkaReassignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/reassignment + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=3/reassignment + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 3 + adding_replicas: + - 3 + removing_replicas: + - 1 + - 2 + replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/replicas + + SearchReplicasByBrokerResponse: + description: The list of replicas. + content: + application/json: + schema: + $ref: '#/components/schemas/ReplicaDataList' + example: + kind: KafkaReplicaList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1/partition-replicas + next: + data: + - kind: KafkaReplica + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/replicas/1 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=2/replica=1 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 2 + broker_id: 1 + is_leader: true + is_in_sync: true + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + - kind: KafkaReplica + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions/3/replicas/1 + resource_name: crn:///kafka=cluster-1/topic=topic-3/partition=3/replica=1 + cluster_id: cluster-1 + topic_name: topic-2 + partition_id: 3 + broker_id: 1 + is_leader: false + is_in_sync: true + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + - kind: KafkaReplica + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions/1/replicas/1 + resource_name: crn:///kafka=cluster-1/topic=topic-3/partition=1/replica=1 + cluster_id: cluster-1 + topic_name: topic-3 + partition_id: 1 + broker_id: 1 + is_leader: false + is_in_sync: false + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + + # Error responses + + BadRequestErrorResponse: + description: Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + bad_request_cannot_deserialize: + description: Thrown when trying to deserialize an integer from non-integer + data. + value: + error_code: 400 + message: 'Cannot deserialize value of type `java.lang.Integer` from + String "A": not a valid `java.lang.Integer` value' + + unsupported_version_exception: + description: Thrown when the version of this API is not supported in + the underlying Kafka cluster. + value: + error_code: 40035 + message: The version of this API is not supported in the underlying + Kafka cluster. + + BadRequestErrorResponse_CreateAcls: + description: Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + create_acls_cluster_name_invalid: + description: Thrown when creating an ACL for a CLUSTER resource specifying + the wrong resource name. + value: + error_code: 40002 + message: The only valid name for the CLUSTER resource is kafka-cluster" + + BadRequestErrorResponse_CreateTopic: + description: Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + create_topic_already_exists: + description: Thrown when trying to create a topic with a name already + used by an existing topic. + value: + error_code: 40002 + message: Topic 'my-topic' already exists. + create_topic_replication_factor_too_large: + description: Thrown when trying to create a topic with a replication + factor larger than the number of brokers. + value: + error_code: 40002 + message: 'Replication factor: 2 larger than available brokers: 1.' + + BadRequestErrorResponse_DeleteAcls: + description: Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + delete_acls_unspecified_resource_type: + description: Thrown when trying to delete ACLs without specifying a + valid resource type. + value: + error_code: 400 + message: resource_type cannot be unspecified or UNKNOWN + + BadRequestErrorResponse_ProduceRecords: + description: Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + header_not_base64_encoded: + description: Thrown when headers in the produce-record are not base64 + encoded. + value: + error_code: 400 + message: "Cannot deserialize value of type `byte[]` from String \"\ + \": Unexpected end of base64-encoded String: base64 variant 'MIME-NO-LINEFEEDS'\ + \ expects padding (one or more '=' characters) at the end. This\ + \ Base64Variant might have been incorrectly configured" + + UnprocessableEntity_ProduceRecord: + description: Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + produce_record_empty_request_body: + description: Thrown when the request body is empty. + value: + error_code: 422 + message: Payload error. Request body is empty. Data is required. + + BadRequestErrorResponse_UpdatePartitionCountTopic: + description: Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + topic_update_partitions_invalid: + description: Thrown when trying to update the number of partitions incorrectly. + value: + error_code: 40002 + message: Topic already has 1 partitions. + + UnauthorizedErrorResponse: + description: Indicates a client authentication error. Kafka authentication failures + will contain error code 40101 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + kafka_authentication_failed: + description: Thrown when using Basic authentication with wrong Kafka + credentials. + value: + error_code: 40101 + message: Authentication failed + + ForbiddenErrorResponse: + description: Indicates a client authorization error. Kafka authorization failures + will contain error code 40301 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + kafka_authorization_failed: + description: Thrown when the caller is not authorized to perform the + underlying operation. + value: + error_code: 40301 + message: Request is not authorized + + NotFoundErrorResponse: + description: Indicates attempted access to an unreachable or non-existing resource + like e.g. an unknown topic or partition. GET requests to endpoints not allowed + in the accesslists will also result in this response. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + endpoint_not_found: + description: Thrown for generic HTTP 404 errors. + value: + error_code: 404 + message: HTTP 404 Not Found + cluster_not_found: + description: Thrown when using a non-existing cluster ID. + value: + error_code: 404 + message: Cluster my-cluster cannot be found. + unknown_topic_or_partition: + description: Thrown when using a non-existing topic name or partition + ID. + value: + error_code: 40403 + message: This server does not host this topic-partition. + + TooManyRequestsErrorResponse: + description: Indicates that a rate limit threshold has been reached, and the + client should retry again later. + content: + text/html: + schema: + type: string + example: + description: A sample response from Jetty's DoSFilter. + value: + Error 429 Too Many Requests

HTTP ERROR + 429 Too Many Requests

+ + +
URI: /v3/clusters/my-cluster
STATUS: 429
MESSAGE:Too Many Requests
SERVLET: default
+ + RequestEntityTooLargeErrorResponse: + description: This implies the client is sending a request payload that is larger + than the maximum message size the server can accept. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + produce_records_expects_json: + description: Thrown by /records API if payload size exceeds the message + max size + value: + error_code: 413 + message: The request included a message larger than the maximum message + size the server can accept. + + UnsupportedMediaTypeErrorResponse: + description: This implies the client is sending the request payload format in + an unsupported format. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + produce_records_expects_json: + description: Thrown by /records API if payload format content-type doesn't + match expected application/json + value: + error_code: 415 + message: HTTP 415 Unsupported Media Type + + ServerErrorResponse: + description: A server-side problem that might not be addressable from the client + side. Retriable Kafka errors will contain error code 50003 in the response + body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + generic_internal_server_error: + description: Thrown for generic HTTP 500 errors. + value: + error_code: 500 + message: Internal Server Error + + ListReplicaStatusResponse: + description: The list of Replica Statuses. + content: + application/json: + schema: + $ref: '#/components/schemas/ReplicaStatusDataList' + example: + kind: KafkaReplicaStatusList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/topics/topic_1/partitions/0/replica-status + resource_name: + data: + - kind: KafkaReplicaStatus + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/topics/topic-1/partitions/0/brokers/1/replica-status + cluster_id: cluster-1 + topic_name: topic-1 + broker_id: 1 + partition_id: 0 + is_leader: true + is_observer: false + is_isr_eligible: true + is_in_isr: true + is_caught_up: true + log_start_offset: 0 + log_end_offset: 0 + last_caught_up_time_ms: 100 + last_fetch_time_ms: 200 + link_name: test-link + - kind: KafkaReplicaStatus + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/topics/topic-1/partitions/0/brokers/2/replica-status + cluster_id: cluster-1 + topic_name: topic-1 + broker_id: 2 + partition_id: 0 + is_leader: false + is_observer: false + is_isr_eligible: true + is_in_isr: true + is_caught_up: true + log_start_offset: 0 + log_end_offset: 0 + last_caught_up_time_ms: 100 + last_fetch_time_ms: 200 + link_name: test-link + + GetAnyUnevenLoadResponse: + description: The AnyUnevenLoad status + content: + application/json: + schema: + $ref: '#/components/schemas/AnyUnevenLoadData' + example: + kind: KafkaAnyUnevenLoad + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/any-uneven-load + resource_name: crn:///kafka=cluster-1/any-uneven-load + cluster_id: cluster-1 + status: BALANCING + previous_status: BALANCING_FAILED + status_updated_at: '2019-10-12T07:20:50Z' + previous_status_updated_at: '2019-10-12T07:20:35Z' + error_code: 10013 + error_message: The Confluent Balancer operation was overridden by a higher + priority operation. + broker_tasks: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/-/tasks + + GetBalancerStatusResponse: + description: The balancer status + content: + application/json: + schema: + $ref: '#/components/schemas/BalancerStatusData' + example: + kind: KafkaBalancerStatus + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/balancer + resource_name: crn:///kafka=cluster-1/balancer + cluster_id: cluster-1 + status: ERROR + error_code: 10014 + error_message: The Confluent Balancer failed to start as JBOD is enabled + for the cluster. + any_uneven_load: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/even-cluster-load + broker_tasks: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/-/tasks + + GetBrokerRemovalResponse: + description: The single broker removal response + content: + application/json: + schema: + $ref: '#/components/schemas/BrokerRemovalData' + example: + kind: KafkaBrokerRemoval + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + resource_name: crn:///kafka=cluster-1/broker=1/ + cluster_id: cluster-1 + broker_id: 1 + broker_task: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + + ListBrokerRemovalResponse: + description: The multiple broker removal response + content: + application/json: + schema: + $ref: '#/components/schemas/BrokerRemovalDataList' + example: + kind: KafkaBrokerRemovalList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers:delete + next: + data: + - kind: KafkaBrokerRemoval + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + resource_name: crn:///kafka=cluster-1/broker=1/ + cluster_id: cluster-1 + broker_id: 1 + broker_task: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + - kind: KafkaBrokerRemoval + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + resource_name: crn:///kafka=cluster-1/broker=1/ + cluster_id: cluster-1 + broker_id: 1 + broker_task: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + + GetBrokerTaskResponse: + description: The broker task + content: + application/json: + schema: + $ref: '#/components/schemas/BrokerTaskData' + example: + kind: KafkaBrokerTask + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1/tasks/add-broker + resource_name: crn:///kafka=cluster-1/broker=1/task=1 + cluster_id: cluster-1 + broker_id: 1 + task_type: add-broker + task_status: FAILED + sub_task_statuses: + partition_reassignment_status: ERROR + created_at: '2019-10-12T07:20:50Z' + updated_at: '2019-10-12T07:20:55Z' + error_code: 10013 + error_message: The Confluent Balancer operation was overridden by a higher + priority operation + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + + ListBrokerTaskResponse: + description: The list of tasks. + content: + application/json: + schema: + $ref: '#/components/schemas/BrokerTaskDataList' + example: + kind: KafkaBrokerTaskList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/-/tasks + next: + data: + - kind: KafkaBrokerTask + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1/tasks/add-broker + resource_name: crn:///kafka=cluster-1/broker=1/task=add-broker + cluster_id: cluster_id + broker_id: 1 + task_type: add-broker + task_status: SUCCESS + sub_task_statuses: + partition_reassignment_status: COMPLETED + created_at: '2019-10-12T10:20:40Z' + updated_at: '2019-10-12T10:20:45Z' + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + - kind: KafkaBrokerTask + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2/tasks/remove-broker + resource_name: crn:///kafka=cluster-1/broker=2/task=remove-broker + cluster_id: cluster_id + broker_id: 2 + task_type: remove-broker + task_status: FAILED + shutdown_scheduled: true + sub_task_statuses: + broker_replica_exclusion_status: COMPLETED + partition_reassignment_status: ERROR + broker_shutdown_status: CANCELED + created_at: '2019-10-12T07:20:50Z' + updated_at: '2019-10-12T07:20:55Z' + error_code: 10006 + error_message: Error while computing the initial remove broker plan + for brokers [2] prior to shutdown. + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 + + ListBrokerTaskByBrokerResponse: + description: The list of tasks. + content: + application/json: + schema: + $ref: '#/components/schemas/BrokerTaskDataList' + example: + kind: KafkaBrokerTaskList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/-/tasks + next: + data: + - kind: KafkaBrokerTask + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1/tasks/add-broker + resource_name: crn:///kafka=cluster-1/broker=1/task=add-broker + cluster_id: cluster_id + broker_id: 1 + task_type: add-broker + task_status: IN_PROGRESS + sub_task_statuses: + partition_reassignment_status: IN_PROGRESS + created_at: '2019-10-12T07:20:50Z' + updated_at: '2019-10-12T07:20:55Z' + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + - kind: KafkaBrokerTask + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1/tasks/remove-broker + resource_name: crn:///kafka=cluster-1/broker=1/task=remove-broker + cluster_id: cluster_id + broker_id: 1 + task_type: remove-broker + task_status: FAILED + shutdown_scheduled: false + sub_task_statuses: + broker_replica_exclusion_status: EXCLUDED + partition_reassignment_status: ERROR + broker_shutdown_status: CANCELED + created_at: '2019-10-12T07:20:50Z' + updated_at: '2019-10-12T07:20:55Z' + error_code: 10006 + error_message: Error while computing the initial remove broker plan + for brokers [1] prior to shutdown. + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + + ListBrokerTaskByTaskTypeResponse: + description: The list of tasks. + content: + application/json: + schema: + $ref: '#/components/schemas/BrokerTaskDataList' + example: + kind: KafkaBrokerTaskList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/-/tasks + next: + data: + - kind: KafkaBrokerTask + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1/tasks/add-broker + resource_name: crn:///kafka=cluster-1/broker=1/task=add-broker + cluster_id: cluster_id + broker_id: 1 + task_type: add-broker + task_status: IN_PROGRESS + sub_task_statuses: + partition_reassignment_status: IN_PROGRESS + created_at: '2019-10-12T07:20:50Z' + updated_at: '2019-10-12T07:20:55Z' + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + - kind: KafkaBrokerTask + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2/tasks/add-broker + resource_name: crn:///kafka=cluster-1/broker=2/task=add-broker + cluster_id: cluster_id + broker_id: 2 + task_type: add-broker + task_status: FAILED + sub_task_statuses: + partition_reassignment_status: ERROR + created_at: '2019-10-12T07:20:50Z' + updated_at: '2019-10-12T07:20:55Z' + error_code: 10006 + error_message: Error while computing the initial add broker plan for + brokers [2] + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 + + ListBrokerReplicaExclusionResponse: + description: The list of broker replica exclusions. + content: + application/json: + schema: + $ref: '#/components/schemas/BrokerReplicaExclusionDataList' + example: + kind: KafkaBrokerReplicaExclusionList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-replica-exclusions + next: + data: + - kind: KafkaBrokerReplicaExclusion + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-replica-exclusions/1 + resource_name: crn:///kafka=cluster-1/broker-replica-exclusions=1 + cluster_id: cluster-1 + broker_id: 1 + reason: Broker is to be removed. + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + - kind: KafkaBrokerReplicaExclusion + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-replica-exclusions/2 + resource_name: crn:///kafka=cluster-1/broker-replica-exclusions=2 + cluster_id: cluster-1 + broker_id: 2 + reason: Broker is to be removed. + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 + + GetBrokerReplicaExclusionResponse: + description: A Broker Replica Exclusion. + content: + application/json: + schema: + $ref: '#/components/schemas/BrokerReplicaExclusionData' + example: + kind: KafkaBrokerReplicaExclusion + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-replica-exclusions/1 + next: + cluster_id: cluster-1 + broker_id: 1 + reason: Broker is to be removed. + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + + ListCreateBrokerReplicaExclusionResponse: + description: The list of alter broker replica exclusions. + content: + application/json: + schema: + $ref: '#/components/schemas/AlterBrokerReplicaExclusionDataList' + example: + kind: KafkaAlterBrokerReplicaExclusionList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-replica-exclusions + next: + data: + - kind: KafkaAlterBrokerReplicaExclusion + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-replica-exclusions/1 + resource_name: crn:///kafka=cluster-1/broker-replica-exclusions=1 + cluster_id: cluster-1 + broker_id: 1 + exclusion: SET + reason: Broker is to be removed. + error_code: + error_message: + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + - kind: KafkaAlterBrokerReplicaExclusion + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-replica-exclusions/2 + resource_name: crn:///kafka=cluster-1/broker-replica-exclusions=2 + cluster_id: cluster-1 + broker_id: 2 + exclusion: SET + reason: Broker is to be removed. + error_code: + error_message: + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 + + ListDeleteBrokerReplicaExclusionResponse: + description: The list of alter broker replica exclusions. + content: + application/json: + schema: + $ref: '#/components/schemas/AlterBrokerReplicaExclusionDataList' + example: + kind: KafkaAlterBrokerReplicaExclusionList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-replica-exclusions + next: + data: + - kind: KafkaAlterBrokerReplicaExclusion + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-replica-exclusions/1 + resource_name: crn:///kafka=cluster-1/broker-replica-exclusions=1 + cluster_id: cluster-1 + broker_id: 1 + exclusion: DELETE + reason: Broker removal is completed. + error_code: + error_message: + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + - kind: KafkaAlterBrokerReplicaExclusion + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-replica-exclusions/2 + resource_name: crn:///kafka=cluster-1/broker-replica-exclusions=2 + cluster_id: cluster-1 + broker_id: 2 + exclusion: DELETE + reason: Broker removal is completed. + error_code: + error_message: + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 + + ListDeleteBrokerReplicaExclusionErrorResponse: + description: The list of alter broker replica exclusions. + content: + application/json: + schema: + $ref: '#/components/schemas/AlterBrokerReplicaExclusionDataList' + example: + kind: KafkaAlterBrokerReplicaExclusionList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-replica-exclusions + next: + data: + - kind: KafkaAlterBrokerReplicaExclusion + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-replica-exclusions/1 + resource_name: crn:///kafka=cluster-1/broker-replica-exclusions=1 + cluster_id: cluster-1 + broker_id: 1 + exclusion: DELETE + reason: Broker removal is completed. + error_code: 404 + error_message: No replica exclusion for broker 1 was present. + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + - kind: KafkaAlterBrokerReplicaExclusion + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-replica-exclusions/2 + resource_name: crn:///kafka=cluster-1/broker-replica-exclusions=2 + cluster_id: cluster-1 + broker_id: 2 + exclusion: DELETE + reason: Broker removal is completed. + error_code: + error_message: + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 + + GetRemoveBrokerTaskResponse: + description: The remove broker task. + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveBrokerTaskData' + example: + kind: KafkaRemoveBrokerTask + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/remove-broker-tasks/1 + resource_name: crn:///kafka=cluster-1/remove-broker-task=1 + cluster_id: cluster-1 + broker_id: 1 + shutdown_scheduled: false + broker_replica_exclusion_status: COMPLETED + partition_reassignment_status: FAILED + broker_shutdown_status: CANCELED + error_code: 10006 + error_message: Error while computing the initial remove broker plan for + brokers [1] prior to shutdown. + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + + ListRemoveBrokerTaskResponse: + description: The list of remove broker tasks. + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveBrokerTaskDataList' + example: + kind: KafkaRemoveBrokerTaskList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/remove-broker-tasks + next: + data: + - kind: KafkaRemoveBrokerTask + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/remove-broker-tasks/1 + resource_name: crn:///kafka=cluster-1/remove-broker-task=1 + cluster_id: cluster-1 + broker_id: 1 + shutdown_scheduled: true + broker_replica_exclusion_status: COMPLETED + partition_reassignment_status: FAILED + broker_shutdown_status: CANCELED + error_code: 10006 + error_message: Error while computing the initial remove broker plan + for brokers [1] prior to shutdown. + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + - kind: KafkaRemoveBrokerTask + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/remove-broker-tasks/2 + resource_name: crn:///kafka=cluster-1/remove-broker-task=2 + cluster_id: cluster-1 + broker_id: 2 + shutdown_scheduled: true + broker_replica_exclusion_status: EXCLUDED + partition_reassignment_status: FAILED + broker_shutdown_status: CANCELED + error_code: 10006 + error_message: Error while computing the initial remove broker plan + for brokers [2] prior to shutdown. + broker: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 + + NoContentResponse: + description: Operation succeeded, no content in the response + + ListLinksResponse: + description: A list of link names and properties + content: + application/json: + schema: + $ref: '#/components/schemas/ListLinksResponseDataList' + example: + kind: KafkaLinkDataList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links + next: + data: + - kind: KafkaLinkData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/CIL-69l7S1CwoVNAhoQLug/links/my-new-link-1 + resource_name: + source_cluster_id: src-cluster-id + link_name: my-new-link-1 + link_id: 7840644d-f7d8-4844-a577-a10ef3df31df + cluster_link_id: eEBkTffYSESld6EO898x3w + topic_names: + - topic-sb-1 + - topic-sb-2 + link_state: ACTIVE + - kind: KafkaLinkData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/CIL-69l7S1CwoVNAhoQLug/links/my-new-link-2 + resource_name: + remote_cluster_id: src-cluster-id + link_name: my-new-link-2 + link_id: f749116e-f847-4bd2-b1f6-5c4e518a0678 + cluster_link_id: 90kRbvhHS9Kx9lxOUYoGeA + topic_names: + - topic-db-1 + - topic-db-2 + link_state: UNAVAILABLE + link_error: AUTHENTICATION_ERROR + link_error_message: Please check your api key and secret + - kind: KafkaLinkData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/CIL-69l7S1CwoVNAhoQLug/links/my-new-link-3 + resource_name: + destination_cluster_id: dest-cluster-id + link_name: my-new-link-3 + link_id: 9cd1711e-a4ef-4390-a35e-dfd758d97a82 + cluster_link_id: nNFxHqTvQ5CjXt_XWNl6gg + topic_names: [] + link_state: ACTIVE + + GetLinkResponse: + description: Single link name and properties + content: + application/json: + schema: + $ref: '#/components/schemas/ListLinksResponseData' + examples: + link_at_destination_cluster: + description: Link at destination cluster + value: + kind: KafkaLinkData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/my-new-link-1 + resource_name: + source_cluster_id: src-cluster-id + link_name: my-new-link-1 + link_id: 7840644d-f7d8-4844-a577-a10ef3df31df + cluster_link_id: eEBkTffYSESld6EO898x3w + topic_names: + - topic-db-1 + - topic-db-2 + link_at_source_cluster: + description: Link at source cluster + value: + kind: KafkaLinkData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/my-new-link-1 + resource_name: + destination_cluster_id: dst-cluster-id + link_name: my-new-link-1 + link_id: 7840644d-f7d8-4844-a577-a10ef3df31df + cluster_link_id: eEBkTffYSESld6EO898x3w + topic_names: [] + ListLinkConfigsResponse: + description: Config name and value + content: + application/json: + schema: + $ref: '#/components/schemas/ListLinkConfigsResponseDataList' + example: + kind: KafkaLinkConfigDataList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/v-0Ce-CkTyKQol9v46LaCQ/links/link-nb-1/configs + next: + data: + - kind: KafkaLinkConfigData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/links/my-new-link-1 + resource_name: + cluster_id: 1Rh_4htxSuen7RYGvGmgNw + name: consumer.offset.sync.ms + value: '3825940' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_CLUSTER_LINK_CONFIG + synonyms: + - cosm + link_name: link-db-1 + - kind: KafkaLinkConfigData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/links/my-new-link-1 + resource_name: + cluster_id: 1Rh_4htxSuen7RYGvGmgNw + name: acl.sync.ms + value: '5000' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_CLUSTER_LINK_CONFIG + synonyms: + - asm + link_name: link-db-1 + + GetLinkConfigsResponse: + description: Config name and value + content: + application/json: + schema: + $ref: '#/components/schemas/ListLinkConfigsResponseData' + example: + kind: KafkaLinkConfigData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/links/my-new-link-1 + resource_name: + cluster_id: 1Rh_4htxSuen7RYGvGmgNw + name: consumer.offset.sync.ms + value: '3825940' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_CLUSTER_LINK_CONFIG + synonyms: + - cosm + link_name: link-db-1 + + + ListMirrorTopicsResponse: + description: Metadata of mirror topics + content: + application/json: + schema: + $ref: '#/components/schemas/ListMirrorTopicsResponseDataList' + example: + kind: KafkaMirrorDataList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/link/link-1/mirrors + resource_name: crn:///kafka=cluster-1 + next: + data: + - kind: KafkaMirrorData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/link-1/mirrors/topic-1 + resource_name: crn:///kafka=cluster-1 + link_name: link-sb-1 + resource_name: crn:///kafka=cluster-1 + mirror_topic_name: topic-1 + source_topic_name: topic-1 + num_partitions: 3 + mirror_lags: + - partition: 0 + lag: 0 + last_source_fetch_offset: 0 + - partition: 1 + lag: 10000 + last_source_fetch_offset: 1000 + - partition: 2 + lag: 40000 + last_source_fetch_offset: 12030 + mirror_status: ACTIVE + state_time_ms: 1612550939300 + - kind: KafkaMirrorData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/link-1/mirrors/topic-2 + resource_name: crn:///kafka=cluster-1 + link_name: link-sb-2 + resource_name: crn:///kafka=cluster-1 + mirror_topic_name: topic-2 + source_topic_name: topic-2 + num_partitions: 3 + mirror_lags: + - partition: 0 + lag: 0 + last_source_fetch_offset: 0 + - partition: 1 + lag: 10000 + last_source_fetch_offset: 1000 + - partition: 2 + lag: 40000 + last_source_fetch_offset: 12030 + mirror_status: STOPPED + state_time_ms: 1612551353640 + + DescribeMirrorTopicResponse: + description: Metadata of the mirror topic + content: + application/json: + schema: + $ref: '#/components/schemas/ListMirrorTopicsResponseData' + example: + kind: KafkaMirrorData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/link/link-1/mirrors/topic-1 + resource_name: crn:///kafka=cluster-1 + link_name: link-sb-1 + mirror_topic_name: topic-1 + source_topic_name: topic-1 + num_partitions: 3 + mirror_lags: + - partition: 0 + lag: 0 + last_source_fetch_offset: 0 + - partition: 1 + lag: 10000 + last_source_fetch_offset: 1000 + - partition: 2 + lag: 40000 + last_source_fetch_offset: 12030 + mirror_status: ACTIVE + state_time_ms: 1612550939300 + + AlterMirrorStatusResponse: + description: Mirror status alternation result + content: + application/json: + schema: + $ref: '#/components/schemas/AlterMirrorStatusResponseDataList' + example: + kind: KafkaPromoteMirror + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-1/mirrors + resource_name: crn:///kafka=cluster-1 + data: + - kind: AlterMirrorsData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/my-new-link-1/mirrors/topic-1 + resource: crn:///kafka=cluster-1 + mirror_topic_name: topic-sb + error_code: + error_message: + mirror_lags: + - partition: 0 + lag: 0 + last_source_fetch_offset: 0 + - partition: 1 + lag: 10000 + last_source_fetch_offset: 1000 + - partition: 2 + lag: 40000 + last_source_fetch_offset: 12030 + messages_truncated: + partition_level_truncation_data: + - partition_id: 0 + offset_truncated_to: 10000 + messages_truncated: 10000 + - partition_id: 1 + offset_truncated_to: 40000 + messages_truncated: 12030 + - partition_id: 2 + offset_truncated_to: 20000 + messages_truncated: 20000 + - kind: AlterMirrorsData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/my-new-link-1/mirrors/topic-2 + resource: crn:///kafka=cluster-1 + mirror_topic_name: topic-2 + error_code: 400 + error_message: Topic 'topic-2' has already stopped its mirror from + 'my-new-link-1' + mirror_lags: + - partition: 0 + lag: 0 + last_source_fetch_offset: 0 + - partition: 1 + lag: 10000 + last_source_fetch_offset: 1000 + - partition: 2 + lag: 40000 + last_source_fetch_offset: 12030 + messages_truncated: + partition_level_truncation_data: + - partition_id: 0 + offset_truncated_to: 10000 + messages_truncated: 10000 + - partition_id: 1 + offset_truncated_to: 40000 + messages_truncated: 12030 + - partition_id: 2 + offset_truncated_to: 20000 + messages_truncated: 20000 + + BadBrokerOrBalancerRequestErrorResponse: + description: Bad broker or balancer request + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + IllegalBrokerRemoval: + value: + error_code: 400 + message: 'Cannot remove broker 1 as there are partitions with replication + factor equal to 1 on the broker. One such partition: test_topic_partition_0.' + BalancerOffline: + value: + error_code: 400 + message: The Confluent Balancer component is disabled or not started + yet. + + BalancerOfflineErrorResponse: + description: Balancer offline + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + error_code: 400 + message: The Confluent Balancer component is disabled or not started yet. + + BrokerNotFoundErrorResponse: + description: Broker not found. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + error_code: 404 + message: 'Broker not found. Broker: 1 not found in the cluster: cluster-1' + + UnrepresentableBrokerErrorResponse: + description: Unrepresentable broker id. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + error_code: 400 + message: The given broker id -10 is invalid + + BalancerNotEnabledErrorResponse: + description: Confluent Balancer disabled or not started. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + error_code: 500 + message: The Confluent Balancer component is disabled or not started yet. + + ClusterAuthorizationErrorResponse: + description: Operation not authorized. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + error_code: 401 + message: "Not authorized: the authenticated user didn't have the right\ + \ access to the resource." + + ClusterLinkNotFoundErrorResponse: + description: The cluster link doesn't exist. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + error_code: 404 + message: The cluster link doesn't exist. + + InvalidClusterLinkErrorResponse: + description: The cluster link doesn't exist. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + error_code: 400 + message: Invalid Cluster Link Name. + + InvalidConfigNameErrorResponse: + description: Invalid Config Name. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + error_code: 400 + message: Invalid Config Name. + + ClusterLinkExistsErrorResponse: + description: A cluster link already exists with the provided link name + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + error_code: 404 + message: A cluster link already exists with the provided link name + + TimeoutErrorResponse: + description: The server received the request, but the operation timed out + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + error_code: 408 + message: The server received the request, but the operation timed out + schemaregistry.v1.BadRequestError: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 400 + message: Bad Request + schemaregistry.v1.UnauthorizedError: + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 401 + message: Unauthorized + schemaregistry.v1.ForbiddenError: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 403 + message: Forbidden + schemaregistry.v1.AccountNotFoundError: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 404 + message: account not found + schemaregistry.v1.ResourceNotFoundError: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 404 + message: resource not found + schemaregistry.v1.DefaultSystemError: + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 500 + message: Oops, something went wrong + parameters: + AclHost: + name: host + description: The ACL host. + in: query + required: false + schema: + type: string + + AclOperation: + name: operation + description: The ACL operation. + in: query + required: false + schema: + $ref: '#/components/schemas/AclOperation' + + AclOperationRequired: + name: operation + description: The ACL operation. + in: query + required: true + schema: + $ref: '#/components/schemas/AclOperation' + + AclPatternType: + name: pattern_type + description: The ACL pattern type. + in: query + required: false + schema: + $ref: '#/components/schemas/AclPatternType' + + AclPatternTypeRequired: + name: pattern_type + description: The ACL pattern type. + in: query + required: true + schema: + $ref: '#/components/schemas/AclPatternType' + + AclPermission: + name: permission + description: The ACL permission. + in: query + required: false + schema: + $ref: '#/components/schemas/AclPermission' + + AclPermissionRequired: + name: permission + description: The ACL permission. + in: query + required: true + schema: + $ref: '#/components/schemas/AclPermission' + + AclPrincipal: + name: principal + description: |- + The ACL principal. This is the Service Account name or user name. + Supports both legacy `User:` format (numeric IDs) and new `UserV2:` + format (sa-xxx format) for service accounts. Use `UserV2:*` to + retrieve service accounts in the new format. + in: query + required: false + schema: + type: string + + AclResourceName: + name: resource_name + description: The ACL resource name. + in: query + required: false + schema: + type: string + + AclResourceType: + name: resource_type + description: The ACL resource type. + in: query + required: false + schema: + $ref: '#/components/schemas/AclResourceType' + + AclResourceTypeRequired: + name: resource_type + description: The ACL resource type. + in: query + required: true + schema: + $ref: '#/components/schemas/AclResourceType' + + BrokerId: + name: broker_id + description: The Kafka broker ID. + in: path + required: true + schema: + type: integer + example: 1 + + ClusterId: + name: cluster_id + description: The Kafka cluster ID. + in: path + required: true + schema: + type: string + example: cluster-1 + + ConfigName: + name: name + description: The configuration parameter name. + in: path + required: true + schema: + type: string + example: compression.type + + ConsumerGroupId: + name: consumer_group_id + description: The consumer group ID. + in: path + required: true + schema: + type: string + example: consumer-group-1 + + ConsumerId: + name: consumer_id + description: The consumer ID. + in: path + required: true + schema: + type: string + example: consumer-1 + + SubtopologyId: + name: subtopology_id + description: The streams subtopology ID. + in: path + required: true + schema: + type: string + example: subtopology-1 + + MemberId: + name: member_id + description: The streams member ID. + in: path + required: true + schema: + type: string + example: member-1 + + AssignmentsType: + name: assignments_type + description: The streams member Assignment type. + in: path + required: true + schema: + $ref: '#/components/schemas/AssignmentsType' + example: active + + GroupId: + name: group_id + description: The group ID. + in: path + required: true + schema: + type: string + example: group-1 + + IncludeAuthorizedOperations: + name: include_authorized_operations + description: Specify if authorized operations should be included in the response. + in: query + required: false + schema: + type: boolean + + PartitionId: + name: partition_id + description: The partition ID. + in: path + required: true + schema: + type: integer + example: 0 + + TopicName: + name: topic_name + description: The topic name. + in: path + required: true + schema: + type: string + example: topic-1 + + BrokerTaskType: + name: task_type + description: The Kafka broker task type. + in: path + required: true + schema: + $ref: '#/components/schemas/BrokerTaskType' + example: remove-broker + + ShouldShutdown: + name: should_shutdown + description: 'To shutdown the broker or not, Default: true' + in: query + required: false + schema: + type: boolean + example: true + + ValidateOnly: + name: validate_only + description: 'To validate the action can be performed successfully or not. Default: + false' + in: query + required: false + schema: + type: boolean + example: false + + ValidateLink: + name: validate_link + description: 'To synchronously validate that the source cluster ID is expected + and the dest cluster has the permission to read topics in the source cluster. + Default: true' + in: query + required: false + schema: + type: boolean + example: false + + IncludeTasks: + name: include_tasks + description: 'Whether to include cluster linking tasks in the response. Default: + false' + in: query + required: false + schema: + type: boolean + example: false + + IncludeStateTransitionErrors: + name: include_state_transition_errors + description: 'Whether to include mirror state transition errors in the response. + Default: false' + in: query + required: false + schema: + type: boolean + example: false + + Force: + name: force + description: 'Force the action. Default: false' + in: query + required: false + schema: + type: boolean + example: false + + IncludePartitionLevelTruncationData: + name: include_partition_level_truncation_data + description: 'Whether to include partition level truncation information when + truncating and restoring a topic in the response. Default: false' + in: query + required: false + schema: + type: boolean + example: false + + LinkName: + name: link_name + description: The link name + in: path + required: true + schema: + type: string + example: link-sb1 + + LinkConfigName: + name: config_name + description: The link config name + in: path + required: true + schema: + type: string + example: consumer.offset.sync.enable + + MirrorTopicStatus: + name: mirror_status + description: The status of the mirror topic. If not specified, all mirror topics + will be returned. + in: query + required: false + schema: + $ref: '#/components/schemas/MirrorTopicStatus' + example: ACTIVE + + MirrorTopicName: + name: mirror_topic_name + description: Cluster Linking mirror topic name + in: path + required: true + schema: + type: string + example: topic-1 + + QueryParamLinkName: + name: link_name + description: The link name + in: query + required: true + schema: + type: string + example: link-sb1 + + requestBodies: + AlterGroupConfigBatchRequest: + content: + application/json: + example: + data: + - name: share.session.timeout.ms + operation: DELETE + - name: share.heartbeat.interval.ms + value: '5000' + schema: + $ref: '#/components/schemas/AlterConfigBatchRequestData' + + UpdateGroupConfigRequest: + content: + application/json: + example: + value: '45000' + schema: + $ref: '#/components/schemas/UpdateGroupConfigRequestData' + description: Group config value to update + + AlterBrokerConfigBatchRequest: + description: The alter broker configuration parameter batch request. + content: + application/json: + schema: + $ref: '#/components/schemas/AlterConfigBatchRequestData' + example: + data: + - name: max.connections + operation: DELETE + - name: compression.type + value: gzip + + AlterClusterConfigBatchRequest: + description: The alter cluster configuration parameter batch request. + content: + application/json: + schema: + $ref: '#/components/schemas/AlterConfigBatchRequestData' + example: + data: + - name: max.connections + operation: DELETE + - name: compression.type + value: gzip + + AlterTopicConfigBatchRequest: + description: The alter topic configuration parameter batch request. + content: + application/json: + schema: + $ref: '#/components/schemas/AlterConfigBatchRequestData' + examples: + batch_alter_topic_configs: + value: + data: + - name: cleanup.policy + operation: DELETE + - name: compression.type + value: gzip + validate_only_batch_alter_topic_configs: + value: + data: + - name: cleanup.policy + operation: DELETE + - name: compression.type + value: gzip + validate_only: true + + CreateAclRequest: + description: The ACL creation request. + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAclRequestData' + example: + resource_type: CLUSTER + resource_name: kafka-cluster + pattern_type: LITERAL + principal: principalType:principalName + host: '*' + operation: DESCRIBE + permission: DENY + + BatchCreateAclRequest: + description: The batch ACL creation request. + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAclRequestDataList' + example: + data: + - resource_type: CLUSTER + resource_name: kafka-cluster + pattern_type: LITERAL + principal: principalType:principalName + host: '*' + operation: DESCRIBE + permission: DENY + - resource_type: TOPIC + resource_name: kafka-cluster + pattern_type: LITERAL + principal: principalType:principalName + host: '*' + operation: READ + permission: ALLOW + + CreateTopicRequest: + description: The topic creation request. Note that Confluent Cloud allows only + specific replication factor values. Because of that the replication factor + field should either be omitted or it should use one of the allowed values + (see https://docs.confluent.io/cloud/current/client-apps/optimizing/durability.html). + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTopicRequestData' + examples: + uniform_replication: + value: + topic_name: topic-X + partitions_count: 64 + replication_factor: 3 + configs: + - name: cleanup.policy + value: compact + - name: compression.type + value: gzip + dry_run_create_topic: + value: + topic_name: topic-X + partitions_count: 64 + replication_factor: 3 + validate_only: true + + ProduceRequest: + description: A single record to be produced to Kafka. To produce multiple records + in the same request, simply concatenate the records. The delivery reports + are concatenated in the same order as the records are sent. + content: + application/json: + schema: + $ref: '#/components/schemas/ProduceRequest' + examples: + binary_and_json: + description: If using type, one of "BINARY", "JSON" or "STRING" is required. + value: + partition_id: 1 + headers: + - name: Header-1 + value: SGVhZGVyLTE= + - name: Header-2 + value: SGVhZGVyLTI= + key: + type: BINARY + data: Zm9vYmFy + value: + type: JSON + data: {foo: bar} + timestamp: '2021-02-05T19:14:42Z' + string: + description: If using type, one of "BINARY", "JSON" or "STRING" is required. + value: + value: + type: STRING + data: My message + empty_value: + description: key or value can be omitted entirely. + value: + key: + data: 1000 + + UpdateBrokerConfigRequest: + description: The broker configuration parameter update request. + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateConfigRequestData' + example: + value: gzip + + UpdateClusterConfigRequest: + description: The cluster configuration parameter update request. + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateConfigRequestData' + example: + value: gzip + + UpdateTopicConfigRequest: + description: The topic configuration parameter update request. + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateConfigRequestData' + example: + value: gzip + + # UpdatePartitionCountRequest: + # description: The number of partitions to increase the partition count to. + # content: + # application/json: + # schema: + # $ref: '#/components/schemas/UpdatePartitionCountRequestData' + # example: + # partitions_count: 10 + + CreateLinkRequest: + description: Create a cluster link + content: + application/json: + schema: + $ref: '#/components/schemas/CreateLinkRequestData' + examples: + destination_initiated_link: + description: Create a destination initiated cluster link + value: + source_cluster_id: cluster-1 + configs: + - name: bootstrap.servers + value: cluster-1-bootstrap-server + - name: acl.sync.enable + value: 'false' + - name: consumer.offset.sync.ms + value: '30000' + - name: sasl.mechanism + value: PLAIN + - name: security.protocol + value: SASL_SSL + - name: sasl.jaas.config + value: sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule + required username='' password=''; + + source_initiated_link_at_source_cluster: + description: Create a source initiated cluster link at source cluster + value: + destination_cluster_id: cluster-2 + configs: + - name: bootstrap.servers + value: cluster-2-bootstrap-server + - name: link.mode + value: SOURCE + - name: sasl.mechanism + value: PLAIN + - name: security.protocol + value: SASL_SSL + - name: sasl.jaas.config + value: sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule + required username='' password=''; + - name: local.sasl.mechanism + value: PLAIN + - name: local.security.protocol + value: SASL_SSL + - name: local.sasl.jaas.config + value: sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule + required username='' password=''; + + source_initiated_link_at_destination_cluster: + description: Create a source initiated cluster link at destination cluster + value: + destination_cluster_id: cluster-1 + configs: + - name: link.mode + value: DESTINATION + - name: connection.mode + value: INBOUND + - name: acl.sync.enable + value: 'false' + + bidirectional_link_east: + description: Create a bidirectional cluster link in east + value: + remote_cluster_id: cluster-west + configs: + - name: bootstrap.servers + value: cluster-west-bootstrap-server + - name: link.mode + value: BIDIRECTIONAL + - name: cluster.link.prefix + value: west. + - name: sasl.mechanism + value: PLAIN + - name: security.protocol + value: SASL_SSL + - name: sasl.jaas.config + value: sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule + required username='' password=''; + + bidirectional_link_west: + description: Create a bidirectional cluster link in west + value: + remote_cluster_id: cluster-east + cluster_link_id: eEBkTffYSESld6EO898x3w + configs: + - name: bootstrap.servers + value: cluster-east-bootstrap-server + - name: link.mode + value: BIDIRECTIONAL + - name: cluster.link.prefix + value: east. + - name: sasl.mechanism + value: PLAIN + - name: security.protocol + value: SASL_SSL + - name: sasl.jaas.config + value: sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule + required username='' password=''; + + UpdateLinkConfigRequest: + content: + application/json: + example: + value: '300000' + schema: + $ref: '#/components/schemas/UpdateLinkConfigRequestData' + description: Link config value to update + + AlterLinkConfigBatchRequest: + content: + application/json: + example: + data: + - name: cleanup.policy + operation: DELETE + - name: compression.type + value: gzip + schema: + $ref: '#/components/schemas/AlterConfigBatchRequestData' + + CreateMirrorTopicRequest: + description: Name and configs of the topics mirroring from and mirroring to. + Note that Confluent Cloud allows only specific replication factor values. + Because of that the replication factor field should either be omitted or it + should use one of the allowed values (see https://docs.confluent.io/cloud/current/client-apps/optimizing/durability.html). + content: + application/json: + schema: + $ref: '#/components/schemas/CreateMirrorTopicRequestData' + examples: + generic_example: + description: Generic example of creating a mirror topic + value: + source_topic_name: topic-1 + configs: + - name: unclean.leader.election.enable + value: 'true' + replication_factor: 1 + example_with_mirror_topic_name: + description: Example using optional mirror_topic_name flag + value: + source_topic_name: topic-1 + mirror_topic_name: link1_topic-1 + configs: + - name: unclean.leader.election.enable + value: 'true' + replication_factor: 3 + + AlterMirrorsRequest: + description: Mirror topics to be altered. + content: + application/json: + schema: + $ref: '#/components/schemas/AlterMirrorsRequestData' + examples: + mirror_topic_names: + description: Example using mirror topic names + value: + mirror_topic_names: + - topic-1 + - topic-2 + mirror_topic_name_pattern: + description: Example using mirror topic name pattern + value: + mirror_topic_name_pattern: .* + + RemoveBrokersRequest: + content: + application/json: + example: + broker_ids: + - 1 + - 2 + - 3 + schema: + $ref: '#/components/schemas/RemoveBrokersRequestData' + description: Broker ids to remove + + BrokerReplicaExclusionBatchRequest: + description: Alter Broker Replica Exclusions. + content: + application/json: + schema: + $ref: '#/components/schemas/BrokerReplicaExclusionBatchRequestData' + example: + data: + - broker_id: 1 + reason: The broker is to be removed. + - broker_id: 2 + reason: The broker is to be removed. + +tags: + - name: API Keys (iam/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `ApiKey` objects represent access to different parts of Confluent Cloud. Some types + of API keys represent access to a single cluster/resource such as a Kafka cluster, + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization + that are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API. + Tableflow API keys are not tied to a specific cluster. + + The API allows you to list, create, update and delete your API Keys. + + + Related guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + ## The API Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `apikeys_per_org` | API Keys in one Confluent Cloud organization | + - name: Environments (org/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Environment` objects represent an isolated namespace for your Confluent resources + for organizational purposes. + + The API allows you to create, delete, and update your environments. You can retrieve + individual environments as well as a list of all your environments. + + + Related guide: [Environments in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + ## The Environments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `environments_per_org` | Environments in one Confluent Cloud organization | + - name: Organizations (org/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Organization` objects represent a customer organization. An organization contains all customer + resources (e.g., Environments, Kafka Clusters, Service Accounts, API Keys) and is tied to a billing + agreement (including any annual commitment or support plan). + + The API allows you to list, view, and update your organizations. + + + Related guide: [Organizations for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + ## The Organizations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `organizations_per_user` | Confluent Cloud organizations a user belongs to | + - name: Users (iam/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `User` objects represent individuals who may access your Confluent resources. + + The API allows you to retrieve, update, and delete individual users, as well as list of all your + users. This API cannot be used to create new user accounts. + + + Related guide: [Users in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + ## The Users Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `users_per_org` | Users in one Confluent Cloud organization | + - name: Service Accounts (iam/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `ServiceAccount` objects are typically used to represent applications and other non-human principals + that may access your Confluent resources. + + The API allows you to create, retrieve, update, and delete individual service accounts, as well as + list all your service accounts. + + + Related guide: [Service Accounts in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + ## The Service Accounts Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `service_accounts_per_org` | Service Accounts in one Confluent Cloud organization | + - name: Invitations (iam/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Invitation` objects represent invitations to invite users to join your organizations in Confluent Cloud. + + The API allows you to list all your invitations, as well as create, read, and delete a specified invitation. + + + Related guide: [User invitations in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + ## The Invitations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `invitations_per_org` | Invitations in a Confluent Cloud organization | + - name: IP Groups (iam/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Definitions of networks which can be named and referred by IP blocks, commonly used to attach to IP Filter rules. + + + ## The IP Groups Model + + - name: IP Filters (iam/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `IP Filter` objects are bindings between IP Groups and Confluent resource(s). + For example, a binding between "CorpNet" and "Management APIs" will enforce that + access must come from one of the CIDR blocks associated with CorpNet. + If there are multiple IP filters bound to a resource, a request matching any of the CIDR blocks + for any of the IP Group will allow the request. + If there are no IP Filters for a resource, then access will be granted to requests originating + from any IP Address. + + + ## The IP Filters Model + + - name: IP Filter Summaries (iam/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + The IP Filter Summary endpoint returns an aggregation of the IP Filters across the system. + This API can be queried in the context of an organization or an environment. It returns a + summary of every operation group in the system grouped with a higher summary by operation + group category. + + + ## The IP Filter Summaries Model + + - name: Role Bindings (iam/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + A role binding grants a Principal a role on resources that match a pattern. + + The API allows you to perform create, delete, and list operations on role bindings. + + + Related guide: [Role-Based Access Control (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + ## The Role Bindings Model + + - name: Subscriptions (notifications/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Subscription` objects represent the intent of the customers to get notifications of particular types. + A subscription is created for a particular `NotificationType` and the user will get notifications on the + `Integrations` that are provided while creating the subscription. + + This API allows you to create, retrieve, and update subscriptions, + as well as to view the list of all your subscriptions. You can also delete subscriptions + with RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Subscriptions Model + + - name: Integrations (notifications/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + You can create an `Integration` to specify how we can notify you when we receive an alert/notification for + a subscription. Please note that you can only perform create, update and delete operations for integrations + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail` + and `UserEmail`. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Integrations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `integrations_per_org` | Maximum number of integrations in one Confluent Cloud organization | + - name: Notification Types (notifications/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + The type of notifications (and their corresponding metadata) supported by Confluent. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Notification Types Model + + - name: Resource Preferences (notifications/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `ResourcePreference` objects represent the intent of the customers to enable or disable all notifications + at the resource level. A ResourcePreference is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update and delete resourcePreferences. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Preferences Model + + - name: Resource Subscriptions (notifications/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `ResourceSubscription` objects represent the intent of the customers to get notifications of particular types + at the resource level. A ResourceSubscription is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update, delete and list ResourceSubscription. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Subscriptions Model + + - name: Clusters (cmk/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Kafka clusters. + + + Related guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment | + - name: Clusters (ksqldbcm/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Cluster` represents a ksqlDB runtime that you can issue queries to using its API endpoint. + It executes SQL statements and queries which under the hood get built into corresponding + Kafka Streams topologies. The API allows you to list, create, read, and delete your ksqlDB clusters. + + + Related guide: [ksqlDB in Confluent Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the following quotas: + + | Quota | Description | + | --- | --- | + | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent Cloud Kafka Cluster. | + - name: Connectors (connect/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + API for Managed Connectors or Custom Connectors in Confluent Cloud. + + The API allows you to list, create, get, update and delete a Managed Connector or Custom Connector in Confluent Cloud. + + Connect metrics are available through the [Metrics v2 API](https://api.telemetry.confluent.cloud/docs#tag/Version-2). + + Related guide: [Confluent Cloud API and Managed Connectors](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + - name: Lifecycle (connect/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + API for managing the lifecycle for a Managed Connector or Custom Connector in Confluent Cloud. Operations currently supported are Pause and Resume. + - name: Status (connect/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + API for requesting the status or the tasks for a Managed Connector or Custom Connector in Confluent Cloud. + - name: Managed Connector Plugins (connect/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + API for Managed connectors in Confluent Cloud. + - name: Offsets (connect/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + API for managing the offsets for a Managed Connector. + + Related guide: [Manage Connector Offsets](https://docs.confluent.io/cloud/current/connectors/offsets.html#manage-offsets-for-fully-managed-connectors-in-ccloud) + - name: Custom Connector Plugins (connect/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connector Plugins. + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connector Plugins Model + + - name: Presigned Urls (connect/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Request a presigned upload URL for new Custom Connector Plugin. Note that + the URL policy expires in one hour. If the policy expires, you can request + a new presigned upload URL. + + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Presigned Urls Model + + - name: Custom Connector Runtimes (connect/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + List of supported runtime languages for Custom Connector Plugin. The list defines the supported + entries for confluent.custom.connect.plugin.runtime attribute in CustomConnectorPlugin object. + Each entry also defines the set of supported java versions for that runtime which can be specified during + connector provisioning via the confluent.custom.connect.plugin.java.version attribute. + + + ## The Custom Connector Runtimes Model + + - name: Cluster (v3) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + - name: Configs (v3) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + - name: ACL (v3) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + - name: Consumer Group (v3) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + - name: Partition (v3) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + - name: Topic (v3) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + - name: Records (v3) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + - name: Cluster Linking (v3) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + - name: Share Group (v3) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + - name: Streams Group (v3) + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + - name: Applied Quotas (service-quota/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + A `quota` object represents a quota configuration for a specific Confluent Cloud resource. + Use this API to retrieve an individual quota or list of quotas for a given scope. + + + Related guide: [Service Quotas for Confluent Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). + + ## The Applied Quotas Model + + - name: Scopes (service-quota/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Gets a list of all available scopes for applied quotas. + + + Related guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). + + ## The Scopes Model + + - name: Entitlements (partner/v2) + description: | + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + `Entitlement` objects represent metadata about a marketplace entitlement. + + An entitlement includes metadata about a marketplace purchase + (start date, end date, billing information, partner IDs, etc). + The API allows partners to create, read, and list entitlements. (Unless you + need entitlement creation and customer registration to be separate, + we recommend using the Signup API to create an organization and entitlement + at the same time) + + The API only allows authorized partners to interact with the Entitlements API. + - name: Regions (srcm/v2) + description: |- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + `Region` objects represent cloud provider regions available when placing Schema Registry clusters. + The API allows you to list Schema Registry regions. + + + Related guides: + * [Confluent Cloud providers and region support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Regions Model + + - name: Clusters (srcm/v2) + description: |- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list, create, read, and delete your Schema Registry clusters. + + + Related guides: + * [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Clusters Model + + - name: Clusters (srcm/v3) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list and read your Schema Registry clusters. + + + Related guide: [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + ## The Clusters Model + + - name: Compatibility (v1) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + The API allows you to test schema compatibility. + + Related guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud). + - name: Config (v1) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + The API allows you to manage and query schema compatibility settings and cluster configurations. + + Related guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud). + - name: Contexts (v1) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + The API allows you to retrieve information about schema contexts. + + Related guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud). + - name: Exporters (v1) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + The API allows you to create, retrieve, update, and delete exporters. + + Related guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud). + - name: Modes (v1) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + The API allows you to create, retrieve, update, and delete schema subjects modes of operation. + + Related guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud). + - name: Schemas (v1) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + The API allows you to create, retrieve, update, and delete schemas. + + Related guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud). + - name: Subjects (v1) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + The API allows you to create, retrieve, update, and delete schema subjects and versions. + + Related guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud). + - name: Key Encryption Keys (v1) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + The API allows you to create, retrieve, update, and delete key encryption keys. + + Related guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud). + - name: Data Encryption Keys (v1) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + The API allows you to create, retrieve, update, and delete data encryption keys. + + Related guide: [Manage Schemas in Confluent Cloud](https://docs.confluent.io/cloud/current/sr/schemas-manage.html#manage-schemas-in-ccloud). +# Paths + - name: Entity (v1) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + The API allows you to create, retrieve, update, and delete catalog entities. + + Related guide: [Catalog API Documentation](https://docs.confluent.io/cloud/current/stream-governance/stream-catalog.html#catalog-api-documentation). + - name: Search (v1) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + The API allows you to search for entities. + + Related guide: [Catalog API Documentation](https://docs.confluent.io/cloud/current/stream-governance/stream-catalog.html#catalog-api-documentation). + - name: Types (v1) + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + The API allows you to create, retrieve, update, and delete catalog types such as tag definitions. + + Related guide: [Catalog API Documentation](https://docs.confluent.io/cloud/current/stream-governance/stream-catalog.html#catalog-api-documentation). + - name: Provider Shared Resources (cdx/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `ProviderSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you have shared through Stream Sharing. + + + ## The Provider Shared Resources Model + + - name: Provider Shares (cdx/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `ProviderShare` object respresents the share that you have created through Stream Sharing. + + + Related guide: [Provider Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares). + + ## The Provider Shares Model + + - name: Consumer Shared Resources (cdx/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `ConsumerSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you received through Stream Sharing. + + + ## The Consumer Shared Resources Model + + - name: Consumer Shares (cdx/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `ConsumerShare` object respresents the share that you received through Stream Sharing. + + + Related guide: [Consumer Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html). + + ## The Consumer Shares Model + + - name: Shared Tokens (cdx/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Encrypted Token shared with consumer + + + ## The Shared Tokens Model + + - name: Opt Ins (cdx/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Stream sharing opt in options + + ## The Opt Ins Model + + - name: Organizations (partner/v2) + description: | + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + `Organizations` objects represent an entire Confluent Cloud organization. + Partners are allowed to get an organization they have signed up or + list all organizations they have signed up. + - name: Signup (partner/v2) + description: | + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + `Signup` APIs can only be performed by partners. + - name: Networks (networking/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud + provider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters. + Shared networks can contain any cluster type. + + The API allows you to list, create, read, update, and delete your networks. + + + Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + ## The Networks Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `dedicated_networks_per_environment` | Number of dedicated networks per Confluent Cloud environment | + - name: Peerings (networking/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + * [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + ## The Peerings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `peerings_per_network` | Number of peerings per network | + - name: Transit Gateway Attachments (networking/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + AWS Transit Gateway Attachments + + Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + ## The Transit Gateway Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `tgw_attachments_per_network` | Number of TGW attachments per network | + - name: Private Link Accesses (networking/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID. + + Related guides: + * [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + * [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + * [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + ## The Private Link Accesses Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_accounts_per_network` | Number of AWS accounts per network | + | `private_link_subscriptions_per_network` | Number of Azure subscriptions per network | + | `private_service_connect_projects_per_network` | Number of GCP projects per network | + - name: Network Link Services (networking/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Network Link Service is associated with a Private Link Confluent Cloud Network. + It enables connectivity from other Private Link Confluent Cloud Networks based on + the configured accept policies. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Services Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_service_per_network` | Number of network link services per network | + - name: Network Link Endpoints (networking/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a + Network Link Service (associated with another Private Link Confluent Cloud Network) at the target. + It enables connectivity between the origin network and the target network. + It can only be associated with a Private Link network. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Endpoints Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_endpoints_per_network` | Number of network link endpoints per network | + - name: Network Link Service Associations (networking/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + List of incoming Network Link Enpoints associated with the Network Link Service. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Service Associations Model + + - name: IP Addresses (networking/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + IP Addresses + + Related guide: [Use Public Egress IP addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + ## The IP Addresses Model + + - name: Private Link Attachments (networking/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + PrivateLink attachment objects represent reservations to establish PrivateLink connections + to a cloud region in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachments. + + + ## The Private Link Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_attachments_per_environment` | Number of PrivateLink Attachments per environment | + - name: Private Link Attachment Connections (networking/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + PrivateLink attachment connection objects represent connections established to a cloud region + in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachment connections. + + + ## The Private Link Attachment Connections Model + + - name: Identity Providers (iam/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `IdentityProvider` objects represent external OAuth-OIDC providers in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Identity Provider. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Identity Providers Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_providers_per_org` | Number of OAuth identity providers per organization | + | `public_keys_per_provider` | Number of public keys saved per identity provider | + - name: Jwks (iam/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `JWKS` objects represent public key sets for a specific OAuth/OpenID Connect provider within + Confluent Cloud. + + The API allows you to refresh JWKS public key data. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Jwks Model + + - name: Identity Pools (iam/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `IdentityPool` objects represent groups of identities tied to a given a `IdentityProvider` + that authorizes them to Confluent Cloud resources. + + It provides a mapping functionality of your `Identity Provider` user to a Confluent identity pool that + is then used to provide access to Confluent Resources. + + + Related guide: [Use identity pools with your OAuth provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + ## The Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_provider` | Number of Identity Pools per Identity Provider | + - name: OAuth Tokens (sts/v1) + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + OAuth Token is a [JSON Web Token (JWT)](https://www.rfc-editor.org/rfc/rfc7519) that enables the use of + external identities to access Confluent Cloud APIs + - name: Client Quotas (kafka-quotas/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `ClientQuota` objects represent Client Quotas you can set at the service account level. + + The API allows you to list, create, read, update, and delete your client quotas. + + + Related guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + ## The Client Quotas Model + + - name: Keys (byok/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Key` objects represent customer managed keys on dedicated Confluent Cloud clusters. + + Keys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP. + This API allows you to upload and retrieve self-managed keys on Confluent Cloud. + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + ## The Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. | + - name: Costs (billing/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Cost` objects represent the aggregated billing costs for an organization + + + Related guide: [Retrieve costs for a range of dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates). + + ## The Costs Model + + - name: Group Mappings (iam/v2/sso) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `GroupMapping` objects establish relationships between user groups in your SSO + identity provider and specific RBAC roles in Confluent Cloud. + + Group mappings enable automated and secure access control to Confluent Cloud resources, + reducing administrative workload by streamlining user provisioning and authorization. + + + Related guide: [Use group mappings with your SSO identity provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + ## The Group Mappings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `group_mappings_per_org` | Number of group mappings per organization | + - name: Compute Pools (fcpm/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + A Compute Pool represents a set of compute resources that is used to run your Queries. + The resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it. + Note that the Compute Pool API supports a limited pagination API, only the `next` field will be populated. + + + ## The Compute Pools Model + + - name: Regions (fcpm/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Region` objects represent cloud provider regions available when placing Flink compute pools. + The API allows you to list Flink regions. + + + ## The Regions Model + + - name: Org Compute Pool Configs (fcpm/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `OrgComputePoolConfig` manages compute pool configuration settings for an organization. + The API allows you to read and update organization-wide settings such as whether default pools are enabled + and their maximum CFU limits. + + + ## The Org Compute Pool Configs Model + + - name: Statements (sql/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Statement` represents a core resource used to model SQL statements for execution. + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session + management or any higher-level functionality. + The API allows you to list, create, read, and delete your statements. + ## The Statements Model + + - name: Statement Results (sql/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `StatementResult` represents a result of a `Statement` resource. + The API allows you to read your statement's results. + ## The Statement Results Model + + - name: Statement Exceptions (sql/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `StatementException` represents an exception of a `Statement` resource. + The API allows you to read your statement's exceptions. + ## The Statement Exceptions Model + + - name: Connections (sql/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Connection` represents a core resource used to model SQL connections for execution. + A connection generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session + management or any higher-level functionality. + The API allows you to list, create, read, and delete your connections. + ## The Connections Model + + - name: Agents (sql/v1) + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + `Agent` models an AI agent that uses a specified model, prompt, and set of tools + to autonomously perform tasks. + The API allows you to create your agents. + ## The Agents Model + + - name: Tools (sql/v1) + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + `Tool` models a reusable tool resource backed by a connection that can be referenced + by agents to perform actions. + The API allows you to create your tools. + ## The Tools Model + + - name: Materialized Tables (sql/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `MaterializedTable` represents a core resource used to define and manage streaming SQL queries that persist results. + The API allows you to list, create, read, update, and delete your materialized tables. + ## The Materialized Table Model + + - name: Materialized Table Versions (sql/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `MaterializedTableVersion` represents a specific version of a Materialized Table, capturing the state and changes at that point in time. + The API allows you to list and read versions of your materialized tables. + ## The Materialized Table Version Model + + - name: DNS Forwarders (networking/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Add, remove, and update DNS forwarder for your gateway. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + ## The DNS Forwarders Model + + - name: Access Points (networking/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + AccessPoint objects represent network connections in and out of Gateways. + This API allows you to list, create, read, update, and delete your access points. + + + ## The Access Points Model + + - name: DNS Records (networking/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + DNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records. + + ## The DNS Records Model + + - name: Certificate Authorities (iam/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `CertificateAuthority` objects represent signing certificate authorities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Certificate Authority. + + + Related guide: [Manage certificate authorities used for client authentication with X.509 certificates.](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/overview.html). + + ## The Certificate Authorities Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `certificate_authorities_per_org` | Number of certificate authorities per organization | + - name: Certificate Identity Pools (iam/v2) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Identitypool` objects represent workload identities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your identity pools associated + with Certificate Authorities + + + Related guide: [Manage Certificate Identity Pools for Granular Client Access Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + ## The Certificate Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_certificate_authority` | Number of Identity Pools per Certificate Authority | + - name: Integrations (pim/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, and delete individual integrations, and also obtain a + list of all your provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + - name: Integrations (pim/v2) + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, update, delete, and validate individual integrations, and also obtain a + list of all your provider integrations. + + Note: The pim/v2 API currently supports only Azure and GCP provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + - name: Flink Artifacts (artifact/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. + + + ## The Flink Artifacts Model + + - name: Presigned Urls (artifact/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Request a presigned upload URL for new Flink Artifact. Note that + the URL policy expires in one hour. If the policy expires, you can request + a new presigned upload URL. + + + ## The Presigned Urls Model + + - name: Flink Artifact Versions (artifact/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + FlinkArtifactVersion objects represent Flink Artifact Versions on Confluent Cloud. + + + ## The Flink Artifact Versions Model + + - name: Gateways (networking/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + A Gateway represents a slice of traffic capacity in a region that is reserved for a customer. + + + ## The Gateways Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `gateways_per_region_per_environment` | Number of Gateways per region per environment | + - name: Custom Code Loggings (ccl/v1) + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Custom Code Logging API EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Code Logging. + + + ## The Custom Code Loggings Model + + - name: Regions (tableflow/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + `Region` objects represent cloud provider regions where Tableflow can be enabled. + This API allows you to list all supported Tableflow regions. + + + ## The Regions Model + + - name: Tableflow Topics (tableflow/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic + + + ## The Tableflow Topics Model + + - name: Catalog Integrations (tableflow/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + A Catalog Integration represents configuration related to a catalog integration + + + ## The Catalog Integrations Model + + - name: Custom Connect Plugins (ccpm/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + CustomConnectPlugins objects represent Custom Connect artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugins. + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connect Plugins Model + + - name: Presigned Urls (ccpm/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Request a presigned upload URL for new Custom Connect Plugin. Note that + the URL policy expires in one hour. If the policy expires, you can request + a new presigned upload URL. + + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Presigned Urls Model + + - name: Custom Connect Plugin Versions (ccpm/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + CustomConnectPluginVersion objects represent Custom Connect Plugin Versions on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugin Versions. + + + ## The Custom Connect Plugin Versions Model + + - name: Kafka Clusters (usm/v1) + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + `KafkaCluster` object represent Confluent Platform Kafka clusters registered with Confluent Cloud. + The API allows you to create and delete KafkaCluster. + + + ## The Kafka Clusters Model + + - name: Connect Clusters (usm/v1) + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + `ConnectCluster` object represent Confluent Platform Connect clusters registered with Confluent Cloud. + The API allows you to create and delete ConnectCluster. + + + ## The Connect Clusters Model + + - name: Endpoints (endpoint/v1) + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + An Endpoint object represents a Fully Qualified Domain Name (FQDN) for a Confluent service resource + via a specific networking solution for a given Confluent Cloud environment. + This API provides a list of Confluent Cloud endpoints filtered by service, cloud provider, region, etc. + + + Related guides: + * [Resource Overview in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/resource-overview.html). + * [Manage Networking on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Endpoints Model + diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/provider.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/provider.yaml new file mode 100644 index 0000000..eb1221c --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/provider.yaml @@ -0,0 +1,261 @@ +id: confluent +name: confluent +version: v00.00.00000 +providerServices: + billing: + id: billing:v00.00.00000 + name: billing + preferred: true + service: + $ref: confluent/v00.00.00000/services/billing.yaml + title: billing API + version: v00.00.00000 + description: confluent billing API + catalog: + id: catalog:v00.00.00000 + name: catalog + preferred: true + service: + $ref: confluent/v00.00.00000/services/catalog.yaml + title: catalog API + version: v00.00.00000 + description: confluent catalog API + ccl: + id: ccl:v00.00.00000 + name: ccl + preferred: true + service: + $ref: confluent/v00.00.00000/services/ccl.yaml + title: ccl API + version: v00.00.00000 + description: confluent ccl API + ccpm: + id: ccpm:v00.00.00000 + name: ccpm + preferred: true + service: + $ref: confluent/v00.00.00000/services/ccpm.yaml + title: ccpm API + version: v00.00.00000 + description: confluent ccpm API + connect: + id: connect:v00.00.00000 + name: connect + preferred: true + service: + $ref: confluent/v00.00.00000/services/connect.yaml + title: connect API + version: v00.00.00000 + description: confluent connect API + encryption_keys: + id: encryption_keys:v00.00.00000 + name: encryption_keys + preferred: true + service: + $ref: confluent/v00.00.00000/services/encryption_keys.yaml + title: encryption_keys API + version: v00.00.00000 + description: confluent encryption_keys API + endpoints: + id: endpoints:v00.00.00000 + name: endpoints + preferred: true + service: + $ref: confluent/v00.00.00000/services/endpoints.yaml + title: endpoints API + version: v00.00.00000 + description: confluent endpoints API + flink_artifacts: + id: flink_artifacts:v00.00.00000 + name: flink_artifacts + preferred: true + service: + $ref: confluent/v00.00.00000/services/flink_artifacts.yaml + title: flink_artifacts API + version: v00.00.00000 + description: confluent flink_artifacts API + flink_compute_pools: + id: flink_compute_pools:v00.00.00000 + name: flink_compute_pools + preferred: true + service: + $ref: confluent/v00.00.00000/services/flink_compute_pools.yaml + title: flink_compute_pools API + version: v00.00.00000 + description: confluent flink_compute_pools API + iam: + id: iam:v00.00.00000 + name: iam + preferred: true + service: + $ref: confluent/v00.00.00000/services/iam.yaml + title: iam API + version: v00.00.00000 + description: confluent iam API + kafka: + id: kafka:v00.00.00000 + name: kafka + preferred: true + service: + $ref: confluent/v00.00.00000/services/kafka.yaml + title: kafka API + version: v00.00.00000 + description: confluent kafka API + ksqldb_clusters: + id: ksqldb_clusters:v00.00.00000 + name: ksqldb_clusters + preferred: true + service: + $ref: confluent/v00.00.00000/services/ksqldb_clusters.yaml + title: ksqldb_clusters API + version: v00.00.00000 + description: confluent ksqldb_clusters API + managed_kafka_clusters: + id: managed_kafka_clusters:v00.00.00000 + name: managed_kafka_clusters + preferred: true + service: + $ref: confluent/v00.00.00000/services/managed_kafka_clusters.yaml + title: managed_kafka_clusters API + version: v00.00.00000 + description: confluent managed_kafka_clusters API + networking: + id: networking:v00.00.00000 + name: networking + preferred: true + service: + $ref: confluent/v00.00.00000/services/networking.yaml + title: networking API + version: v00.00.00000 + description: confluent networking API + notifications: + id: notifications:v00.00.00000 + name: notifications + preferred: true + service: + $ref: confluent/v00.00.00000/services/notifications.yaml + title: notifications API + version: v00.00.00000 + description: confluent notifications API + org: + id: org:v00.00.00000 + name: org + preferred: true + service: + $ref: confluent/v00.00.00000/services/org.yaml + title: org API + version: v00.00.00000 + description: confluent org API + partner: + id: partner:v00.00.00000 + name: partner + preferred: true + service: + $ref: confluent/v00.00.00000/services/partner.yaml + title: partner API + version: v00.00.00000 + description: confluent partner API + provider_integrations: + id: provider_integrations:v00.00.00000 + name: provider_integrations + preferred: true + service: + $ref: confluent/v00.00.00000/services/provider_integrations.yaml + title: provider_integrations API + version: v00.00.00000 + description: confluent provider_integrations API + quotas: + id: quotas:v00.00.00000 + name: quotas + preferred: true + service: + $ref: confluent/v00.00.00000/services/quotas.yaml + title: quotas API + version: v00.00.00000 + description: confluent quotas API + schema_registry: + id: schema_registry:v00.00.00000 + name: schema_registry + preferred: true + service: + $ref: confluent/v00.00.00000/services/schema_registry.yaml + title: schema_registry API + version: v00.00.00000 + description: confluent schema_registry API + schema_registry_clusters: + id: schema_registry_clusters:v00.00.00000 + name: schema_registry_clusters + preferred: true + service: + $ref: confluent/v00.00.00000/services/schema_registry_clusters.yaml + title: schema_registry_clusters API + version: v00.00.00000 + description: confluent schema_registry_clusters API + share_group: + id: share_group:v00.00.00000 + name: share_group + preferred: true + service: + $ref: confluent/v00.00.00000/services/share_group.yaml + title: share_group API + version: v00.00.00000 + description: confluent share_group API + sql: + id: sql:v00.00.00000 + name: sql + preferred: true + service: + $ref: confluent/v00.00.00000/services/sql.yaml + title: sql API + version: v00.00.00000 + description: confluent sql API + stream_sharing: + id: stream_sharing:v00.00.00000 + name: stream_sharing + preferred: true + service: + $ref: confluent/v00.00.00000/services/stream_sharing.yaml + title: stream_sharing API + version: v00.00.00000 + description: confluent stream_sharing API + streams_group: + id: streams_group:v00.00.00000 + name: streams_group + preferred: true + service: + $ref: confluent/v00.00.00000/services/streams_group.yaml + title: streams_group API + version: v00.00.00000 + description: confluent streams_group API + sts: + id: sts:v00.00.00000 + name: sts + preferred: true + service: + $ref: confluent/v00.00.00000/services/sts.yaml + title: sts API + version: v00.00.00000 + description: confluent sts API + tableflow: + id: tableflow:v00.00.00000 + name: tableflow + preferred: true + service: + $ref: confluent/v00.00.00000/services/tableflow.yaml + title: tableflow API + version: v00.00.00000 + description: confluent tableflow API + usm: + id: usm:v00.00.00000 + name: usm + preferred: true + service: + $ref: confluent/v00.00.00000/services/usm.yaml + title: usm API + version: v00.00.00000 + description: confluent usm API +config: + auth: + type: basic + username_var: CONFLUENT_CLOUD_API_KEY + password_var: CONFLUENT_CLOUD_API_SECRET diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/billing.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/billing.yaml new file mode 100644 index 0000000..7b9ff13 --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/billing.yaml @@ -0,0 +1,1070 @@ +openapi: 3.0.0 +info: + title: billing API + description: confluent billing API + version: 1.0.0 +paths: + /billing/v1/costs: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listBillingV1Costs + summary: List of Costs + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all costs. + parameters: + - name: start_date + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: '2022-10-12' + description: Filter the results by exact match for start_date. + - name: end_date + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: '2022-10-15' + description: Filter the results by exact match for end_date. + - name: page_size + in: query + required: false + schema: + type: integer + default: 5000 + maximum: 10000 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Costs (billing/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cost. + content: + application/json: + schema: + type: object + description: >- + `Cost` objects represent the aggregated billing costs for an + organization + + + + Related guide: [Retrieve costs for a range of + dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates). + + + ## The Costs Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - billing/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CostList + metadata: + type: object + description: >- + CostListMeta describes metadata that resource collections + may have + properties: + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Cost` objects represent the aggregated billing costs + for an organization + + + + Related guide: [Retrieve costs for a range of + dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates). + + + ## The Costs Model + + + properties: + api_version: + type: string + enum: + - billing/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Cost + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + start_date: + type: string + format: date + example: '2022-10-12' + description: >- + Start date of time period (inclusive) to retrieve + billing costs. It is represented in RFC3339 format + and is in UTC. + end_date: + type: string + format: date + example: '2022-10-15' + description: >- + End date of time period (exclusive) to retrieve + billing costs. It is represented in RFC3339 format + and is in UTC. + granularity: + type: string + x-extensible-enum: + - DAILY + default: DAILY + description: Granularity at which each line item is aggregated. + network_access_type: + type: string + x-extensible-enum: + - INTERNET + - TRANSIT_GATEWAY + - PRIVATE_LINK + - PEERED_VPC + - PNI + - MULTI + example: INTERNET + description: Network access type for the cluster. + product: + type: string + x-extensible-enum: + - KAFKA + - CONNECT + - KSQL + - AUDIT_LOG + - STREAM_GOVERNANCE + - CLUSTER_LINK + - CUSTOM_CONNECT + - FLINK + - TABLEFLOW + - SUPPORT_CLOUD_BASIC + - SUPPORT_CLOUD_DEVELOPER + - SUPPORT_CLOUD_BUSINESS + - SUPPORT_CLOUD_PREMIER + - USM + example: KAFKA + description: Product name. + line_type: + type: string + x-extensible-enum: + - KAFKA_STORAGE + - KAFKA_PARTITION + - KAFKA_NETWORK_READ + - KAFKA_NETWORK_WRITE + - KAFKA_BASE + - KAFKA_NUM_CKUS + - KAFKA_REST_PRODUCE + - KSQL_NUM_CSUS + - CONNECT_CAPACITY + - CONNECT_NUM_TASKS + - CONNECT_THROUGHPUT + - CONNECT_NUM_RECORDS + - SUPPORT + - CLUSTER_LINKING_PER_LINK + - CLUSTER_LINKING_WRITE + - CLUSTER_LINKING_READ + - AUDIT_LOG_READ + - GOVERNANCE_BASE + - SCHEMA_REGISTRY + - PROMO_CREDIT + - CUSTOM_CONNECT_NUM_TASKS + - CUSTOM_CONNECT_THROUGHPUT + - NUM_RULES + - FLINK_NUM_CFUS + - TABLEFLOW_DATA_PROCESSED + - TABLEFLOW_NUM_TOPICS + - TABLEFLOW_STORAGE + - USM_CONNECTED_NODE + - KAFKA_STREAMS + example: KAFKA_NUM_CKUS + description: Type of the line item. + price: + type: number + format: double + example: 1.5 + description: Price for the line item in dollars. + unit: + type: string + example: GB + description: Unit of the line item. + quantity: + type: number + format: double + example: 99.9 + description: Quantity of the line item. + original_amount: + type: number + format: double + example: 149.85 + description: Original amount accrued for this line item. + discount_amount: + type: number + format: double + example: 20.85 + description: >- + Amount discounted from the original amount in + dollars. + amount: + type: number + format: double + example: 129 + description: Final amount after deducting discounts. + description: + type: string + example: KAFKA101 + description: Additional details about promotional offers/credits. + tier_dimensions: + type: object + additionalProperties: + type: string + description: >- + Tier dimensions which exist for tiered pricing cost + items only. + x-go-type: map[string]string + example: + provider: aws + region: us-east-1 + connector_type: BigQuerySink + resource: + description: The resource for a given object + type: object + properties: + id: + type: string + description: ID of the resource. + example: lkc-12345 + display_name: + type: string + description: Display name of the resource. + example: prod-kafka-cluster + environment: + description: The environment associated with this resource + nullable: true + type: object + properties: + id: + type: string + description: ID of the environment. + example: env-123 + required: + - id + - start_date + - end_date + - unit + - original_amount + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + billing.v1.CostList: + type: object + description: >- + `Cost` objects represent the aggregated billing costs for an + organization + + + + Related guide: [Retrieve costs for a range of + dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates). + + + ## The Costs Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - billing/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CostList + metadata: + type: object + description: CostListMeta describes metadata that resource collections may have + properties: + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Cost` objects represent the aggregated billing costs for an + organization + + + + Related guide: [Retrieve costs for a range of + dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates). + + + ## The Costs Model + + + properties: + api_version: + type: string + enum: + - billing/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cost + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + start_date: + type: string + format: date + example: '2022-10-12' + description: >- + Start date of time period (inclusive) to retrieve billing + costs. It is represented in RFC3339 format and is in UTC. + end_date: + type: string + format: date + example: '2022-10-15' + description: >- + End date of time period (exclusive) to retrieve billing costs. + It is represented in RFC3339 format and is in UTC. + granularity: + type: string + x-extensible-enum: + - DAILY + default: DAILY + description: Granularity at which each line item is aggregated. + network_access_type: + type: string + x-extensible-enum: + - INTERNET + - TRANSIT_GATEWAY + - PRIVATE_LINK + - PEERED_VPC + - PNI + - MULTI + example: INTERNET + description: Network access type for the cluster. + product: + type: string + x-extensible-enum: + - KAFKA + - CONNECT + - KSQL + - AUDIT_LOG + - STREAM_GOVERNANCE + - CLUSTER_LINK + - CUSTOM_CONNECT + - FLINK + - TABLEFLOW + - SUPPORT_CLOUD_BASIC + - SUPPORT_CLOUD_DEVELOPER + - SUPPORT_CLOUD_BUSINESS + - SUPPORT_CLOUD_PREMIER + - USM + example: KAFKA + description: Product name. + line_type: + type: string + x-extensible-enum: + - KAFKA_STORAGE + - KAFKA_PARTITION + - KAFKA_NETWORK_READ + - KAFKA_NETWORK_WRITE + - KAFKA_BASE + - KAFKA_NUM_CKUS + - KAFKA_REST_PRODUCE + - KSQL_NUM_CSUS + - CONNECT_CAPACITY + - CONNECT_NUM_TASKS + - CONNECT_THROUGHPUT + - CONNECT_NUM_RECORDS + - SUPPORT + - CLUSTER_LINKING_PER_LINK + - CLUSTER_LINKING_WRITE + - CLUSTER_LINKING_READ + - AUDIT_LOG_READ + - GOVERNANCE_BASE + - SCHEMA_REGISTRY + - PROMO_CREDIT + - CUSTOM_CONNECT_NUM_TASKS + - CUSTOM_CONNECT_THROUGHPUT + - NUM_RULES + - FLINK_NUM_CFUS + - TABLEFLOW_DATA_PROCESSED + - TABLEFLOW_NUM_TOPICS + - TABLEFLOW_STORAGE + - USM_CONNECTED_NODE + - KAFKA_STREAMS + example: KAFKA_NUM_CKUS + description: Type of the line item. + price: + type: number + format: double + example: 1.5 + description: Price for the line item in dollars. + unit: + type: string + example: GB + description: Unit of the line item. + quantity: + type: number + format: double + example: 99.9 + description: Quantity of the line item. + original_amount: + type: number + format: double + example: 149.85 + description: Original amount accrued for this line item. + discount_amount: + type: number + format: double + example: 20.85 + description: Amount discounted from the original amount in dollars. + amount: + type: number + format: double + example: 129 + description: Final amount after deducting discounts. + description: + type: string + example: KAFKA101 + description: Additional details about promotional offers/credits. + tier_dimensions: + type: object + additionalProperties: + type: string + description: >- + Tier dimensions which exist for tiered pricing cost items + only. + x-go-type: map[string]string + example: + provider: aws + region: us-east-1 + connector_type: BigQuerySink + resource: + description: The resource for a given object + type: object + properties: + id: + type: string + description: ID of the resource. + example: lkc-12345 + display_name: + type: string + description: Display name of the resource. + example: prod-kafka-cluster + environment: + description: The environment associated with this resource + nullable: true + type: object + properties: + id: + type: string + description: ID of the environment. + example: env-123 + required: + - id + - start_date + - end_date + - unit + - original_amount + uniqueItems: true + CostListMeta: + type: object + description: CostListMeta describes metadata that resource collections may have + properties: + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + billing.v1.Cost: + type: object + description: >- + `Cost` objects represent the aggregated billing costs for an + organization + + + + Related guide: [Retrieve costs for a range of + dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates). + + + ## The Costs Model + + + properties: + api_version: + type: string + enum: + - billing/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cost + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + start_date: + type: string + format: date + example: '2022-10-12' + description: >- + Start date of time period (inclusive) to retrieve billing costs. It + is represented in RFC3339 format and is in UTC. + end_date: + type: string + format: date + example: '2022-10-15' + description: >- + End date of time period (exclusive) to retrieve billing costs. It is + represented in RFC3339 format and is in UTC. + granularity: + type: string + x-extensible-enum: + - DAILY + default: DAILY + description: Granularity at which each line item is aggregated. + network_access_type: + type: string + x-extensible-enum: + - INTERNET + - TRANSIT_GATEWAY + - PRIVATE_LINK + - PEERED_VPC + - PNI + - MULTI + example: INTERNET + description: Network access type for the cluster. + product: + type: string + x-extensible-enum: + - KAFKA + - CONNECT + - KSQL + - AUDIT_LOG + - STREAM_GOVERNANCE + - CLUSTER_LINK + - CUSTOM_CONNECT + - FLINK + - TABLEFLOW + - SUPPORT_CLOUD_BASIC + - SUPPORT_CLOUD_DEVELOPER + - SUPPORT_CLOUD_BUSINESS + - SUPPORT_CLOUD_PREMIER + - USM + example: KAFKA + description: Product name. + line_type: + type: string + x-extensible-enum: + - KAFKA_STORAGE + - KAFKA_PARTITION + - KAFKA_NETWORK_READ + - KAFKA_NETWORK_WRITE + - KAFKA_BASE + - KAFKA_NUM_CKUS + - KAFKA_REST_PRODUCE + - KSQL_NUM_CSUS + - CONNECT_CAPACITY + - CONNECT_NUM_TASKS + - CONNECT_THROUGHPUT + - CONNECT_NUM_RECORDS + - SUPPORT + - CLUSTER_LINKING_PER_LINK + - CLUSTER_LINKING_WRITE + - CLUSTER_LINKING_READ + - AUDIT_LOG_READ + - GOVERNANCE_BASE + - SCHEMA_REGISTRY + - PROMO_CREDIT + - CUSTOM_CONNECT_NUM_TASKS + - CUSTOM_CONNECT_THROUGHPUT + - NUM_RULES + - FLINK_NUM_CFUS + - TABLEFLOW_DATA_PROCESSED + - TABLEFLOW_NUM_TOPICS + - TABLEFLOW_STORAGE + - USM_CONNECTED_NODE + - KAFKA_STREAMS + example: KAFKA_NUM_CKUS + description: Type of the line item. + price: + type: number + format: double + example: 1.5 + description: Price for the line item in dollars. + unit: + type: string + example: GB + description: Unit of the line item. + quantity: + type: number + format: double + example: 99.9 + description: Quantity of the line item. + original_amount: + type: number + format: double + example: 149.85 + description: Original amount accrued for this line item. + discount_amount: + type: number + format: double + example: 20.85 + description: Amount discounted from the original amount in dollars. + amount: + type: number + format: double + example: 129 + description: Final amount after deducting discounts. + description: + type: string + example: KAFKA101 + description: Additional details about promotional offers/credits. + tier_dimensions: + type: object + additionalProperties: + type: string + description: Tier dimensions which exist for tiered pricing cost items only. + x-go-type: map[string]string + example: + provider: aws + region: us-east-1 + connector_type: BigQuerySink + resource: + description: The resource for a given object + type: object + properties: + id: + type: string + description: ID of the resource. + example: lkc-12345 + display_name: + type: string + description: Display name of the resource. + example: prod-kafka-cluster + environment: + description: The environment associated with this resource + nullable: true + type: object + properties: + id: + type: string + description: ID of the environment. + example: env-123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + billing.v1.Resource: + type: object + description: > + The resource associated with this object. The resource can be one of + Kafka Cluster ID (example: lkc-12345), + + Connector ID (example: + lcc-12345), Schema Registry Cluster ID (example: lsrc-12345), or ksqlDB Cluster ID + (example: lksqlc-12345). + + May be null or omitted if not associated with a resource. + properties: + id: + type: string + description: ID of the resource. + example: lkc-12345 + display_name: + type: string + description: Display name of the resource. + example: prod-kafka-cluster + environment: + description: The environment associated with this resource + nullable: true + type: object + properties: + id: + type: string + description: ID of the environment. + example: env-123 + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + billing.v1.Environment: + type: object + description: | + The details of the environment for a given resource. + properties: + id: + type: string + description: ID of the environment. + example: env-123 + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + x-stackQL-resources: + costs: + id: confluent.billing.costs + name: costs + title: Costs + methods: + list_billing_v1_costs: + operation: + $ref: '#/paths/~1billing~1v1~1costs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/costs/methods/list_billing_v1_costs + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/catalog.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/catalog.yaml new file mode 100644 index 0000000..503e3fa --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/catalog.yaml @@ -0,0 +1,2078 @@ +openapi: 3.0.0 +info: + title: catalog API + description: confluent catalog API + version: 1.0.0 +paths: + /catalog/v1/types/businessmetadatadefs: + get: + summary: Bulk Read Business Metadata Definitions + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Bulk retrieval API for retrieving business metadata definitions. + operationId: getAllBusinessMetadataDefs + tags: + - Types (v1) + parameters: + - description: The prefix of a business metadata definition name + explode: true + in: query + name: prefix + required: false + schema: + type: string + style: form + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataDefResponse' + type: array + description: The business metadata definitions + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + post: + summary: Bulk Create Business Metadata Definitions + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Bulk create API for business metadata definitions. + operationId: createBusinessMetadataDefs + tags: + - Types (v1) + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataDef' + type: array + description: The business metadata definitions to create + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataDefResponse' + type: array + description: >- + The business metadata definitions. Errored business metadata + definitions will have an additional error property. + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + put: + summary: Bulk Update Business Metadata Definitions + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Bulk update API for business metadata definitions. + operationId: updateBusinessMetadataDefs + tags: + - Types (v1) + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataDef' + type: array + description: The business metadata definitions to update + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataDefResponse' + type: array + description: >- + The business metadata definitions. Errored business metadata + definitions will have an additional error property. + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: >- + Confluent Cloud Schema Registry Endpoint. For example + https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/types/businessmetadatadefs/{bmName}: + delete: + summary: Delete Business Metadata Definition + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Delete API for business metadata definition identified by its name. + operationId: deleteBusinessMetadataDef + tags: + - Types (v1) + parameters: + - description: The name of the business metadata definition + explode: false + in: path + name: bmName + required: true + schema: + type: string + style: simple + responses: + '204': + description: No Content + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + get: + summary: Read Business Metadata Definition + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Get the business metadata definition with the given name. + operationId: getBusinessMetadataDefByName + tags: + - Types (v1) + parameters: + - description: The name of the business metadata definition + explode: false + in: path + name: bmName + required: true + schema: + type: string + style: simple + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BusinessMetadataDef' + description: The business metadata definition + '400': + description: Bad Request + '404': + description: Business metadata definition not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: >- + Confluent Cloud Schema Registry Endpoint. For example + https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity/businessmetadata: + post: + summary: Bulk Create Business Metadata + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Bulk API to create multiple business metadata. + operationId: createBusinessMetadata + tags: + - Entity (v1) + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadata' + type: array + description: The business metadata + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataResponse' + type: array + description: >- + The business metadata. Errored business metadata will have an + additional error property. + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + put: + summary: Bulk Update Business Metadata + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Bulk API to update multiple business metadata. + operationId: updateBusinessMetadata + tags: + - Entity (v1) + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadata' + type: array + description: The business metadata + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataResponse' + type: array + description: >- + The business metadata. Errored business metadata will have an + additional error property. + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: >- + Confluent Cloud Schema Registry Endpoint. For example + https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata: + get: + summary: Read Business Metadata for an Entity + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Gets the list of business metadata for a given entity represented + + by a qualified name. + operationId: getBusinessMetadata + tags: + - Entity (v1) + parameters: + - description: The type of the entity + explode: false + in: path + name: typeName + required: true + schema: + type: string + style: simple + - description: The qualified name of the entity + explode: false + in: path + name: qualifiedName + required: true + schema: + type: string + style: simple + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataResponse' + type: array + description: The business metadata + '400': + description: Bad Request + '404': + description: Entity not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: >- + Confluent Cloud Schema Registry Endpoint. For example + https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}: + delete: + summary: Delete a Business Metadata for an Entity + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Delete a business metadata on an entity. + operationId: deleteBusinessMetadata + tags: + - Entity (v1) + parameters: + - description: The type of the entity + explode: false + in: path + name: typeName + required: true + schema: + type: string + style: simple + - description: The qualified name of the entity + explode: false + in: path + name: qualifiedName + required: true + schema: + type: string + style: simple + - description: The name of the business metadata + explode: false + in: path + name: bmName + required: true + schema: + type: string + style: simple + responses: + '204': + description: No Content + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: >- + Confluent Cloud Schema Registry Endpoint. For example + https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity/tags: + put: + summary: Bulk Update Tags + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Bulk API to update multiple tags. + tags: + - Entity (v1) + operationId: updateTags + requestBody: + description: The tags + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tag' + responses: + '200': + description: The tags. Errored tags will have an additional error property. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagResponse' + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + post: + summary: Bulk Create Tags + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Bulk API to create multiple tags. + tags: + - Entity (v1) + operationId: createTags + requestBody: + description: The tags + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tag' + responses: + '200': + description: The tags. Errored tags will have an additional error property. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagResponse' + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: >- + Confluent Cloud Schema Registry Endpoint. For example + https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity/type/{typeName}/name/{qualifiedName}: + get: + summary: Read an Entity + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Fetch complete definition of an entity given its type and unique + attribute. + operationId: getByUniqueAttributes + parameters: + - name: typeName + in: path + description: The type of the entity + required: true + schema: + type: string + - name: qualifiedName + in: path + description: The qualified name of the entity + required: true + schema: + type: string + - name: minExtInfo + in: query + description: Whether to populate on header and schema attributes + schema: + type: boolean + default: false + - name: ignoreRelationships + in: query + description: Whether to ignore relationships + schema: + type: boolean + default: false + tags: + - Entity (v1) + responses: + '200': + description: The entity + content: + application/json: + schema: + $ref: '#/components/schemas/EntityWithExtInfo' + '400': + description: Bad Request + '404': + description: Entity not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: >- + Confluent Cloud Schema Registry Endpoint. For example + https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags: + get: + summary: Read Tags for an Entity + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Gets the list of tags for a given entity represented by a qualified + name. + operationId: getTags + parameters: + - name: typeName + in: path + description: The type of the entity + required: true + schema: + type: string + - name: qualifiedName + in: path + description: The qualified name of the entity + required: true + schema: + type: string + tags: + - Entity (v1) + responses: + '200': + description: The tags + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagResponse' + '400': + description: Bad Request + '404': + description: Entity not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: >- + Confluent Cloud Schema Registry Endpoint. For example + https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity: + put: + summary: Update an Entity Attribute + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Partially update an entity attribute. + operationId: partialEntityUpdate + requestBody: + description: The entity to update + content: + application/json: + schema: + $ref: '#/components/schemas/EntityWithExtInfo' + tags: + - Entity (v1) + responses: + '200': + description: The updated entity + content: + application/json: + schema: + $ref: '#/components/schemas/EntityPartialUpdateResponse' + '400': + description: Bad Request + '404': + description: Entity not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: >- + Confluent Cloud Schema Registry Endpoint. For example + https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}: + delete: + summary: Delete a Tag for an Entity + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Delete a tag for an entity. + operationId: deleteTag + parameters: + - name: typeName + in: path + description: The type of the entity + required: true + schema: + type: string + - name: qualifiedName + in: path + description: The qualified name of the entity + required: true + schema: + type: string + - name: tagName + in: path + description: The name of the tag + required: true + schema: + type: string + tags: + - Entity (v1) + responses: + '204': + description: No Content + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: >- + Confluent Cloud Schema Registry Endpoint. For example + https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/search/attribute: + get: + summary: Search by Attribute + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve data for the specified attribute search query. + operationId: searchUsingAttribute + parameters: + - name: type + in: query + description: Limit the result to only entities of specified types + style: form + explode: true + schema: + type: array + items: + type: string + - name: attr + in: query + description: One of more additional attributes to return in the response + style: form + explode: true + schema: + type: array + items: + type: string + - name: attrName + in: query + description: The attribute to search + style: form + explode: true + schema: + type: array + items: + type: string + - name: attrValuePrefix + in: query + description: The prefix for the attribute value to search + style: form + explode: true + schema: + type: array + items: + type: string + - name: tag + in: query + description: Limit the result to only entities tagged with the given tag + schema: + type: string + - name: sortBy + in: query + description: An attribute to sort by + schema: + type: string + - name: sortOrder + in: query + description: Sort order, either ASCENDING (default) or DESCENDING + schema: + type: string + enum: + - ASCENDING + - DESCENDING + - name: deleted + in: query + description: Whether to include deleted entities + schema: + type: boolean + - name: limit + in: query + description: Limit the result set to only include the specified number of entries + schema: + type: integer + format: int32 + - name: offset + in: query + description: Start offset of the result set (useful for pagination) + schema: + type: integer + format: int32 + tags: + - Search (v1) + responses: + '200': + description: >- + On successful search query with some results, might return an empty + list if execution succeeded without any results + content: + application/json: + schema: + $ref: '#/components/schemas/SearchResult' + '400': + description: Invalid wildcard or query parameters + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: >- + Confluent Cloud Schema Registry Endpoint. For example + https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/search/basic: + get: + summary: Search by Fulltext Query + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve data for the specified fulltext query. + operationId: searchUsingBasic + parameters: + - name: query + in: query + description: The full-text query + schema: + type: string + - name: type + in: query + description: Limit the result to only entities of specified types + style: form + explode: true + schema: + type: array + items: + type: string + - name: attr + in: query + description: One of more additional attributes to return in the response + style: form + explode: true + schema: + type: array + items: + type: string + - name: tag + in: query + description: Limit the result to only entities tagged with the given tag + schema: + type: string + - name: sortBy + in: query + description: An attribute to sort by + schema: + type: string + - name: sortOrder + in: query + description: Sort order, either ASCENDING (default) or DESCENDING + schema: + type: string + enum: + - ASCENDING + - DESCENDING + - name: deleted + in: query + description: Whether to include deleted entities + schema: + type: boolean + - name: limit + in: query + description: Limit the result set to only include the specified number of entries + schema: + type: integer + format: int32 + - name: offset + in: query + description: Start offset of the result set (useful for pagination) + schema: + type: integer + format: int32 + tags: + - Search (v1) + responses: + '200': + description: >- + On successful fulltext query with some results, might return an + empty list if execution succeeded without any results + content: + application/json: + schema: + $ref: '#/components/schemas/SearchResult' + '400': + description: Invalid fulltext or query parameters + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: >- + Confluent Cloud Schema Registry Endpoint. For example + https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/types/tagdefs: + get: + summary: Bulk Read Tag Definitions + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Bulk retrieval API for retrieving tag definitions. + operationId: getAllTagDefs + parameters: + - name: prefix + in: query + description: The prefix of a tag definition name + schema: + type: string + tags: + - Types (v1) + responses: + '200': + description: The tag definitions + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagDefResponse' + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + put: + summary: Bulk Update Tag Definitions + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Bulk update API for tag definitions. + tags: + - Types (v1) + operationId: updateTagDefs + requestBody: + description: The tag definitions to update + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagDef' + responses: + '200': + description: >- + The tag definitions. Errored tag definitions will have an additional + error property. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagDefResponse' + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + post: + summary: Bulk Create Tag Definitions + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Bulk create API for tag definitions. + tags: + - Types (v1) + operationId: createTagDefs + requestBody: + description: The tag definitions to create + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagDef' + responses: + '200': + description: >- + The tag definitions. Errored tag definitions will have an additional + error property. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagDefResponse' + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: >- + Confluent Cloud Schema Registry Endpoint. For example + https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/types/tagdefs/{tagName}: + get: + summary: Read Tag Definition + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Get the tag definition with the given name. + operationId: getTagDefByName + parameters: + - name: tagName + in: path + description: The name of the tag definiton + required: true + schema: + type: string + tags: + - Types (v1) + responses: + '200': + description: The tag definition + content: + application/json: + schema: + $ref: '#/components/schemas/TagDef' + '400': + description: Bad Request + '404': + description: Tag definition not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + delete: + summary: Delete Tag Definition + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Delete API for tag definition identified by its name. + operationId: deleteTagDef + parameters: + - name: tagName + in: path + description: The name of the tag definition + required: true + schema: + type: string + tags: + - Types (v1) + responses: + '204': + description: No Content + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: >- + Confluent Cloud Schema Registry Endpoint. For example + https://psrc-00000.region.provider.confluent.cloud +components: + schemas: + BusinessMetadataDefResponse: + properties: + category: + enum: + - PRIMITIVE + - OBJECT_ID_TYPE + - ENUM + - STRUCT + - CLASSIFICATION + - ENTITY + - ARRAY + - MAP + - RELATIONSHIP + - BUSINESS_METADATA + type: string + description: The category + guid: + type: string + description: The internal guid + createdBy: + type: string + description: The creator + updatedBy: + type: string + description: The updater + createTime: + format: int64 + type: integer + description: The create time + updateTime: + format: int64 + type: integer + description: The update time + version: + format: int32 + type: integer + description: The version + name: + type: string + description: The name + description: + type: string + description: The description + typeVersion: + type: string + description: The type version + serviceType: + type: string + description: The service type + options: + additionalProperties: + type: string + type: object + description: The options + attributeDefs: + items: + $ref: '#/components/schemas/AttributeDef' + type: array + description: The attribute definitions + error: + $ref: '#/components/schemas/ErrorMessage' + type: object + BusinessMetadataDef: + properties: + category: + enum: + - PRIMITIVE + - OBJECT_ID_TYPE + - ENUM + - STRUCT + - CLASSIFICATION + - ENTITY + - ARRAY + - MAP + - RELATIONSHIP + - BUSINESS_METADATA + type: string + description: The category + guid: + type: string + description: The internal guid + createdBy: + type: string + description: The creator + updatedBy: + type: string + description: The updater + createTime: + format: int64 + type: integer + description: The create time + updateTime: + format: int64 + type: integer + description: The update time + version: + format: int32 + type: integer + description: The version + name: + type: string + description: The name + description: + type: string + description: The description + typeVersion: + type: string + description: The type version + serviceType: + type: string + description: The service type + options: + additionalProperties: + type: string + type: object + description: The options + attributeDefs: + items: + $ref: '#/components/schemas/AttributeDef' + type: array + description: The attribute definitions + type: object + BusinessMetadata: + properties: + typeName: + type: string + description: The business metadata name + attributes: + type: string + description: The business metadata attributes (opaque JSON object) + entityType: + type: string + description: The entity type + entityName: + type: string + description: The qualified name of the entity + type: object + BusinessMetadataResponse: + properties: + typeName: + type: string + description: The business metadata name + attributes: + type: string + description: The business metadata attributes (opaque JSON object) + entityType: + type: string + description: The entity type + entityName: + type: string + description: The qualified name of the entity + error: + $ref: '#/components/schemas/ErrorMessage' + type: object + Tag: + type: object + properties: + typeName: + type: string + description: The tag name + attributes: + type: string + description: The tag attributes (opaque JSON object) + entityGuid: + type: string + description: The internal entity guid + entityStatus: + type: string + description: The entity status + enum: + - ACTIVE + - DELETED + - PURGED + propagate: + type: boolean + description: Whether to propagate the tag + validityPeriods: + type: array + description: The validity periods + items: + $ref: '#/components/schemas/TimeBoundary' + removePropagationsOnEntityDelete: + type: boolean + description: Whether to remove propagations on entity delete + entityType: + type: string + description: The entity type + entityName: + type: string + description: The qualified name of the entity + TagResponse: + type: object + properties: + typeName: + type: string + description: The tag name + attributes: + type: string + description: The tag attributes (opaque JSON object) + entityGuid: + type: string + description: The internal entity guid + entityStatus: + type: string + description: The entity status + enum: + - ACTIVE + - DELETED + - PURGED + propagate: + type: boolean + description: Whether to propagate the tag + validityPeriods: + type: array + description: The validity periods + items: + $ref: '#/components/schemas/TimeBoundary' + removePropagationsOnEntityDelete: + type: boolean + description: Whether to remove propagations on entity delete + entityType: + type: string + description: The entity type + entityName: + type: string + description: The qualified name of the entity + error: + $ref: '#/components/schemas/ErrorMessage' + EntityWithExtInfo: + type: object + properties: + referredEntities: + type: object + description: The referred entities + additionalProperties: + $ref: '#/components/schemas/Entity' + entity: + $ref: '#/components/schemas/Entity' + EntityPartialUpdateResponse: + type: object + properties: + mutatedEntities: + $ref: '#/components/schemas/EntityPartialUpdate' + description: The type name + SearchResult: + type: object + properties: + searchParameters: + $ref: '#/components/schemas/SearchParams' + types: + type: array + description: The types + items: + type: string + entities: + type: array + description: The entities + items: + $ref: '#/components/schemas/EntityHeader' + referredEntities: + type: object + description: The referred entities + additionalProperties: + $ref: '#/components/schemas/EntityHeader' + TagDefResponse: + type: object + properties: + category: + type: string + description: The category + enum: + - PRIMITIVE + - OBJECT_ID_TYPE + - ENUM + - STRUCT + - CLASSIFICATION + - ENTITY + - ARRAY + - MAP + - RELATIONSHIP + - BUSINESS_METADATA + guid: + type: string + description: The internal guid + createdBy: + type: string + description: The creator + updatedBy: + type: string + description: The updater + createTime: + type: integer + description: The create time + format: int64 + updateTime: + type: integer + description: The update time + format: int64 + version: + type: integer + description: The version + format: int32 + name: + type: string + description: The name + description: + type: string + description: The description + typeVersion: + type: string + description: The type version + serviceType: + type: string + description: The service type + options: + type: object + description: The options + additionalProperties: + type: string + attributeDefs: + type: array + description: The attribute definitions + items: + $ref: '#/components/schemas/AttributeDef' + superTypes: + uniqueItems: true + type: array + description: The supertypes + items: + type: string + entityTypes: + uniqueItems: true + type: array + description: The entity types + items: + type: string + subTypes: + uniqueItems: true + type: array + description: The subtypes + items: + type: string + error: + $ref: '#/components/schemas/ErrorMessage' + TagDef: + type: object + properties: + category: + type: string + description: The category + enum: + - PRIMITIVE + - OBJECT_ID_TYPE + - ENUM + - STRUCT + - CLASSIFICATION + - ENTITY + - ARRAY + - MAP + - RELATIONSHIP + - BUSINESS_METADATA + guid: + type: string + description: The internal guid + createdBy: + type: string + description: The creator + updatedBy: + type: string + description: The updater + createTime: + type: integer + description: The create time + format: int64 + updateTime: + type: integer + description: The update time + format: int64 + version: + type: integer + description: The version + format: int32 + name: + type: string + description: The name + description: + type: string + description: The description + typeVersion: + type: string + description: The type version + serviceType: + type: string + description: The service type + options: + type: object + description: The options + additionalProperties: + type: string + attributeDefs: + type: array + description: The attribute definitions + items: + $ref: '#/components/schemas/AttributeDef' + superTypes: + uniqueItems: true + type: array + description: The supertypes + items: + type: string + entityTypes: + uniqueItems: true + type: array + description: The entity types + items: + type: string + subTypes: + uniqueItems: true + type: array + description: The subtypes + items: + type: string + AttributeDef: + type: object + properties: + name: + type: string + description: The name + typeName: + type: string + description: The type name + isOptional: + type: boolean + description: Whether is optional + cardinality: + type: string + description: The cardinality + enum: + - SINGLE + - LIST + - SET + valuesMinCount: + type: integer + description: The values min count + format: int32 + valuesMaxCount: + type: integer + description: The values max count + format: int32 + isUnique: + type: boolean + description: Whether is unique + isIndexable: + type: boolean + description: Whether is indexable + includeInNotification: + type: boolean + description: Whether to include in notifications + defaultValue: + type: string + description: The default value + description: + type: string + description: The description + searchWeight: + type: integer + description: The search weight + format: int32 + indexType: + type: string + description: The index type + enum: + - DEFAULT + - STRING + constraints: + type: array + description: The constraints + items: + $ref: '#/components/schemas/ConstraintDef' + options: + type: object + description: The options + additionalProperties: + type: string + displayName: + type: string + description: The display name + ErrorMessage: + type: object + properties: + error_code: + type: integer + description: The error code + format: int32 + message: + type: string + description: The error message + description: Error message of this operation + TimeBoundary: + type: object + properties: + startTime: + type: string + description: The start time of format yyyy/MM/dd HH:mm:ss + endTime: + type: string + description: The end time of format yyyy/MM/dd HH:mm:ss + timeZone: + type: string + description: The time zone (see java.util.TimeZone) + Entity: + type: object + description: The entity + properties: + typeName: + type: string + description: The type name + attributes: + type: string + description: The type attributes (opaque JSON object) + guid: + type: string + description: The internal guid + homeId: + type: string + description: The home id + isProxy: + type: boolean + description: Whether is a proxy + writeOnly: true + isIncomplete: + type: boolean + description: Whether is incomplete + provenanceType: + type: integer + description: The provenance type + format: int32 + status: + type: string + description: The status + enum: + - ACTIVE + - DELETED + - PURGED + createdBy: + type: string + description: The creator + updatedBy: + type: string + description: The updater + createTime: + type: integer + description: The create time + format: int64 + updateTime: + type: integer + description: The update time + format: int64 + version: + type: integer + description: The version + format: int32 + relationshipAttributes: + type: string + description: The relationship attributes (opaque JSON object) + classifications: + type: array + description: The classifications (tags) + items: + $ref: '#/components/schemas/Classification' + meanings: + type: array + description: The meanings + items: + $ref: '#/components/schemas/TermAssignmentHeader' + customAttributes: + type: object + description: The custom attributes + additionalProperties: + type: string + businessAttributes: + type: object + description: The business attributes + additionalProperties: + type: string + description: (opaque JSON object) + labels: + uniqueItems: true + type: array + description: The labels + items: + type: string + proxy: + type: boolean + description: Whether is a proxy + EntityPartialUpdate: + type: object + properties: + UPDATE: + type: array + description: The updated entities. + items: + $ref: '#/components/schemas/PartialUpdateParams' + description: The updated entities. + SearchParams: + type: object + description: Search paramas to filter results + properties: + includeDeleted: + type: boolean + description: Whether to include deleted + limit: + type: integer + description: The limit + format: int32 + offset: + type: integer + description: The offset + format: int32 + EntityHeader: + type: object + properties: + typeName: + type: string + description: The type name + attributes: + type: object + description: The attributes + additionalProperties: true + guid: + type: string + description: The internal guid + status: + type: string + description: The status + enum: + - ACTIVE + - DELETED + - PURGED + displayText: + type: string + description: The display text + classificationNames: + type: array + description: The classification (tag) names + items: + type: string + classifications: + type: array + description: The classifications (tags) + items: + $ref: '#/components/schemas/Classification' + meaningNames: + type: array + description: The meaning names + items: + type: string + meanings: + type: array + description: The meanings + items: + $ref: '#/components/schemas/TermAssignmentHeader' + isIncomplete: + type: boolean + description: Whether is incomplete + labels: + uniqueItems: true + type: array + description: The labels + items: + type: string + ConstraintDef: + type: object + properties: + type: + type: string + description: The type + params: + type: object + description: The params + additionalProperties: + type: string + description: (opaque JSON object) + Classification: + type: object + properties: + typeName: + type: string + description: The tag name + attributes: + type: object + description: The tag attributes + additionalProperties: + type: string + description: (opaque JSON object) + entityGuid: + type: string + description: The internal entity guid + entityStatus: + type: string + description: The entity status + enum: + - ACTIVE + - DELETED + - PURGED + propagate: + type: boolean + description: Whether to propagate the tag + validityPeriods: + type: array + description: The validity periods + items: + $ref: '#/components/schemas/TimeBoundary' + removePropagationsOnEntityDelete: + type: boolean + description: Whether to remove propagations on entity delete + TermAssignmentHeader: + type: object + properties: + termGuid: + type: string + description: The term guid + relationGuid: + type: string + description: The relation guid + description: + type: string + description: The description + displayText: + type: string + description: The display text + expression: + type: string + description: The expression + createdBy: + type: string + description: The creator + steward: + type: string + description: The steward + source: + type: string + description: The source + confidence: + type: integer + description: The confidence + format: int32 + status: + type: string + description: The status + enum: + - DISCOVERED + - PROPOSED + - IMPORTED + - VALIDATED + - DEPRECATED + - OBSOLETE + - OTHER + PartialUpdateParams: + type: object + properties: + typeName: + type: string + description: The type name + attributes: + type: string + description: The attributes (opaque JSON object) + guid: + type: string + description: The internal guid + status: + type: string + description: The status + enum: + - ACTIVE + - DELETED + - PURGED + classificationNames: + type: array + description: The classification (tag) names + items: + type: string + classifications: + type: array + description: The classifications (tags) + items: + $ref: '#/components/schemas/ClassificationHeader' + isIncomplete: + type: boolean + description: Whether is incomplete + ClassificationHeader: + type: object + properties: + typeName: + type: string + description: The tag name + entityGuid: + type: string + description: The internal entity guid + entityStatus: + type: string + description: The entity status + enum: + - ACTIVE + - DELETED + - PURGED + propagate: + type: boolean + description: Whether to propagate the tag + removePropagationsOnEntityDelete: + type: boolean + description: Whether to remove propagations on entity delete + x-stackQL-resources: + business_metadata_defs: + id: confluent.catalog.business_metadata_defs + name: business_metadata_defs + title: Business Metadata Defs + methods: + get_all_business_metadata_defs: + operation: + $ref: '#/paths/~1catalog~1v1~1types~1businessmetadatadefs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $ + create_business_metadata_defs: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1catalog~1v1~1types~1businessmetadatadefs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update_business_metadata_defs: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1catalog~1v1~1types~1businessmetadatadefs/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_business_metadata_def: + operation: + $ref: >- + #/paths/~1catalog~1v1~1types~1businessmetadatadefs~1{bmName}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + get_business_metadata_def_by_name: + operation: + $ref: '#/paths/~1catalog~1v1~1types~1businessmetadatadefs~1{bmName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/business_metadata_defs/methods/get_business_metadata_def_by_name + - $ref: >- + #/components/x-stackQL-resources/business_metadata_defs/methods/get_all_business_metadata_defs + insert: + - $ref: >- + #/components/x-stackQL-resources/business_metadata_defs/methods/create_business_metadata_defs + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/business_metadata_defs/methods/delete_business_metadata_def + replace: + - $ref: >- + #/components/x-stackQL-resources/business_metadata_defs/methods/update_business_metadata_defs + business_metadata: + id: confluent.catalog.business_metadata + name: business_metadata + title: Business Metadata + methods: + create_business_metadata: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1catalog~1v1~1entity~1businessmetadata/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update_business_metadata: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1catalog~1v1~1entity~1businessmetadata/put' + response: + mediaType: application/json + openAPIDocKey: '200' + get_business_metadata: + operation: + $ref: >- + #/paths/~1catalog~1v1~1entity~1type~1{typeName}~1name~1{qualifiedName}~1businessmetadata/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $ + delete_business_metadata: + operation: + $ref: >- + #/paths/~1catalog~1v1~1entity~1type~1{typeName}~1name~1{qualifiedName}~1businessmetadata~1{bmName}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/business_metadata/methods/get_business_metadata + insert: + - $ref: >- + #/components/x-stackQL-resources/business_metadata/methods/create_business_metadata + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/business_metadata/methods/delete_business_metadata + replace: + - $ref: >- + #/components/x-stackQL-resources/business_metadata/methods/update_business_metadata + tags: + id: confluent.catalog.tags + name: tags + title: Tags + methods: + update_tags: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1catalog~1v1~1entity~1tags/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_tags: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1catalog~1v1~1entity~1tags/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_tags: + operation: + $ref: >- + #/paths/~1catalog~1v1~1entity~1type~1{typeName}~1name~1{qualifiedName}~1tags/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $ + delete_tag: + operation: + $ref: >- + #/paths/~1catalog~1v1~1entity~1type~1{typeName}~1name~1{qualifiedName}~1tags~1{tagName}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tags/methods/get_tags' + insert: + - $ref: '#/components/x-stackQL-resources/tags/methods/create_tags' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/tags/methods/delete_tag' + replace: + - $ref: '#/components/x-stackQL-resources/tags/methods/update_tags' + entities: + id: confluent.catalog.entities + name: entities + title: Entities + methods: + get_by_unique_attributes: + operation: + $ref: >- + #/paths/~1catalog~1v1~1entity~1type~1{typeName}~1name~1{qualifiedName}/get + response: + mediaType: application/json + openAPIDocKey: '200' + partial_entity_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1catalog~1v1~1entity/put' + response: + mediaType: application/json + openAPIDocKey: '200' + search_using_attribute: + operation: + $ref: '#/paths/~1catalog~1v1~1search~1attribute/get' + response: + mediaType: application/json + openAPIDocKey: '200' + search_using_basic: + operation: + $ref: '#/paths/~1catalog~1v1~1search~1basic/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/entities/methods/get_by_unique_attributes + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/entities/methods/partial_entity_update + tag_defs: + id: confluent.catalog.tag_defs + name: tag_defs + title: Tag Defs + methods: + get_all_tag_defs: + operation: + $ref: '#/paths/~1catalog~1v1~1types~1tagdefs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $ + update_tag_defs: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1catalog~1v1~1types~1tagdefs/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_tag_defs: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1catalog~1v1~1types~1tagdefs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_tag_def_by_name: + operation: + $ref: '#/paths/~1catalog~1v1~1types~1tagdefs~1{tagName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_tag_def: + operation: + $ref: '#/paths/~1catalog~1v1~1types~1tagdefs~1{tagName}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/tag_defs/methods/get_tag_def_by_name + - $ref: '#/components/x-stackQL-resources/tag_defs/methods/get_all_tag_defs' + insert: + - $ref: '#/components/x-stackQL-resources/tag_defs/methods/create_tag_defs' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/tag_defs/methods/delete_tag_def' + replace: + - $ref: '#/components/x-stackQL-resources/tag_defs/methods/update_tag_defs' +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/ccl.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/ccl.yaml new file mode 100644 index 0000000..7263169 --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/ccl.yaml @@ -0,0 +1,2914 @@ +openapi: 3.0.0 +info: + title: ccl API + description: confluent ccl API + version: 1.0.0 +paths: + /ccl/v1/custom-code-loggings: + get: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + operationId: listCclV1CustomCodeLoggings + summary: List of Custom Code Loggings + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Custom Code Logging API + EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Retrieve a sorted, filtered, paginated list of all custom code loggings. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Custom Code Loggings (ccl/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Code Logging. + content: + application/json: + schema: + type: object + description: >- + CustomCodeLogging objects represent Custom Code Logging on + Confluent Cloud. + + The API allows you to list, create, read, update, and delete + your Custom Code Logging. + + + + ## The Custom Code Loggings Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ccl/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLoggingList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + CustomCodeLogging objects represent Custom Code Logging + on Confluent Cloud. + + The API allows you to list, create, read, update, and + delete your Custom Code Logging. + + + + ## The Custom Code Loggings Model + + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: >- + Cloud provider where the Custom Code Logging is + sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: >- + The Cloud provider region the Custom Code Logging is + sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: >- + #/components/schemas/ccl.v1.KafkaDestinationSettings + properties: + kind: + type: string + description: >- + The destination where Custom Code Logging is + sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: >- + The kafka cluster id where Custom Code Logging + is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: >- + The kafka topic where Custom Code Logging is + sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: >- + Environment of the referred resource, if + env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - cloud + - region + - destination_settings + - environment + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + operationId: createCclV1CustomCodeLogging + summary: Create a Custom Code Logging + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Custom Code Logging API + EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Make a request to create a custom code logging. + tags: + - Custom Code Loggings (ccl/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + CustomCodeLogging objects represent Custom Code Logging on + Confluent Cloud. + + The API allows you to list, create, read, update, and delete + your Custom Code Logging. + + + + ## The Custom Code Loggings Model + + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: The kafka cluster id where Custom Code Logging is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - cloud + - region + - destination_settings + - environment + responses: + '201': + description: A Custom Code Logging was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/ccl/v1/custom-code-loggings/{id} + description: CustomCodeLogging resource uri + content: + application/json: + schema: + type: object + description: >- + CustomCodeLogging objects represent Custom Code Logging on + Confluent Cloud. + + The API allows you to list, create, read, update, and delete + your Custom Code Logging. + + + + ## The Custom Code Loggings Model + + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: >- + The kafka cluster id where Custom Code Logging is + sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - cloud + - region + - destination_settings + - environment + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + /ccl/v1/custom-code-loggings/{id}: + get: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + operationId: getCclV1CustomCodeLogging + summary: Read a Custom Code Logging + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Custom Code Logging API + EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Make a request to read a custom code logging. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom code logging. + tags: + - Custom Code Loggings (ccl/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Code Logging. + content: + application/json: + schema: + type: object + description: >- + CustomCodeLogging objects represent Custom Code Logging on + Confluent Cloud. + + The API allows you to list, create, read, update, and delete + your Custom Code Logging. + + + + ## The Custom Code Loggings Model + + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: >- + The kafka cluster id where Custom Code Logging is + sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - cloud + - region + - destination_settings + - environment + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + operationId: updateCclV1CustomCodeLogging + summary: Update a Custom Code Logging + description: >+ + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Custom Code Logging API + EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Make a request to update a custom code logging. + + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom code logging. + tags: + - Custom Code Loggings (ccl/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + CustomCodeLogging objects represent Custom Code Logging on + Confluent Cloud. + + The API allows you to list, create, read, update, and delete + your Custom Code Logging. + + + + ## The Custom Code Loggings Model + + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: The kafka cluster id where Custom Code Logging is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - environment + responses: + '200': + description: Custom Code Logging. + content: + application/json: + schema: + type: object + description: >- + CustomCodeLogging objects represent Custom Code Logging on + Confluent Cloud. + + The API allows you to list, create, read, update, and delete + your Custom Code Logging. + + + + ## The Custom Code Loggings Model + + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: >- + The kafka cluster id where Custom Code Logging is + sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - cloud + - region + - destination_settings + - environment + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + operationId: deleteCclV1CustomCodeLogging + summary: Delete a Custom Code Logging + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Custom Code Logging API + EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Make a request to delete a custom code logging. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom code logging. + tags: + - Custom Code Loggings (ccl/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Custom Code Logging is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + ccl.v1.CustomCodeLoggingList: + type: object + description: >- + CustomCodeLogging objects represent Custom Code Logging on Confluent + Cloud. + + The API allows you to list, create, read, update, and delete your Custom + Code Logging. + + + + ## The Custom Code Loggings Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ccl/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLoggingList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + CustomCodeLogging objects represent Custom Code Logging on + Confluent Cloud. + + The API allows you to list, create, read, update, and delete your + Custom Code Logging. + + + + ## The Custom Code Loggings Model + + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: The kafka cluster id where Custom Code Logging is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - cloud + - region + - destination_settings + - environment + uniqueItems: true + ccl.v1.CustomCodeLogging: + type: object + description: >- + CustomCodeLogging objects represent Custom Code Logging on Confluent + Cloud. + + The API allows you to list, create, read, update, and delete your Custom + Code Logging. + + + + ## The Custom Code Loggings Model + + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: The kafka cluster id where Custom Code Logging is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + ccl.v1.KafkaDestinationSettings: + type: object + description: | + Kafka Destination Settings of the Custom Code Logging. + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: The kafka cluster id where Custom Code Logging is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + EnvScopedObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + x-stackQL-resources: + custom_code_loggings: + id: confluent.ccl.custom_code_loggings + name: custom_code_loggings + title: Custom Code Loggings + methods: + list_ccl_v1_custom_code_loggings: + operation: + $ref: '#/paths/~1ccl~1v1~1custom-code-loggings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_ccl_v1_custom_code_logging: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ccl~1v1~1custom-code-loggings/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_ccl_v1_custom_code_logging: + operation: + $ref: '#/paths/~1ccl~1v1~1custom-code-loggings~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_ccl_v1_custom_code_logging: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ccl~1v1~1custom-code-loggings~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_ccl_v1_custom_code_logging: + operation: + $ref: '#/paths/~1ccl~1v1~1custom-code-loggings~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/custom_code_loggings/methods/get_ccl_v1_custom_code_logging + - $ref: >- + #/components/x-stackQL-resources/custom_code_loggings/methods/list_ccl_v1_custom_code_loggings + insert: + - $ref: >- + #/components/x-stackQL-resources/custom_code_loggings/methods/create_ccl_v1_custom_code_logging + update: + - $ref: >- + #/components/x-stackQL-resources/custom_code_loggings/methods/update_ccl_v1_custom_code_logging + delete: + - $ref: >- + #/components/x-stackQL-resources/custom_code_loggings/methods/delete_ccl_v1_custom_code_logging + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/ccpm.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/ccpm.yaml new file mode 100644 index 0000000..4e17753 --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/ccpm.yaml @@ -0,0 +1,4111 @@ +openapi: 3.0.0 +info: + title: ccpm API + description: confluent ccpm API + version: 1.0.0 +paths: + /ccpm/v1/plugins: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCcpmV1CustomConnectPlugins + summary: List of Custom Connect Plugins + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all custom connect + plugins. + + + If no `cloud` filter is specified, returns custom connect plugins from + all clouds. + parameters: + - name: spec.cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for spec.cloud. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Custom Connect Plugins (ccpm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Connect Plugin. + content: + application/json: + schema: + type: object + description: >- + CustomConnectPlugins objects represent Custom Connect + artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete + your Custom Connect Plugins. + + Related guide: + + [Custom Connect Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connect Plugins Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + CustomConnectPlugins objects represent Custom Connect + artifacts containing connector, and SMT jars on + Confluent + Cloud. + The API allows you to list, create, read, update, and + delete your Custom Connect Plugins. + + Related guide: + + [Custom Connect Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connect Plugins Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + required: + - id + - metadata + - spec + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-page-first-available: true + x-page-last-available: true + x-page-from-start: true + x-page-from-end: true + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createCcpmV1CustomConnectPlugin + summary: Create a Custom Connect Plugin + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a custom connect plugin. + tags: + - Custom Connect Plugins (ccpm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + CustomConnectPlugins objects represent Custom Connect artifacts + containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete + your Custom Connect Plugins. + + Related guide: + + [Custom Connect Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connect Plugins Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + required: + - spec + responses: + '202': + description: A Custom Connect Plugin is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/ccpm/v1/plugins/{id} + description: CustomConnectPlugin resource uri + content: + application/json: + schema: + type: object + description: >- + CustomConnectPlugins objects represent Custom Connect + artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete + your Custom Connect Plugins. + + Related guide: + + [Custom Connect Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connect Plugins Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + required: + - spec + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /ccpm/v1/plugins/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCcpmV1CustomConnectPlugin + summary: Read a Custom Connect Plugin + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a custom connect plugin. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connect plugin. + tags: + - Custom Connect Plugins (ccpm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Connect Plugin. + content: + application/json: + schema: + type: object + description: >- + CustomConnectPlugins objects represent Custom Connect + artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete + your Custom Connect Plugins. + + Related guide: + + [Custom Connect Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connect Plugins Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateCcpmV1CustomConnectPlugin + summary: Update a Custom Connect Plugin + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a custom connect plugin. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connect plugin. + tags: + - Custom Connect Plugins (ccpm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + CustomConnectPlugins objects represent Custom Connect artifacts + containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete + your Custom Connect Plugins. + + Related guide: + + [Custom Connect Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connect Plugins Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + required: + - spec + responses: + '200': + description: Custom Connect Plugin. + content: + application/json: + schema: + type: object + description: >- + CustomConnectPlugins objects represent Custom Connect + artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete + your Custom Connect Plugins. + + Related guide: + + [Custom Connect Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connect Plugins Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteCcpmV1CustomConnectPlugin + summary: Delete a Custom Connect Plugin + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a custom connect plugin. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connect plugin. + tags: + - Custom Connect Plugins (ccpm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Custom Connect Plugin is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /ccpm/v1/presigned-upload-url: + post: + summary: Request a presigned upload URL for a new Custom Connect Plugin. + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Request a presigned upload URL to upload a Custom Connect Plugin + archive. + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createCcpmV1PresignedUrl + tags: + - Presigned Urls (ccpm/v1) + security: + - cloud-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + Request a presigned upload URL for new Custom Connect Plugin. + Note that + + the URL policy expires in one hour. If the policy expires, you + can request + + a new presigned upload URL. + + + Related guide: + + [Custom Connect Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Presigned Urls Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Custom Connect Plugin archive. + example: ZIP + x-extensible-enum: + - ZIP + - JAR + cloud: + type: string + description: >- + Cloud provider where the Custom Connect Plugin archive is + uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Custom Connect Plugin archive. + example: >- + https://confluent-custom-connectors-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: string + description: >- + Upload form data of the Custom Connect Plugin. All values + should be strings. (opaque JSON object) + example: + bucket: confluent-custom-connectors-stag-us-west-2 + key: >- + staging/custom-plugin/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/connect-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/plugin.zip + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - content_format + - cloud + - environment + responses: + '201': + description: A Presigned Url was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/ccpm/v1/presigned-upload-url/{id} + description: PresignedUrl resource uri + content: + application/json: + schema: + type: object + description: >- + Request a presigned upload URL for new Custom Connect Plugin. + Note that + + the URL policy expires in one hour. If the policy expires, you + can request + + a new presigned upload URL. + + + Related guide: + + [Custom Connect Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Presigned Urls Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Custom Connect Plugin archive. + example: ZIP + x-extensible-enum: + - ZIP + - JAR + cloud: + type: string + description: >- + Cloud provider where the Custom Connect Plugin archive is + uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Custom Connect Plugin archive. + example: >- + https://confluent-custom-connectors-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: string + description: >- + Upload form data of the Custom Connect Plugin. All values + should be strings. (opaque JSON object) + example: + bucket: confluent-custom-connectors-stag-us-west-2 + key: >- + staging/custom-plugin/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/connect-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/plugin.zip + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - content_format + - cloud + - environment + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /ccpm/v1/plugins/{plugin_id}/versions: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCcpmV1CustomConnectPluginVersions + summary: List of Custom Connect Plugin Versions + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all custom connect plugin + versions. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: plugin_id + in: path + required: true + schema: + type: string + description: The Plugin + tags: + - Custom Connect Plugin Versions (ccpm/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Custom Connect Plugin Version. + content: + application/json: + schema: + type: object + description: >- + CustomConnectPluginVersion objects represent Custom Connect + Plugin Versions on Confluent Cloud. + + The API allows you to list, create, read, update, and delete + your Custom Connect Plugin Versions. + + + + ## The Custom Connect Plugin Versions Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersionList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + CustomConnectPluginVersion objects represent Custom + Connect Plugin Versions on Confluent Cloud. + + The API allows you to list, create, read, update, and + delete your Custom Connect Plugin Versions. + + + + ## The Custom Connect Plugin Versions Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - CustomConnectPluginVersion + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/ccpm.v1.CustomConnectPluginVersionSpec + status: + $ref: >- + #/components/schemas/ccpm.v1.CustomConnectPluginVersionStatus + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createCcpmV1CustomConnectPluginVersion + summary: Create a Custom Connect Plugin Version + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a custom connect plugin version. + parameters: + - name: plugin_id + in: path + required: true + schema: + type: string + description: The Plugin + tags: + - Custom Connect Plugin Versions (ccpm/v1) + security: + - cloud-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + CustomConnectPluginVersion objects represent Custom Connect + Plugin Versions on Confluent Cloud. + + The API allows you to list, create, read, update, and delete + your Custom Connect Plugin Versions. + + + + ## The Custom Connect Plugin Versions Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersion + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionSpec' + status: + $ref: >- + #/components/schemas/ccpm.v1.CustomConnectPluginVersionStatus + required: + - spec + responses: + '202': + description: A Custom Connect Plugin Version is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: >- + https://api.confluent.cloud/ccpm/v1/plugins/{plugin_id}/versions/{id} + description: CustomConnectPluginVersion resource uri + content: + application/json: + schema: + type: object + description: >- + CustomConnectPluginVersion objects represent Custom Connect + Plugin Versions on Confluent Cloud. + + The API allows you to list, create, read, update, and delete + your Custom Connect Plugin Versions. + + + + ## The Custom Connect Plugin Versions Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersion + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/ccpm.v1.CustomConnectPluginVersionSpec + status: + $ref: >- + #/components/schemas/ccpm.v1.CustomConnectPluginVersionStatus + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /ccpm/v1/plugins/{plugin_id}/versions/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCcpmV1CustomConnectPluginVersion + summary: Read a Custom Connect Plugin Version + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a custom connect plugin version. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: plugin_id + in: path + required: true + schema: + type: string + description: The Plugin + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connect plugin version. + tags: + - Custom Connect Plugin Versions (ccpm/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Custom Connect Plugin Version. + content: + application/json: + schema: + type: object + description: >- + CustomConnectPluginVersion objects represent Custom Connect + Plugin Versions on Confluent Cloud. + + The API allows you to list, create, read, update, and delete + your Custom Connect Plugin Versions. + + + + ## The Custom Connect Plugin Versions Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersion + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/ccpm.v1.CustomConnectPluginVersionSpec + status: + $ref: >- + #/components/schemas/ccpm.v1.CustomConnectPluginVersionStatus + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteCcpmV1CustomConnectPluginVersion + summary: Delete a Custom Connect Plugin Version + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a custom connect plugin version. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: plugin_id + in: path + required: true + schema: + type: string + description: The Plugin + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connect plugin version. + tags: + - Custom Connect Plugin Versions (ccpm/v1) + security: + - cloud-api-key: [] + responses: + '204': + description: A Custom Connect Plugin Version is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + ccpm.v1.CustomConnectPluginList: + type: object + description: >- + CustomConnectPlugins objects represent Custom Connect artifacts + containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your Custom + Connect Plugins. + + Related guide: + + [Custom Connect Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connect Plugins Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + CustomConnectPlugins objects represent Custom Connect artifacts + containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your + Custom Connect Plugins. + + Related guide: + + [Custom Connect Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connect Plugins Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + required: + - id + - metadata + - spec + uniqueItems: true + ccpm.v1.CustomConnectPlugin: + type: object + description: >- + CustomConnectPlugins objects represent Custom Connect artifacts + containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your Custom + Connect Plugins. + + Related guide: + + [Custom Connect Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connect Plugins Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + ccpm.v1.PresignedUrl: + type: object + description: >- + Request a presigned upload URL for new Custom Connect Plugin. Note that + + the URL policy expires in one hour. If the policy expires, you can + request + + a new presigned upload URL. + + + Related guide: + + [Custom Connect Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Presigned Urls Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Custom Connect Plugin archive. + example: ZIP + x-extensible-enum: + - ZIP + - JAR + cloud: + type: string + description: Cloud provider where the Custom Connect Plugin archive is uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Custom Connect Plugin archive. + example: >- + https://confluent-custom-connectors-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: string + description: >- + Upload form data of the Custom Connect Plugin. All values should be + strings. (opaque JSON object) + example: + bucket: confluent-custom-connectors-stag-us-west-2 + key: >- + staging/custom-plugin/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/connect-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/plugin.zip + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + ccpm.v1.CustomConnectPluginVersionList: + type: object + description: >- + CustomConnectPluginVersion objects represent Custom Connect Plugin + Versions on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Custom + Connect Plugin Versions. + + + + ## The Custom Connect Plugin Versions Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + CustomConnectPluginVersion objects represent Custom Connect Plugin + Versions on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your + Custom Connect Plugin Versions. + + + + ## The Custom Connect Plugin Versions Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersion + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionSpec' + status: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + ccpm.v1.CustomConnectPluginVersion: + type: object + description: >- + CustomConnectPluginVersion objects represent Custom Connect Plugin + Versions on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Custom + Connect Plugin Versions. + + + + ## The Custom Connect Plugin Versions Model + + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersion + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionSpec' + status: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionStatus' + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + ccpm.v1.CustomConnectPluginSpec: + type: object + description: The desired state of the Custom Connect Plugin + properties: + cloud: + type: string + description: Cloud provider where the Custom Connect Plugin archive is uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + display_name: + type: string + description: Display name of Custom Connect Plugin. + maxLength: 60 + description: + type: string + description: Description of Custom Connect Plugin. + maxLength: 256 + runtime_language: + type: string + example: JAVA + description: Runtime language of Custom Connect Plugin. + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + EnvScopedObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + ccpm.v1.CustomConnectPluginVersionSpec: + type: object + description: The desired state of the Custom Connect Plugin Version + properties: + version: + type: string + description: > + Version of the Custom Connect Plugin. + + The version must comply with SemVer (e.g., `1.2.3`, `1.2.3-beta`, + `1.2.3-rc.123`, `1.2.3-rc.123+build.456`). + maxLength: 60 + x-immutable: true + sensitive_config_properties: + type: array + description: > + A sensitive property is a connector configuration property that must + be hidden after a user enters property + + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + x-immutable: true + documentation_link: + type: string + maxLength: 512 + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connect Plugin. + x-immutable: true + content_format: + type: string + example: ZIP + description: Archive format of Custom Connect Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + connector_classes: + type: array + description: > + List of connector classes. + + The connector class must be a valid Java class name or alias for the + connector. + + You can get the connector class from the connector documentation + provided by the developer. + items: + $ref: '#/components/schemas/ccpm.v1.ConnectorClass' + minItems: 1 + maxItems: 10 + x-immutable: true + upload_source: + type: object + description: > + Upload source of Custom Connect Plugin Version. Only required in + `create` request, + + will be ignored in `read`, `update` or `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/ccpm.v1.UploadSource.PresignedUrl' + x-immutable: true + properties: + location: + type: string + description: | + Location of the Custom Connect Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: >- + Upload ID returned by the `/presigned-upload-url` API. This + field returns an empty string in all responses. + required: + - location + - upload_id + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + ccpm.v1.CustomConnectPluginVersionStatus: + type: object + required: + - phase + description: The status of the Custom Connect Plugin Version + properties: + phase: + type: string + maxLength: 50 + x-extensible-enum: + - PROCESSING + - READY + - FAILED + description: Phase of the Custom Connect Plugin Version. + x-immutable: true + example: PROCESSING + error_message: + type: string + maxLength: 256 + description: Displayable error message if version is in a failed state + x-immutable: true + example: Version creation failed due to invalid plugin archive. + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + ccpm.v1.ConnectorClass: + type: object + description: | + Java class of the Connector. + properties: + class_name: + type: string + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: >- + Java class or alias for connector. You can get connector class from + connector documentation provided by developer. + x-immutable: true + example: io.confluent.kafka.connect.datagen.DatagenConnector + type: + type: string + description: | + Type of the connector class. Should be either `SOURCE` or `SINK`. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + required: + - class_name + - type + ccpm.v1.UploadSource.PresignedUrl: + type: object + description: Presigned URL of the uploaded Custom Connect Plugin archive. + properties: + location: + type: string + description: | + Location of the Custom Connect Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: >- + Upload ID returned by the `/presigned-upload-url` API. This field + returns an empty string in all responses. + required: + - location + - upload_id + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + x-stackQL-resources: + custom_connect_plugins: + id: confluent.ccpm.custom_connect_plugins + name: custom_connect_plugins + title: Custom Connect Plugins + methods: + list_ccpm_v1_custom_connect_plugins: + operation: + $ref: '#/paths/~1ccpm~1v1~1plugins/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_ccpm_v1_custom_connect_plugin: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ccpm~1v1~1plugins/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_ccpm_v1_custom_connect_plugin: + operation: + $ref: '#/paths/~1ccpm~1v1~1plugins~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_ccpm_v1_custom_connect_plugin: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ccpm~1v1~1plugins~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_ccpm_v1_custom_connect_plugin: + operation: + $ref: '#/paths/~1ccpm~1v1~1plugins~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/custom_connect_plugins/methods/get_ccpm_v1_custom_connect_plugin + - $ref: >- + #/components/x-stackQL-resources/custom_connect_plugins/methods/list_ccpm_v1_custom_connect_plugins + insert: + - $ref: >- + #/components/x-stackQL-resources/custom_connect_plugins/methods/create_ccpm_v1_custom_connect_plugin + update: + - $ref: >- + #/components/x-stackQL-resources/custom_connect_plugins/methods/update_ccpm_v1_custom_connect_plugin + delete: + - $ref: >- + #/components/x-stackQL-resources/custom_connect_plugins/methods/delete_ccpm_v1_custom_connect_plugin + replace: [] + presigned_urls: + id: confluent.ccpm.presigned_urls + name: presigned_urls + title: Presigned Urls + methods: + create_ccpm_v1_presigned_url: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ccpm~1v1~1presigned-upload-url/post' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/presigned_urls/methods/create_ccpm_v1_presigned_url + update: [] + delete: [] + replace: [] + custom_connect_plugin_versions: + id: confluent.ccpm.custom_connect_plugin_versions + name: custom_connect_plugin_versions + title: Custom Connect Plugin Versions + methods: + list_ccpm_v1_custom_connect_plugin_versions: + operation: + $ref: '#/paths/~1ccpm~1v1~1plugins~1{plugin_id}~1versions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_ccpm_v1_custom_connect_plugin_version: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ccpm~1v1~1plugins~1{plugin_id}~1versions/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_ccpm_v1_custom_connect_plugin_version: + operation: + $ref: '#/paths/~1ccpm~1v1~1plugins~1{plugin_id}~1versions~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_ccpm_v1_custom_connect_plugin_version: + operation: + $ref: '#/paths/~1ccpm~1v1~1plugins~1{plugin_id}~1versions~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/custom_connect_plugin_versions/methods/get_ccpm_v1_custom_connect_plugin_version + - $ref: >- + #/components/x-stackQL-resources/custom_connect_plugin_versions/methods/list_ccpm_v1_custom_connect_plugin_versions + insert: + - $ref: >- + #/components/x-stackQL-resources/custom_connect_plugin_versions/methods/create_ccpm_v1_custom_connect_plugin_version + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/custom_connect_plugin_versions/methods/delete_ccpm_v1_custom_connect_plugin_version + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/connect.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/connect.yaml new file mode 100644 index 0000000..cd0fb15 --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/connect.yaml @@ -0,0 +1,7062 @@ +openapi: 3.0.0 +info: + title: connect API + description: confluent connect API + version: 1.0.0 +paths: + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors: + get: + x-lifecycle-stage: General Availability + operationId: listConnectv1Connectors + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a list of "names" of the active connectors. You can then make a + [read request](#operation/readConnectv1Connector) for a specific + connector by name. + summary: List of Connectors + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + parameters: [] + responses: + '200': + description: Connector. + content: + application/json: + schema: + type: array + description: List of connector names + items: + type: string + description: Connector name + example: + - MyGcsLogsBucketConnector + - MyS3BucketConnector + - MyDatagenConnector + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + post: + x-lifecycle-stage: General Availability + operationId: createConnectv1Connector + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Create a new connector. Returns the new connector information if + successful. + summary: Create a Connector + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorWithOffsets' + example: + name: MyGcsLogsBucketConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '1' + time.interval: DAILY + topics: APILogsTopic + tasks: + - connector: MyGcsLogsBucketConnector + task: 0 + type: sink + offsets: + - partition: + kafka_partition: 0 + kafka_topic: APILogsTopic + offset: + kafka_offset: 1000 + headers: {} + '400': + description: Bad Request + content: + application/json: + schema: + type: object + properties: + code: + type: integer + message: + type: string + example: + error: + code: 400 + message: Unauthorized + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error + content: + application/json: + schema: + type: object + properties: + error_code: + type: integer + message: + type: string + example: + error_code: 500 + message: >- + Failed to find any class that implements Connector and which + name matches io.confluent.connect.... + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: Name of the connector to create. + config: + type: object + description: >- + Configuration parameters for the connector. All values + should be strings. + x-redact: true + required: + - connector.class + - name + - kafka.api.key + - kafka.api.secret + properties: + connector.class: + type: string + description: >- + \[Required for Managed Connector, Ignored for Custom + Connector\] The connector class name, e.g., + BigQuerySink, GcsSink, etc. + name: + type: string + description: >- + Name or alias of the class (plugin) for this connector. + For custom connector, it must be the same as the name of + the connector to create. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + confluent.connector.type: + type: string + description: | + \[Required for Custom Connector\] The connector type. + example: CUSTOM + default: MANAGED + x-extensible-enum: + - CUSTOM + - MANAGED + confluent.custom.plugin.id: + type: string + example: ccp-lq5m06 + description: > + \[Required for Custom Connector\] The custom plugin id + of custom connector, e.g., `ccp-lq5m06` + confluent.custom.connection.endpoints: + type: string + description: > + \[Optional for Custom Connector\] Egress endpoint(s) for + the connector to use when attaching to the sink or + source data system. + confluent.custom.schema.registry.auto: + type: string + description: > + \[Optional for Custom Connector\] Automatically add the + required schema registry properties in a custom + connector config if schema registry is enabled. + example: 'FALSE' + default: 'FALSE' + x-extensible-enum: + - 'TRUE' + - 'FALSE' + confluent.custom.connect.plugin.runtime: + type: string + description: > + \[Optional for Custom Connector\] The runtime of the + custom connector plugin. + example: 3.9.0 + confluent.custom.connect.java.version: + type: string + description: > + \[Optional for Custom Connector\] The Java version of + the custom connector plugin. + example: '17' + additionalProperties: + type: string + description: >- + Other configuration parameters for the connector. All + values should be strings. See the connector's docs for + details. + offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + examples: + sink: + value: + name: MyGcsLogsBucketConnector + config: + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + offsets: + - partition: + kafka_partition: 0 + kafka_topic: APILogsTopic + offset: + kafka_offset: 1000 + source: + value: + name: MySqlCdcSourceV2Connector_0 + config: + connector.class: MySqlCdcSourceV2 + output.data.format: JSON + flush.size: '1000' + database.hostname: 12.34.567.98 + database.password: '****************' + database.port: '1234' + database.user: '****' + kafka.api.key: '****************' + kafka.api.secret: '****************' + name: MySqlCdcSourceV2Connector_0 + tasks.max: '1' + time.interval: DAILY + topic.prefix: test + offsets: + - partition: + server: test + offset: + file: mysql-bin.000123 + pos: 154 + ts_sec: 1712907333 + description: '' + x-lifecycle-stage: General Availability + parameters: + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id: + get: + x-lifecycle-stage: General Availability + operationId: listConnectv1ConnectorsWithExpansions + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve an object with the queried expansions of all connectors. + Without `expand` query parameter, this list connector’s endpoint will + return a [list of only the connector + names](#operation/listConnectv1Connectors). + summary: List of Connectors with Expansions + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector. + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorExpansionMap' + example: + MyGcsLogsBucketConnector: + id: + id: lcc-xxxxx + id_type: ID + info: + name: MyGcsLogsBucketConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '1' + time.interval: DAILY + topics: APILogsTopic + type: sink + status: + name: MyGcsLogsBucketConnector + connector: + state: PROVISIONING + worker_id: MyGcsLogsBucketConnector + trace: '' + tasks: [] + type: sink + MyS3BucketConnector: + id: + id: lcc-xxxxx + id_type: ID + info: + name: MyS3BucketConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: S3Sink + data.format: BYTES + flush.size: '1000' + s3.bucket: APILogsBucket + aws.access.key.id: '************' + aws.secret.access.key: '**********' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyS3BucketConnector + tasks.max: '1' + time.interval: DAILY + topics: APILogsTopic + type: source + status: + name: MyS3BucketConnector + connector: + state: FAILED + worker_id: MyS3BucketConnector + trace: | + There were some errors with your configuration: + topics: Provided Kafka ApiKey is invalid + kafka.api.secret: Provided Kafka ApiKey is invalid + tasks: [] + type: sink + MyDatagenConnector: + id: + id: lcc-xxxxx + id_type: ID + info: + name: MyDatagenConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: DatagenSource + data.format: BYTES + flush.size: '1000' + quickstart: ORDERS + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyDatagenConnector + tasks.max: '1' + time.interval: DAILY + topics: APILogsTopic + type: source + status: + name: MyDatagenConnector + connector: + state: RUNNING + worker_id: MyDatagenConnector + trace: '' + tasks: + - id: 0 + msg: '' + state: RUNNING + worker_id: MyDatagenConnector + type: source + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + - name: expand + in: query + description: >- + - id : Returns metadata of each connector such as id and id type. + + - info : Returns metadata of each connector such as the + configuration, task + + information, and type of connector. + + - status : Returns additional state information of each connector + including their status and tasks. + schema: + type: string + enum: + - id + - info + - status + x-lifecycle-stage: General Availability + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config: + get: + x-lifecycle-stage: General Availability + operationId: getConnectv1ConnectorConfig + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Get the configuration for the connector. + summary: Read a Connector Configuration + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector. + content: + application/json: + schema: + type: object + description: Configuration parameters for the connector. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: + - aws + - azure + - gcp + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, etc. + name: + type: string + description: >- + Name or alias of the class (plugin) for this connector. + For Custom Connector, it must be the same as + connector_name. + kafka.endpoint: + type: string + description: The kafka cluster endpoint. + kafka.region: + type: string + description: The kafka cluster region. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + additionalProperties: + type: string + description: >- + Other configuration parameters for the connector. See the + connector's docs for the list of options. + example: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + put: + x-lifecycle-stage: General Availability + operationId: createOrUpdateConnectv1ConnectorConfig + description: >- + Create a new connector using the given configuration, or update the + configuration for an existing connector. Returns information about the + connector after the change has been made. + summary: Create or Update a Connector Configuration + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: Configuration parameters for the connector. + required: + - connector.class + - name + - kafka.api.key + - kafka.api.secret + properties: + connector.class: + type: string + description: >- + \[Required for Managed Connector, Ignored for Custom + Connector\] The connector class name. E.g. BigQuerySink, + GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + confluent.connector.type: + type: string + description: | + \[Required for Custom Connector\] The connector type. + example: CUSTOM + default: MANAGED + x-extensible-enum: + - CUSTOM + - MANAGED + confluent.custom.plugin.id: + type: string + example: ccp-lq5m06 + description: > + \[Required for Custom Connector\] The custom plugin id of + custom connector, e.g., `ccp-lq5m06` + confluent.custom.connection.endpoints: + type: string + description: > + \[Optional for Custom Connector\] Egress endpoint(s) for the + connector to use when attaching to the sink or source data + system. + confluent.custom.schema.registry.auto: + type: string + description: > + \[Optional for Custom Connector\] Automatically add the + required schema registry properties in a custom connector + config if schema registry is enabled. + example: 'FALSE' + default: 'FALSE' + x-extensible-enum: + - 'TRUE' + - 'FALSE' + confluent.custom.connect.plugin.runtime: + type: string + description: > + \[Optional for Custom Connector\] The runtime of the custom + connector plugin. By default this is the latest version + available. If not provided this config is updated internally + to reflect the version used. + example: 3.9.0 + confluent.custom.connect.java.version: + type: string + description: > + \[Optional for Custom Connector\] The Java version of the + custom connector plugin. By default this is the latest + version supported by the latest runtime. If not provided + this config is updated internally to reflect the version + used. + example: '17' + additionalProperties: + type: string + description: >- + Other configuration parameters for the connector. All values + should be strings. See the connector's docs for details. + example: + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + description: >- + Configuration parameters for the connector. All values should be + strings. + responses: + '200': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.Connector' + example: + name: MyGcsLogsBucketConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + tasks: + - connector: MyGcsLogsBucketConnector + task: 0 + - connector: MyGcsLogsBucketConnector + task: 1 + type: sink + '400': + $ref: '#/components/responses/connect.v1.BadRequestError' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error + content: + application/json: + schema: + type: object + properties: + error_code: + type: integer + message: + type: string + example: + error_code: 500 + message: >- + Failed to find any class that implements Connector and which + name matches io.confluent.connect.... + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}: + get: + x-lifecycle-stage: General Availability + operationId: readConnectv1Connector + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Get information about the connector. + summary: Read a Connector + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector. + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.Connector' + example: + name: MyGcsLogsBucketConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '1' + time.interval: DAILY + topics: APILogsTopic + tasks: + - connector: MyGcsLogsBucketConnector + task: 0 + type: sink + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + operationId: deleteConnectv1Connector + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Delete a connector. Halts all tasks and deletes the connector + configuration. + summary: Delete a Connector + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + $ref: '#/components/responses/connect.v1.OK' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause: + put: + x-lifecycle-stage: General Availability + operationId: pauseConnectv1Connector + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Pause the connector and its tasks. Stops message processing until the + connector is resumed. This call is asynchronous and the tasks will not + transition to PAUSED state at the same time. + summary: Pause a Connector + tags: + - Lifecycle (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '202': + description: Accepted + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume: + put: + x-lifecycle-stage: General Availability + operationId: resumeConnectv1Connector + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Resume a paused connector or do nothing if the connector is not paused. + This call is asynchronous and the tasks will not transition to RUNNING + state at the same time. + summary: Resume a Connector + tags: + - Lifecycle (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '202': + description: Accepted + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart: + post: + x-lifecycle-stage: Preview + operationId: restartConnectv1Connector + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Restart the connector and its tasks. Stops message processing until the + connector and tasks are restart. This call is asynchronous and the + connector will not transition to another state at the same time. + summary: Restart a Connector + tags: + - Lifecycle (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '202': + description: Accepted + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '403': + $ref: '#/components/responses/connect.v1.ForbiddenError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: Preview + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status: + get: + x-lifecycle-stage: General Availability + operationId: readConnectv1ConnectorStatus + description: >- + Get current status of the connector. This includes whether it is + running, failed, or paused. Also includes which worker it is assigned + to, error information if it has failed, and the state of all its tasks. + summary: Read a Connector Status + tags: + - Status (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the connector. + type: + type: string + description: Type of connector, sink or source. + enum: + - sink + - source + connector: + type: object + description: The map containing connector status. + required: + - state + - worker_id + properties: + state: + type: string + description: The state of the connector. + enum: + - NONE + - PROVISIONING + - RUNNING + - DEGRADED + - FAILED + - PAUSED + - DELETED + worker_id: + type: string + description: The worker ID of the connector. + trace: + type: string + description: The exception name in case of error. + tasks: + type: array + description: The map containing the task status. + items: + type: object + properties: + id: + type: integer + description: The ID of task. + state: + type: string + description: The state of the task. + worker_id: + type: string + description: The worker ID of the task. + msg: + type: string + required: + - id + - state + - worker_id + required: + - name + - type + - connector + example: + name: MyGcsLogsBucketConnector + connector: + state: PROVISIONING + worker_id: MyGcsLogsBucketConnector + trace: '' + tasks: [] + type: source + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks: + get: + x-lifecycle-stage: General Availability + operationId: listConnectv1ConnectorTasks + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Get a list of tasks currently running for the connector. + summary: List of Connector Tasks + tags: + - Status (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector Task. + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.Connectors' + example: + - id: + connector: MyGcsLogsBucketConnector + task: 2 + config: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins: + get: + x-lifecycle-stage: General Availability + operationId: listConnectv1ConnectorPlugins + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Return a list of Managed Connector plugins installed in the Kafka + Connect cluster. + summary: List of Managed Connector plugins + tags: + - Managed Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector Plugin. + content: + application/json: + schema: + type: array + items: + type: object + properties: + class: + type: string + description: The connector class name. E.g. BigQuerySink. + type: + type: string + description: Type of connector, sink or source. + enum: + - sink + - source + version: + type: string + description: The version string for the connector available. + required: + - class + - type + example: + - class: BigQuerySink + type: sink + - class: KinesisSource + type: source + version: 0.1.0 + - class: PostgresSource + type: source + version: 0.1.0 + - class: S3_SINK + type: sink + - class: GcsSink + type: sink + version: 0.2.0 + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: [] + x-lifecycle-stage: General Availability + parameters: + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate: + put: + x-lifecycle-stage: General Availability + operationId: validateConnectv1ConnectorPlugin + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Validate the provided configuration values against the configuration + definition. This API performs per config validation and returns + suggested values and validation error messages. + summary: Validate a Managed Connector Plugin + tags: + - Managed Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector Plugin. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The class name of the connector plugin. + groups: + type: array + description: The list of groups used in configuration definitions. + items: + type: string + error_count: + type: integer + description: >- + The total number of errors encountered during + configuration validation. + configs: + type: array + items: + type: object + properties: + definition: + type: object + description: >- + The definition for a config in the connector plugin, + which includes the name, type, importance, etc. + properties: + name: + type: string + description: The name of the configuration + type: + type: string + enum: + - NONE + - BOOLEAN + - INT + - SHORT + - LONG + - DOUBLE + - STRING + - LIST + - ENUM + - PASSWORD + description: The config types + required: + type: boolean + description: Whether this configuration is required + default_value: + type: string + description: Default value for this configuration + importance: + type: string + enum: + - NONE + - HIGH + - MEDIUM + - LOW + description: The importance level for a configuration + documentation: + type: string + description: The documentation for the configuration + group: + type: string + description: >- + The UI group to which the configuration belongs + to + width: + type: string + enum: + - NONE + - SHORT + - MEDIUM + - LONG + description: The width of a configuration value + display_name: + type: string + dependents: + type: array + description: >- + Other configurations on which this configuration + is dependent + items: + type: string + order: + type: integer + description: The order of configuration in specified group + alias: + type: string + value: + type: object + description: >- + The current value for a config, which includes the + name, value, recommended values, etc. + properties: + name: + type: string + description: The name of the configuration + value: + type: string + description: The value for the configuration + recommended_values: + type: array + description: The list of valid values for the configuration + items: + type: string + errors: + type: array + description: Errors, if any, in the configuration value + items: + type: string + visible: + type: boolean + description: >- + The visibility of the configuration. Based on + the values of other configuration + + fields, this visibility boolean value points out + if the current field should be + + visible or not. + metadata: + type: string + description: >- + Map of metadata details about the connector + configuration, such as type of + + input, etc. (opaque JSON object) + example: + name: io.confluent.connect.gcs.GcsSinkConnector + groups: + - Organize my data by... + - Which topics do you want to get data from? + - Messages + - How should we connect to your data? + - Google Cloud Storage details + - Kafka Cluster credentials + - Number of tasks for this connector + error_count: 1 + configs: + - definition: + name: name + type: STRING + required: true + default_value: '' + importance: HIGH + documentation: Sets a name for your connector. + group: How should we connect to your data? + width: NONE + display_name: Connector name + dependents: [] + order: 2 + alias: '' + value: + name: name + value: '{{.logicalClusterId}}' + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: connector.class + type: STRING + required: true + default_value: '' + importance: HIGH + documentation: '' + group: How should we connect to your data? + width: NONE + display_name: Connector class + dependents: [] + order: 1 + alias: '' + value: + name: connector.class + value: io.confluent.connect.gcs.GcsSinkConnector + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: kafka.api.key + type: PASSWORD + required: true + default_value: '' + importance: HIGH + documentation: '' + group: Kafka Cluster credentials + width: NONE + display_name: Kafka API Key + dependents: [] + order: 1 + alias: '' + value: + name: kafka.api.key + value: '' + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: kafka.api.secret + type: PASSWORD + required: true + default_value: '' + importance: HIGH + documentation: '' + group: Kafka Cluster credentials + width: NONE + display_name: Kafka API Secret + dependents: + - kafka.api.key + order: 2 + alias: '' + value: + name: kafka.api.secret + value: '' + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: topics + type: LIST + required: true + default_value: '' + importance: HIGH + documentation: >- + Identifies the topic name or a comma-separated list of + topic names. + group: Which topics do you want to get data from? + width: NONE + display_name: Topic names + dependents: [] + order: 1 + alias: '' + value: + name: topics + value: test1 + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: data.format + type: STRING + required: true + default_value: '' + importance: HIGH + documentation: >- + Sets the input/output message format. Valid entries are + AVRO, JSON, or BYTES + group: Messages + width: NONE + display_name: Message format + dependents: [] + order: 1 + alias: '' + value: + name: data.format + value: BYTES + recommended_values: + - BYTES + - JSON + - AVRO + errors: [] + visible: true + metadata: {} + - definition: + name: gcs.credentials.config + type: PASSWORD + required: true + default_value: '' + importance: HIGH + documentation: >- + Contents of the downloaded GCP service account JSON + file. + group: Google Cloud Storage details + width: NONE + display_name: Google Cloud Storage credentials. + dependents: [] + order: 1 + alias: '' + value: + name: gcs.credentials.config + value: '' + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: gcs.bucket.name + type: STRING + required: true + default_value: '' + importance: HIGH + documentation: >- + A Google Cloud Storage bucket must be in the same region + as your Confluent Cloud cluster. + group: Google Cloud Storage details + width: NONE + display_name: Bucket name. + dependents: [] + order: 2 + alias: '' + value: + name: gcs.bucket.name + value: gmagare + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: time.interval + type: STRING + required: true + default_value: '' + importance: HIGH + documentation: >- + Sets how your messages grouped in storage. Valid entries + are DAILY or HOURLY. + group: Organize my data by... + width: NONE + display_name: Time interval + dependents: [] + order: 1 + alias: '' + value: + name: time.interval + value: DAILY + recommended_values: + - DAILY + - HOURLY + errors: [] + visible: true + metadata: {} + - definition: + name: tasks.max + type: INT + required: true + default_value: '' + importance: HIGH + documentation: '' + group: Number of tasks for this connector + width: NONE + display_name: Tasks + dependents: [] + order: 1 + alias: '' + value: + name: tasks.max + value: '1' + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: flush.size + type: INT + required: true + default_value: '1000' + importance: HIGH + documentation: >- + This value defaults to 1000. For example, if you use the + default setting of 1000 and your topic has six + partitions, files start to be created in the storage + bucket after more than 1000 records exist in each + partition. Note that the default value of 1000 can be + increased if needed. + group: Organize my data by... + width: NONE + display_name: Flush size + dependents: [] + order: 2 + alias: '' + value: + name: flush.size + value: '1' + recommended_values: [] + errors: + - '"flush.size" should be greater than or equal to 1000' + visible: true + metadata: {} + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + requestBody: + content: + application/json: + schema: + type: object + description: >- + Configuration parameters for the connector. All values should be + strings. + additionalProperties: + type: string + description: >- + Other configuration parameters for the connector. All values + should be strings. See the connector's docs for the list of + options. + example: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '500' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + description: >- + Configuration parameters for the connector. All values should be + strings. + x-lifecycle-stage: General Availability + parameters: + - name: plugin_name + in: path + schema: + type: string + required: true + description: The unique name of the connector plugin. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/translate?mask_sensitive=true: + put: + x-lifecycle-stage: General Availability + operationId: translateConnectv1ConnectorPlugin + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Translate the provided Self Managed configuration values. This API + performs configuration translation + + and returns the translated fully managed configuration along with any + errors or warnings. + + Query Parameter `mask_sensitive=true` redacts sensitive config values in + response. + summary: >- + Translate Self Managed Connector Plugin Configurations to Fully Managed + Connector Plugin Configurations + tags: + - Managed Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + Configuration parameters for the self managed connector. All + values should be strings. + additionalProperties: + type: string + description: >- + Configuration parameters for the self managed connector. All + values should be strings. See the self managed connector's + docs for the list of options. + example: + topics: nidhi_topic + input.data.format: JSON + connector.class: io.confluent.connect.datadog.metrics.DatadogMetricsSinkConnector + name: DatadogMetricsSinkConnector_87 + datadog.api.key: 535069c094cdfd1a55fb3e80eba09241 + datadog.domain: COM + max.retry.time.ms: '5000' + behavior.on.error: log + tasks.max: '1' + errors.tolerance: all + errors.deadletterqueue.context.headers.enable: 'true' + errors.log.include.messages: 'true' + errors.log.enable: 'true' + reporter.bootstrap.servers: localhost:9092 + reporter.error.topic.replication.factor: '1' + confluent.topic.bootstrap.servers: localhost:9092 + confluent.topic.replication.factor: '1' + description: >- + Configuration parameters for the connector. All values should be + strings. + responses: + '200': + description: Connector Plugin translation result. + content: + application/json: + schema: + type: object + properties: + config: + type: object + description: The translated configuration + additionalProperties: + type: string + errors: + type: array + description: List of configuration errors + items: + type: object + properties: + field: + type: string + description: The field name that has an error + message: + type: string + description: The error message + required: + - field + - message + warnings: + type: array + description: List of configuration warnings + items: + type: object + properties: + field: + type: string + description: The field name that has a warning + message: + type: string + description: The warning message + required: + - field + - message + example: + config: + connector.class: DatadogMetricsSink + name: DatadogMetricsSinkConnector_87 + topics: nidhi_topic + datadog.api.key: '****************' + datadog.domain: COM + max.retry.time.ms: '5000' + behavior.on.error: log + tasks.max: '1' + errors.tolerance: all + errors.deadletterqueue.context.headers.enable: 'true' + errors.log.include.messages: 'true' + errors.log.enable: 'true' + confluent.topic.bootstrap.servers: localhost:9092 + input.data.format: JSON + max.poll.interval.ms: '300000' + max.poll.records: '500' + errors: + - field: datadog.site + message: Required config is missing. + warnings: + - field: confluent.topic.bootstrap.servers + message: Customer given value is ignored. Default value is used. + - field: reporter.error.topic.replication.factor + message: Customer given value is ignored. Default value is used. + - field: confluent.topic.replication.factor + message: Customer given value is ignored. Default value is used. + '400': + $ref: '#/components/responses/connect.v1.BadRequestError' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '403': + $ref: '#/components/responses/connect.v1.ForbiddenError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: plugin_name + in: path + schema: + type: string + required: true + description: The unique name of the connector plugin. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + - name: mask_sensitive + in: query + required: false + schema: + type: string + maxLength: 255 + description: Indicates whether to redact sensitive config values in response. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets: + get: + x-lifecycle-stage: General Availability + operationId: getConnectv1ConnectorOffsets + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Get the current offsets for the connector. The offsets provide + information on the point in the source system, + + from which the connector is pulling in data. The offsets of a connector + are continuously observed periodically and are queryable via this API. + summary: Get a Connector Offsets + tags: + - Offsets (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector Offsets. + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorOffsets' + examples: + sink: + value: + id: lcc-as341 + name: MysqlSinkConnector + offsets: + - partition: + kafka_partition: 0 + kafka_topic: topic_A + offset: + kafka_offset: 20032323 + - partition: + kafka_partition: 1 + kafka_topic: topic_B + offset: + kafka_offset: 20032322 + metadata: + observed_at: 2024-02-20T15:14:19.000Z + source: + value: + id: lcc-21sdda + name: MysqlSourceConnector + offsets: + - partition: + protocol: 1 + table: sourcedb.sourcetable + offset: + timestamp_nanos: 0 + incrementing: 3 + timestamp: 1699142400000 + metadata: + observed_at: 2024-02-20T15:14:19.000Z + '400': + $ref: '#/components/responses/connect.v1.BadRequestError' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '403': + $ref: '#/components/responses/connect.v1.ForbiddenError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request: + post: + x-lifecycle-stage: General Availability + operationId: alterConnectv1ConnectorOffsetsRequest + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Request to alter the offsets of a connector. This supports the ability + to PATCH/DELETE the offsets of a connector. + + Note, you will see momentary downtime as this will internally stop the + connector, while the offsets are being altered. + + You can only make one alter offsets request at a time for a connector. + summary: Request to Alter the Connector Offsets + tags: + - Offsets (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '202': + description: Accepted + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.AlterOffsetRequestInfo' + examples: + patch: + value: + id: lcc-sa32er + name: MySinkConnector + offsets: + - partition: + kafka_partition: 0 + kafka_topic: topic_A + offset: + kafka_offset: 1000 + requested_at: 2024-02-20T15:14:19.000Z + type: PATCH + delete: + value: + id: lcc-234ds + name: MySourceConnector + offsets: [] + requested_at: 2024-02-20T15:14:19.000Z + type: DELETE + '400': + $ref: '#/components/responses/connect.v1.BadRequestError' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '403': + $ref: '#/components/responses/connect.v1.ForbiddenError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.AlterOffsetRequest' + examples: + patch sink: + value: + type: PATCH + offsets: + - partition: + kafka_partition: 0 + kafka_topic: topic_A + offset: + kafka_offset: 1000 + patch source: + value: + type: PATCH + offsets: + - partition: + protocol: 1 + table: sourcedb.sourcetable + offset: + timestamp_nanos: 0 + incrementing: 3 + timestamp: 1699000000000 + delete: + value: + type: DELETE + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status: + get: + x-lifecycle-stage: General Availability + operationId: getConnectv1ConnectorOffsetsRequestStatus + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Get the status of the previous alter offset request. + summary: Get the Status of Alter Offset Request + tags: + - Offsets (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector Offsets Request Status. + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.AlterOffsetStatus' + examples: + sink - pending patch operation: + value: + request: + id: lcc-sa32er + name: MySinkConnector + offsets: + - partition: + kafka_partition: 0 + kafka_topic: topic_A + offset: + kafka_offset: 1000 + requested_at: 2024-02-20T15:14:19.000Z + type: PATCH + status: + phase: PENDING + applied_at: null + source - applied patch operation: + value: + request: + id: lcc-x1sdfs + name: MySourceConnector + offsets: + - partition: + protocol: 1 + table: sourcedb.sourcetable + offset: + timestamp_nanos: 0 + incrementing: 3 + timestamp: 1699000000000 + requested_at: 2024-02-20T15:14:19.000Z + type: PATCH + status: + phase: APPLIED + message: >- + The Connect framework-managed offsets for this connector + have been altered successfully. However, if this + connector manages offsets externally, they will need to + be altered manually in the system that the connector + uses. + previous_offsets: + - partition: + protocol: 1 + table: sourcedb.sourcetable + offset: + timestamp_nanos: 0 + incrementing: 2 + timestamp: 1698329479943 + applied_at: 2024-02-20T15:14:20+0000 + delete: + value: + request: + id: lcc-234ds + name: MySourceConnector + offsets: [] + requested_at: 2024-02-20T15:14:19.000Z + type: DELETE + status: + phase: APPLIED + message: >- + The Connect framework-managed offsets for this connector + have been reset successfully. However, if this connector + manages offsets externally, they will need to be reset + manually in the system that the connector uses. + previous_offsets: + - partition: + protocol: 1 + table: sourcedb.sourcetable + offset: + timestamp_nanos: 0 + incrementing: 2 + timestamp: 1698329479943 + applied_at: 2024-02-20T15:14:20.000Z + '400': + $ref: '#/components/responses/connect.v1.BadRequestError' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '403': + $ref: '#/components/responses/connect.v1.ForbiddenError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/custom-connector-plugins: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listConnectV1CustomConnectorPlugins + summary: List of Custom Connector Plugins + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all custom connector + plugins. + + + If no `cloud` filter is specified, returns custom connector plugins from + all clouds. + parameters: + - name: cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for cloud. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Custom Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Connector Plugin. + content: + application/json: + schema: + type: object + description: >- + CustomConnectorPlugins objects represent Custom Connector + Plugins on Confluent Cloud. + + The API allows you to list, create, read, update, and delete + your Custom Connector Plugins. + + Related guide: + + [Custom Connector Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connector Plugins Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPluginList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + CustomConnectorPlugins objects represent Custom + Connector Plugins on Confluent Cloud. + + The API allows you to list, create, read, update, and + delete your Custom Connector Plugins. + + Related guide: + + [Custom Connector Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connector Plugins Model + + + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - CustomConnectorPlugin + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: Display name of Custom Connector Plugin. + maxLength: 60 + content_format: + type: string + example: ZIP + description: Archive format of Custom Connector Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + description: + type: string + description: Description of Custom Connector Plugin. + maxLength: 256 + documentation_link: + maxLength: 512 + type: string + pattern: ^$|^(http://|https://).+ + example: >- + https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connector Plugin. + connector_class: + type: string + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: >- + Java class or alias for connector. You can get + connector class from connector documentation + provided by developer. + example: io.confluent.kafka.connect.datagen.DatagenConnector + x-immutable: true + connector_type: + type: string + description: | + Custom Connector type. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + x-immutable: true + cloud: + type: string + description: >- + Cloud provider where the Custom Connector Plugin + archive is uploaded. + example: AWS + default: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + sensitive_config_properties: + type: array + description: > + A sensitive property is a connector configuration + property that must be hidden after a user enters + property + + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + upload_source: + type: object + description: >- + Upload source of Custom Connector Plugin. Only + required in `create` request, will be ignored in + `read`, `update` or `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: >- + #/components/schemas/connect.v1.UploadSource.PresignedUrl + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: >- + Upload ID returned by the + `/presigned-upload-url` API. This field returns + an empty string in all responses. + required: + - location + - upload_id + runtime_language: + type: string + example: JAVA + default: JAVA + description: Runtime language of Custom Connector Plugin. + x-extensible-enum: + - JAVA + - PYTHON + required: + - id + - metadata + - display_name + - connector_class + - connector_type + - upload_source + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createConnectV1CustomConnectorPlugin + summary: Create a Custom Connector Plugin + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a custom connector plugin. + tags: + - Custom Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + CustomConnectorPlugins objects represent Custom Connector + Plugins on Confluent Cloud. + + The API allows you to list, create, read, update, and delete + your Custom Connector Plugins. + + Related guide: + + [Custom Connector Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connector Plugins Model + + + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPlugin + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + description: Display name of Custom Connector Plugin. + maxLength: 60 + content_format: + type: string + example: ZIP + description: Archive format of Custom Connector Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + description: + type: string + description: Description of Custom Connector Plugin. + maxLength: 256 + documentation_link: + maxLength: 512 + type: string + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connector Plugin. + connector_class: + type: string + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: >- + Java class or alias for connector. You can get connector + class from connector documentation provided by developer. + example: io.confluent.kafka.connect.datagen.DatagenConnector + x-immutable: true + connector_type: + type: string + description: | + Custom Connector type. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + x-immutable: true + cloud: + type: string + description: >- + Cloud provider where the Custom Connector Plugin archive is + uploaded. + example: AWS + default: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + sensitive_config_properties: + type: array + description: > + A sensitive property is a connector configuration property + that must be hidden after a user enters property + + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + upload_source: + type: object + description: >- + Upload source of Custom Connector Plugin. Only required in + `create` request, will be ignored in `read`, `update` or + `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: >- + #/components/schemas/connect.v1.UploadSource.PresignedUrl + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: >- + Upload ID returned by the `/presigned-upload-url` API. + This field returns an empty string in all responses. + required: + - location + - upload_id + runtime_language: + type: string + example: JAVA + default: JAVA + description: Runtime language of Custom Connector Plugin. + x-extensible-enum: + - JAVA + - PYTHON + required: + - display_name + - connector_class + - connector_type + - upload_source + responses: + '201': + description: A Custom Connector Plugin was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: >- + https://api.confluent.cloud/connect/v1/custom-connector-plugins/{id} + description: CustomConnectorPlugin resource uri + content: + application/json: + schema: + type: object + description: >- + CustomConnectorPlugins objects represent Custom Connector + Plugins on Confluent Cloud. + + The API allows you to list, create, read, update, and delete + your Custom Connector Plugins. + + Related guide: + + [Custom Connector Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connector Plugins Model + + + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPlugin + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: Display name of Custom Connector Plugin. + maxLength: 60 + content_format: + type: string + example: ZIP + description: Archive format of Custom Connector Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + description: + type: string + description: Description of Custom Connector Plugin. + maxLength: 256 + documentation_link: + maxLength: 512 + type: string + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connector Plugin. + connector_class: + type: string + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: >- + Java class or alias for connector. You can get connector + class from connector documentation provided by developer. + example: io.confluent.kafka.connect.datagen.DatagenConnector + x-immutable: true + connector_type: + type: string + description: | + Custom Connector type. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + x-immutable: true + cloud: + type: string + description: >- + Cloud provider where the Custom Connector Plugin archive + is uploaded. + example: AWS + default: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + sensitive_config_properties: + type: array + description: > + A sensitive property is a connector configuration property + that must be hidden after a user enters property + + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + upload_source: + type: object + description: >- + Upload source of Custom Connector Plugin. Only required in + `create` request, will be ignored in `read`, `update` or + `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: >- + #/components/schemas/connect.v1.UploadSource.PresignedUrl + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: >- + Upload ID returned by the `/presigned-upload-url` API. + This field returns an empty string in all responses. + required: + - location + - upload_id + runtime_language: + type: string + example: JAVA + default: JAVA + description: Runtime language of Custom Connector Plugin. + x-extensible-enum: + - JAVA + - PYTHON + required: + - display_name + - connector_class + - connector_type + - upload_source + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /connect/v1/custom-connector-plugins/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getConnectV1CustomConnectorPlugin + summary: Read a Custom Connector Plugin + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a custom connector plugin. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connector plugin. + tags: + - Custom Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Connector Plugin. + content: + application/json: + schema: + type: object + description: >- + CustomConnectorPlugins objects represent Custom Connector + Plugins on Confluent Cloud. + + The API allows you to list, create, read, update, and delete + your Custom Connector Plugins. + + Related guide: + + [Custom Connector Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connector Plugins Model + + + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPlugin + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: Display name of Custom Connector Plugin. + maxLength: 60 + content_format: + type: string + example: ZIP + description: Archive format of Custom Connector Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + description: + type: string + description: Description of Custom Connector Plugin. + maxLength: 256 + documentation_link: + maxLength: 512 + type: string + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connector Plugin. + connector_class: + type: string + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: >- + Java class or alias for connector. You can get connector + class from connector documentation provided by developer. + example: io.confluent.kafka.connect.datagen.DatagenConnector + x-immutable: true + connector_type: + type: string + description: | + Custom Connector type. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + x-immutable: true + cloud: + type: string + description: >- + Cloud provider where the Custom Connector Plugin archive + is uploaded. + example: AWS + default: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + sensitive_config_properties: + type: array + description: > + A sensitive property is a connector configuration property + that must be hidden after a user enters property + + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + upload_source: + type: object + description: >- + Upload source of Custom Connector Plugin. Only required in + `create` request, will be ignored in `read`, `update` or + `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: >- + #/components/schemas/connect.v1.UploadSource.PresignedUrl + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: >- + Upload ID returned by the `/presigned-upload-url` API. + This field returns an empty string in all responses. + required: + - location + - upload_id + runtime_language: + type: string + example: JAVA + default: JAVA + description: Runtime language of Custom Connector Plugin. + x-extensible-enum: + - JAVA + - PYTHON + required: + - api_version + - kind + - id + - display_name + - connector_class + - connector_type + - upload_source + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateConnectV1CustomConnectorPlugin + summary: Update a Custom Connector Plugin + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a custom connector plugin. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connector plugin. + tags: + - Custom Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.CustomConnectorPlugin' + responses: + '200': + description: Custom Connector Plugin. + content: + application/json: + schema: + type: object + description: >- + CustomConnectorPlugins objects represent Custom Connector + Plugins on Confluent Cloud. + + The API allows you to list, create, read, update, and delete + your Custom Connector Plugins. + + Related guide: + + [Custom Connector Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connector Plugins Model + + + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPlugin + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: Display name of Custom Connector Plugin. + maxLength: 60 + content_format: + type: string + example: ZIP + description: Archive format of Custom Connector Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + description: + type: string + description: Description of Custom Connector Plugin. + maxLength: 256 + documentation_link: + maxLength: 512 + type: string + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connector Plugin. + connector_class: + type: string + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: >- + Java class or alias for connector. You can get connector + class from connector documentation provided by developer. + example: io.confluent.kafka.connect.datagen.DatagenConnector + x-immutable: true + connector_type: + type: string + description: | + Custom Connector type. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + x-immutable: true + cloud: + type: string + description: >- + Cloud provider where the Custom Connector Plugin archive + is uploaded. + example: AWS + default: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + sensitive_config_properties: + type: array + description: > + A sensitive property is a connector configuration property + that must be hidden after a user enters property + + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + upload_source: + type: object + description: >- + Upload source of Custom Connector Plugin. Only required in + `create` request, will be ignored in `read`, `update` or + `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: >- + #/components/schemas/connect.v1.UploadSource.PresignedUrl + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: >- + Upload ID returned by the `/presigned-upload-url` API. + This field returns an empty string in all responses. + required: + - location + - upload_id + runtime_language: + type: string + example: JAVA + default: JAVA + description: Runtime language of Custom Connector Plugin. + x-extensible-enum: + - JAVA + - PYTHON + required: + - api_version + - kind + - id + - display_name + - connector_class + - connector_type + - upload_source + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteConnectV1CustomConnectorPlugin + summary: Delete a Custom Connector Plugin + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a custom connector plugin. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connector plugin. + tags: + - Custom Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Custom Connector Plugin is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /connect/v1/presigned-upload-url: + post: + summary: Request a presigned upload URL for a new Custom Connector Plugin. + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Request a presigned upload URL to upload a Custom Connector Plugin + archive. + requestBody: + content: + application/json: + schema: + type: object + description: | + Request schema of the presigned upload URL. + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrlRequest + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + content_format: + type: string + example: ZIP + description: Archive format of the Custom Connector Plugin. + x-extensible-enum: + - JAR + - ZIP + cloud: + type: string + example: AWS + default: AWS + description: >- + Cloud provider where the Custom Connector Plugin archive is + uploaded. + x-extensible-enum: + - AWS + - GCP + - AZURE + required: + - content_format + x-lifecycle-stage: General Availability + x-self-access: true + x-name: connect.v1.PresignedUrl + operationId: presigned-upload-urlConnectV1PresignedUrl + tags: + - Presigned Urls (connect/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Presigned Url. + content: + application/json: + schema: + type: object + description: >- + Request a presigned upload URL for new Custom Connector + Plugin. Note that + + the URL policy expires in one hour. If the policy expires, you + can request + + a new presigned upload URL. + + + Related guide: + + [Custom Connector Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Presigned Urls Model + + + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Custom Connector Plugin archive. + example: ZIP + x-extensible-enum: + - ZIP + - JAR + readOnly: true + cloud: + type: string + description: >- + Cloud provider where the Custom Connector Plugin archive + is uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + readOnly: true + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Custom Connector Plugin archive. + example: >- + https://confluent-custom-connectors-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: string + description: >- + Upload form data of the Custom Connector Plugin. All + values should be strings. (opaque JSON object) + example: + bucket: confluent-custom-connectors-stag-us-west-2 + key: >- + staging/custom-plugin/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/connect-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/plugin.zip + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + readOnly: true + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /connect/v1/custom-connector-runtimes: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listConnectV1CustomConnectorRuntimes + summary: List of Custom Connector Runtimes + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all custom connector + runtimes. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Custom Connector Runtimes (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Connector Runtime. + content: + application/json: + schema: + type: object + description: >- + List of supported runtime languages for Custom Connector + Plugin. The list defines the supported + + entries for confluent.custom.connect.plugin.runtime attribute + in CustomConnectorPlugin object. + + Each entry also defines the set of supported java versions for + that runtime which can be specified during + + connector provisioning via the + confluent.custom.connect.plugin.java.version attribute. + + + + ## The Custom Connector Runtimes Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorRuntimeList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + List of supported runtime languages for Custom Connector + Plugin. The list defines the supported + + entries for confluent.custom.connect.plugin.runtime + attribute in CustomConnectorPlugin object. + + Each entry also defines the set of supported java + versions for that runtime which can be specified during + + connector provisioning via the + confluent.custom.connect.plugin.java.version attribute. + + + + ## The Custom Connector Runtimes Model + + + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - CustomConnectorRuntime + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + custom_connect_plugin_runtime_name: + type: string + description: > + Name of the runtime that is being used while + provisioning a custom connector. This corresponds to + + the property custom.connect.plugin.runtime in the + connector configuration. + example: 3.9.0 + readOnly: true + runtime_ak_version: + type: string + description: >- + The underlying version of Apache Kafka which bundles + the connect runtime + example: 3.9.0 + readOnly: true + supported_java_versions: + type: array + description: List of supported Java versions + items: + type: string + example: + - '11' + - '17' + readOnly: true + product_maturity: + type: string + description: > + The product maturity phase for the plugin runtime. + + EA (Early Access), GA (Generally Available), or + Preview. + x-extensible-enum: + - EA + - GA + - PREVIEW + example: GA + readOnly: true + end_of_life_at: + type: string + format: date-time + description: End of Life date for the runtime + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: + type: string + description: Description of the runtime + example: >- + Custom Connector Plugin runtime using AK 3.9.0 and + supporting Java 11 and 17 + readOnly: true + required: + - id + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + connect.v1.ConnectorWithOffsets: + type: object + properties: + name: + type: string + description: Name of the connector + config: + type: object + description: >- + Configuration parameters for the connector. These configurations + + are the minimum set of key-value pairs which can be used to + + define how the connector connects Kafka to the external system. + + Some of these key-value pairs are common to all the connectors, such + as + + connection parameters to Kafka, connector metadata, etc. The list + + of common connector configurations is as follows + + - cloud.environment + + - cloud.provider + + - connector.class + + - kafka.api.key + + - kafka.api.secret + + - kafka.endpoint + + - kafka.region + + - name + + A specific connector such as `GcsSink` would have additional + + parameters such as `gcs.bucket.name`, `flush.size`, etc. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: + - aws + - azure + - gcp + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.endpoint: + type: string + description: The Kafka cluster endpoint. + kafka.region: + type: string + description: The Kafka cluster region. + kafka.api.key: + type: string + description: The Kafka cluster API key. + kafka.api.secret: + type: string + description: The Kafka cluster API secret. + x-redact: true + additionalProperties: + type: string + tasks: + type: array + description: List of active tasks generated by the connector + items: + type: object + properties: + connector: + type: string + description: The name of the connector the task belongs to + task: + type: integer + description: Task ID within the connector + required: + - connector + - task + type: + type: string + description: Type of connector, sink or source + enum: + - sink + - source + offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + required: + - name + - config + connect.v1.Offsets: + type: array + description: Array of offsets which are categorised into partitions. + items: + type: object + properties: + partition: + type: object + additionalProperties: true + description: >- + The partition information. For sink connectors this is the kafka + topic and + + partition. For source connectors this is depends on the partitions + defined by the + + source connector. For example, the table which this task is + pulling data from in a + + JDBC based MySQL source connector. + + Please refer to the + [documentation](https://docs.confluent.io/cloud/current/connectors/offsets.html#manage-offsets-for-fully-managed-connectors-in-ccloud) + for + + more information. + offset: + type: object + additionalProperties: true + description: >- + The offset of the partition. For sink connectors this is the kafka + offset. For + + source connectors this is depends on the offset defined by the + source connector. + + For example, the timestamp and incrementing column info in a + table, for a JDBC based + + MySQL source connector. + + Please refer to the + [documentation](https://docs.confluent.io/cloud/current/connectors/offsets.html#manage-offsets-for-fully-managed-connectors-in-ccloud) + for + + more information. + connect.v1.ConnectorExpansionMap: + type: object + additionalProperties: + $ref: '#/components/schemas/connect.v1.ConnectorExpansion' + connect.v1.Connector: + type: object + properties: + name: + type: string + description: Name of the connector + config: + type: object + description: |- + Configuration parameters for the connector. These configurations + are the minimum set of key-value pairs (KVP) which can be used to + define how the connector connects Kafka to the external system. + Some of these KVPs are common to all the connectors, such as + connection parameters to Kafka, connector metadata, etc. The list + of common connector configurations is as follows + + - cloud.environment + - cloud.provider + - connector.class + - kafka.api.key + - kafka.api.secret + - kafka.endpoint + - kafka.region + - name + + A specific connector such as `GcsSink` would have additional + parameters such as `gcs.bucket.name`, `flush.size`, etc. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: + - aws + - azure + - gcp + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.endpoint: + type: string + description: The kafka cluster endpoint. + kafka.region: + type: string + description: The kafka cluster region. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + additionalProperties: + type: string + tasks: + type: array + description: List of active tasks generated by the connector + items: + type: object + properties: + connector: + type: string + description: The name of the connector the task belongs to + task: + type: integer + description: Task ID within the connector + required: + - connector + - task + type: + type: string + description: Type of connector, sink or source + enum: + - sink + - source + required: + - name + - config + connect.v1.Connectors: + type: array + description: List of active task configs that have been created by the connector + items: + type: object + properties: + id: + type: object + description: The ID of task. + properties: + connector: + type: string + description: The name of the connector the task belongs to. + task: + type: integer + description: Task ID within the connector. + config: + type: object + description: |- + Configuration parameters for the connector. These configurations + are the minimum set of key-value pairs (KVP) which can be used to + define how the connector connects Kafka to the external system. + Some of these KVPs are common to all the connectors, such as + connection parameters to Kafka, connector metadata, etc. The list + of common connector configurations is as follows + + - cloud.environment + - cloud.provider + - connector.class + - kafka.api.key + - kafka.api.secret + - kafka.endpoint + - kafka.region + - name + + A specific connector such as `GcsSink` would have additional + parameters such as `gcs.bucket.name`, `flush.size`, etc. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: + - aws + - azure + - gcp + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.endpoint: + type: string + description: The kafka cluster endpoint. + kafka.region: + type: string + description: The kafka cluster region. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + additionalProperties: + type: string + connect.v1.ConnectorOffsets: + type: object + description: Offsets for a connector + properties: + name: + type: string + description: The name of the connector. + id: + type: string + description: The ID of the connector. + offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + metadata: + type: object + description: Metadata of the connector offset. + properties: + observed_at: + type: string + format: date-time + example: '2024-02-20T15:14:19.000Z' + readOnly: true + description: >- + The time at which the offsets were observed. The time is in UTC, + ISO 8601 format. + connect.v1.AlterOffsetRequestInfo: + type: object + description: The request made to alter offsets. + properties: + id: + type: string + description: The ID of the connector. + name: + type: string + description: The name of the connector. + offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + requested_at: + type: string + format: date-time + readOnly: true + example: '2024-02-20T15:14:19.000Z' + description: >- + The time at which the request was made. The time is in UTC, ISO 8601 + format. + type: + $ref: '#/components/schemas/connect.v1.AlterOffsetRequestType' + required: + - id + - name + - type + - requested_at + connect.v1.AlterOffsetRequest: + type: object + description: >- + Request to alter the offset of a connector. The offsets parameter is + options for DELETE type. + properties: + type: + $ref: '#/components/schemas/connect.v1.AlterOffsetRequestType' + offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + required: + - type + connect.v1.AlterOffsetStatus: + type: object + description: >- + Status of the alter offset operation. The previous offsets in the + response + + is the offsets that the connector last processed, before the offsets + were altered, + + via a patch or delete operation. + properties: + request: + $ref: '#/components/schemas/connect.v1.AlterOffsetRequestInfo' + status: + type: object + description: The response of the alter offsets operation. + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - PENDING_VALIDATION + - APPLIED + - FAILED + description: >- + The phase of the alter offset operation. + + + PENDING: The offset alter operation is in progress. + + + APPLIED: The offset alter operation has been applied to the + connector. + + + FAILED: The offset alter operation has failed to be applied to + the connector. + message: + type: string + description: An info message from the alter offset operation. + required: + - phase + previous_offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + applied_at: + type: string + nullable: true + format: date-time + example: '2024-02-20T15:14:19.000Z' + readOnly: true + description: >- + The time at which the offsets were applied. The time is in UTC, ISO + 8601 format. + required: + - request + - status + SearchFilter: + description: Filter a collection by a string search + type: string + connect.v1.CustomConnectorPluginList: + type: object + description: >- + CustomConnectorPlugins objects represent Custom Connector Plugins on + Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Custom + Connector Plugins. + + Related guide: + + [Custom Connector Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connector Plugins Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPluginList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + CustomConnectorPlugins objects represent Custom Connector Plugins + on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your + Custom Connector Plugins. + + Related guide: + + [Custom Connector Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connector Plugins Model + + + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPlugin + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + description: Display name of Custom Connector Plugin. + maxLength: 60 + content_format: + type: string + example: ZIP + description: Archive format of Custom Connector Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + description: + type: string + description: Description of Custom Connector Plugin. + maxLength: 256 + documentation_link: + maxLength: 512 + type: string + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connector Plugin. + connector_class: + type: string + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: >- + Java class or alias for connector. You can get connector class + from connector documentation provided by developer. + example: io.confluent.kafka.connect.datagen.DatagenConnector + x-immutable: true + connector_type: + type: string + description: | + Custom Connector type. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + x-immutable: true + cloud: + type: string + description: >- + Cloud provider where the Custom Connector Plugin archive is + uploaded. + example: AWS + default: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + sensitive_config_properties: + type: array + description: > + A sensitive property is a connector configuration property + that must be hidden after a user enters property + + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + upload_source: + type: object + description: >- + Upload source of Custom Connector Plugin. Only required in + `create` request, will be ignored in `read`, `update` or + `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/connect.v1.UploadSource.PresignedUrl' + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: >- + Upload ID returned by the `/presigned-upload-url` API. + This field returns an empty string in all responses. + required: + - location + - upload_id + runtime_language: + type: string + example: JAVA + default: JAVA + description: Runtime language of Custom Connector Plugin. + x-extensible-enum: + - JAVA + - PYTHON + required: + - id + - metadata + - display_name + - connector_class + - connector_type + - upload_source + uniqueItems: true + connect.v1.CustomConnectorPlugin: + type: object + description: >- + CustomConnectorPlugins objects represent Custom Connector Plugins on + Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Custom + Connector Plugins. + + Related guide: + + [Custom Connector Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Custom Connector Plugins Model + + + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPlugin + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: Display name of Custom Connector Plugin. + maxLength: 60 + content_format: + type: string + example: ZIP + description: Archive format of Custom Connector Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + description: + type: string + description: Description of Custom Connector Plugin. + maxLength: 256 + documentation_link: + maxLength: 512 + type: string + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connector Plugin. + connector_class: + type: string + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: >- + Java class or alias for connector. You can get connector class from + connector documentation provided by developer. + example: io.confluent.kafka.connect.datagen.DatagenConnector + x-immutable: true + connector_type: + type: string + description: | + Custom Connector type. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + x-immutable: true + cloud: + type: string + description: >- + Cloud provider where the Custom Connector Plugin archive is + uploaded. + example: AWS + default: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + sensitive_config_properties: + type: array + description: > + A sensitive property is a connector configuration property that must + be hidden after a user enters property + + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + upload_source: + type: object + description: >- + Upload source of Custom Connector Plugin. Only required in `create` + request, will be ignored in `read`, `update` or `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/connect.v1.UploadSource.PresignedUrl' + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: >- + Upload ID returned by the `/presigned-upload-url` API. This + field returns an empty string in all responses. + required: + - location + - upload_id + runtime_language: + type: string + example: JAVA + default: JAVA + description: Runtime language of Custom Connector Plugin. + x-extensible-enum: + - JAVA + - PYTHON + connect.v1.PresignedUrlRequest: + type: object + description: | + Request schema of the presigned upload URL. + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrlRequest + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + content_format: + type: string + example: ZIP + description: Archive format of the Custom Connector Plugin. + x-extensible-enum: + - JAR + - ZIP + cloud: + type: string + example: AWS + default: AWS + description: >- + Cloud provider where the Custom Connector Plugin archive is + uploaded. + x-extensible-enum: + - AWS + - GCP + - AZURE + connect.v1.PresignedUrl: + type: object + description: >- + Request a presigned upload URL for new Custom Connector Plugin. Note + that + + the URL policy expires in one hour. If the policy expires, you can + request + + a new presigned upload URL. + + + Related guide: + + [Custom Connector Plugin + API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + + ## The Presigned Urls Model + + + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Custom Connector Plugin archive. + example: ZIP + x-extensible-enum: + - ZIP + - JAR + readOnly: true + cloud: + type: string + description: >- + Cloud provider where the Custom Connector Plugin archive is + uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + readOnly: true + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Custom Connector Plugin archive. + example: >- + https://confluent-custom-connectors-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: string + description: >- + Upload form data of the Custom Connector Plugin. All values should + be strings. (opaque JSON object) + example: + bucket: confluent-custom-connectors-stag-us-west-2 + key: >- + staging/custom-plugin/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/connect-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/plugin.zip + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + readOnly: true + connect.v1.CustomConnectorRuntimeList: + type: object + description: >- + List of supported runtime languages for Custom Connector Plugin. The + list defines the supported + + entries for confluent.custom.connect.plugin.runtime attribute in + CustomConnectorPlugin object. + + Each entry also defines the set of supported java versions for that + runtime which can be specified during + + connector provisioning via the + confluent.custom.connect.plugin.java.version attribute. + + + + ## The Custom Connector Runtimes Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorRuntimeList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + List of supported runtime languages for Custom Connector Plugin. + The list defines the supported + + entries for confluent.custom.connect.plugin.runtime attribute in + CustomConnectorPlugin object. + + Each entry also defines the set of supported java versions for + that runtime which can be specified during + + connector provisioning via the + confluent.custom.connect.plugin.java.version attribute. + + + + ## The Custom Connector Runtimes Model + + + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorRuntime + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + custom_connect_plugin_runtime_name: + type: string + description: > + Name of the runtime that is being used while provisioning a + custom connector. This corresponds to + + the property custom.connect.plugin.runtime in the connector + configuration. + example: 3.9.0 + readOnly: true + runtime_ak_version: + type: string + description: >- + The underlying version of Apache Kafka which bundles the + connect runtime + example: 3.9.0 + readOnly: true + supported_java_versions: + type: array + description: List of supported Java versions + items: + type: string + example: + - '11' + - '17' + readOnly: true + product_maturity: + type: string + description: | + The product maturity phase for the plugin runtime. + EA (Early Access), GA (Generally Available), or Preview. + x-extensible-enum: + - EA + - GA + - PREVIEW + example: GA + readOnly: true + end_of_life_at: + type: string + format: date-time + description: End of Life date for the runtime + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: + type: string + description: Description of the runtime + example: >- + Custom Connector Plugin runtime using AK 3.9.0 and supporting + Java 11 and 17 + readOnly: true + required: + - id + uniqueItems: true + connect.v1.ConnectorError: + type: object + properties: + error: + type: object + description: Connector Error with error code and message. + properties: + code: + type: integer + description: Error code for the type of error + message: + type: string + description: Human readable error message + connect.v1.ConnectorExpansion: + type: object + description: Name of connector + properties: + id: + type: object + description: The ID of connector. + properties: + id: + type: string + description: The ID of the connector. + id_type: + type: string + description: Type of the value in the `id` property. + info: + type: object + description: Metadata of the connector. + properties: + name: + type: string + description: Name of the connector. + config: + type: object + description: >- + Configuration parameters for the connector. These configurations + + are the minimum set of key-value pairs (KVP) which are used to + + define how the connector connects Kafka to the external system. + + Some of these KVPs are common to all the connectors, such as + + connection parameters to Kafka, connector metadata, etc. The + list + + of common connector configurations is as follows + + - cloud.environment + - cloud.provider + - connector.class + - kafka.api.key + - kafka.api.secret + - kafka.endpoint + - kafka.region + - name + + For example, a connector like `GcsSink` would have additional + + parameters such as `gcs.bucket.name`, `flush.size`, etc. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: + - aws + - azure + - gcp + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.endpoint: + type: string + description: The kafka cluster endpoint. + kafka.region: + type: string + description: The kafka cluster region. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + additionalProperties: + type: string + status: + type: object + description: Status of the connector and its tasks. + properties: + name: + type: string + description: The name of the connector. + type: + type: string + description: Type of connector, sink or source. + enum: + - sink + - source + connector: + type: object + description: A map containing connector status. + required: + - state + - worker_id + properties: + state: + type: string + description: The state of the connector. + enum: + - NONE + - PROVISIONING + - RUNNING + - DEGRADED + - FAILED + - PAUSED + - DELETED + worker_id: + type: string + description: The worker ID of the connector. + trace: + type: string + description: Exception message in case of an error. + tasks: + type: array + description: A map containing the task status. + items: + type: object + properties: + id: + type: integer + description: The ID of task. + state: + type: string + description: The state of the task. + worker_id: + type: string + description: The worker ID of the task. + msg: + type: string + required: + - id + - state + - worker_id + required: + - name + - type + - connector + connect.v1.AlterOffsetRequestType: + type: string + enum: + - PATCH + - DELETE + description: >- + The type of alter operation. PATCH will update the offset to the + provided values. + + The update will only happen for the partitions provided in the request. + + DELETE will delete the offset for the provided partitions and reset them + back to the + + base state. It is as if, a fresh new connector was created. + + + For sink connectors PATCH/DELETE will move the offsets to the provided + point in the + + topic partition. If the offset provided is not present in the topic + partition it will + + by default reset to the earliest offset in the topic partition. + + + For source connectors, post PATCH/DELETE the connector will attempt to + read from the + + position defined in the altered offsets. + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + connect.v1.UploadSource.PresignedUrl: + type: object + description: Presigned URL of the uploaded Custom Connector Plugin archive. + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: >- + Upload ID returned by the `/presigned-upload-url` API. This field + returns an empty string in all responses. + required: + - location + - upload_id + connect.v1.CustomConnectorRuntime: + type: object + description: >- + List of supported runtime languages for Custom Connector Plugin. The + list defines the supported + + entries for confluent.custom.connect.plugin.runtime attribute in + CustomConnectorPlugin object. + + Each entry also defines the set of supported java versions for that + runtime which can be specified during + + connector provisioning via the + confluent.custom.connect.plugin.java.version attribute. + + + + ## The Custom Connector Runtimes Model + + + properties: + api_version: + type: string + enum: + - connect/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorRuntime + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + custom_connect_plugin_runtime_name: + type: string + description: > + Name of the runtime that is being used while provisioning a custom + connector. This corresponds to + + the property custom.connect.plugin.runtime in the connector + configuration. + example: 3.9.0 + readOnly: true + runtime_ak_version: + type: string + description: >- + The underlying version of Apache Kafka which bundles the connect + runtime + example: 3.9.0 + readOnly: true + supported_java_versions: + type: array + description: List of supported Java versions + items: + type: string + example: + - '11' + - '17' + readOnly: true + product_maturity: + type: string + description: | + The product maturity phase for the plugin runtime. + EA (Early Access), GA (Generally Available), or Preview. + x-extensible-enum: + - EA + - GA + - PREVIEW + example: GA + readOnly: true + end_of_life_at: + type: string + format: date-time + description: End of Life date for the runtime + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: + type: string + description: Description of the runtime + example: >- + Custom Connector Plugin runtime using AK 3.9.0 and supporting Java + 11 and 17 + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + connect.v1.UnauthenticatedError: + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 401 + message: Unauthorized + connect.v1.AccountNotFoundError: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 404 + message: account not found + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + connect.v1.DefaultSystemError: + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 500 + message: Oops, something went wrong + connect.v1.BadRequestError: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 400 + message: Bad Request + connect.v1.OK: + description: OK + content: + application/json: + schema: + type: object + properties: + error: + type: string + nullable: true + description: (opaque JSON object) + example: + error: null + connect.v1.ResourceNotFoundError: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 404 + message: resource not found + connect.v1.ForbiddenError: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 403 + message: Forbidden + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + x-stackQL-resources: + connectors: + id: confluent.connect.connectors + name: connectors + title: Connectors + methods: + list_connectv1_connectors: + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connectors/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $ + create_connectv1_connector: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connectors/post + response: + mediaType: application/json + openAPIDocKey: '201' + list_connectv1_connectors_with_expansions: + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connectors?expand=info,status,id/get + response: + mediaType: application/json + openAPIDocKey: '200' + read_connectv1_connector: + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connectors~1{connector_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_connectv1_connector: + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connectors~1{connector_name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + pause_connectv1_connector: + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connectors~1{connector_name}~1pause/put + response: + mediaType: application/json + openAPIDocKey: '202' + resume_connectv1_connector: + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connectors~1{connector_name}~1resume/put + response: + mediaType: application/json + openAPIDocKey: '202' + restart_connectv1_connector: + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connectors~1{connector_name}~1restart/post + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connectors/methods/read_connectv1_connector + - $ref: >- + #/components/x-stackQL-resources/connectors/methods/list_connectv1_connectors + insert: + - $ref: >- + #/components/x-stackQL-resources/connectors/methods/create_connectv1_connector + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/connectors/methods/delete_connectv1_connector + replace: [] + connector_config: + id: confluent.connect.connector_config + name: connector_config + title: Connector Config + methods: + get_connectv1_connector_config: + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connectors~1{connector_name}~1config/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_or_update_connectv1_connector_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connectors~1{connector_name}~1config/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connector_config/methods/get_connectv1_connector_config + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/connector_config/methods/create_or_update_connectv1_connector_config + connector_status: + id: confluent.connect.connector_status + name: connector_status + title: Connector Status + methods: + read_connectv1_connector_status: + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connectors~1{connector_name}~1status/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connector_status/methods/read_connectv1_connector_status + insert: [] + update: [] + delete: [] + replace: [] + connector_tasks: + id: confluent.connect.connector_tasks + name: connector_tasks + title: Connector Tasks + methods: + list_connectv1_connector_tasks: + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connectors~1{connector_name}~1tasks/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $ + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connector_tasks/methods/list_connectv1_connector_tasks + insert: [] + update: [] + delete: [] + replace: [] + managed_connector_plugins: + id: confluent.connect.managed_connector_plugins + name: managed_connector_plugins + title: Managed Connector Plugins + methods: + list_connectv1_connector_plugins: + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connector-plugins/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $ + validate_connectv1_connector_plugin: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connector-plugins~1{plugin_name}~1config~1validate/put + response: + mediaType: application/json + openAPIDocKey: '200' + translate_connectv1_connector_plugin: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connector-plugins~1{plugin_name}~1config~1translate?mask_sensitive=true/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/managed_connector_plugins/methods/list_connectv1_connector_plugins + insert: [] + update: [] + delete: [] + replace: [] + connector_offsets: + id: confluent.connect.connector_offsets + name: connector_offsets + title: Connector Offsets + methods: + get_connectv1_connector_offsets: + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connectors~1{connector_name}~1offsets/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connector_offsets/methods/get_connectv1_connector_offsets + insert: [] + update: [] + delete: [] + replace: [] + connector_offsets_requests: + id: confluent.connect.connector_offsets_requests + name: connector_offsets_requests + title: Connector Offsets Requests + methods: + alter_connectv1_connector_offsets_request: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connectors~1{connector_name}~1offsets~1request/post + response: + mediaType: application/json + openAPIDocKey: '202' + get_connectv1_connector_offsets_request_status: + operation: + $ref: >- + #/paths/~1connect~1v1~1environments~1{environment_id}~1clusters~1{kafka_cluster_id}~1connectors~1{connector_name}~1offsets~1request~1status/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connector_offsets_requests/methods/get_connectv1_connector_offsets_request_status + insert: [] + update: [] + delete: [] + replace: [] + custom_connector_plugins: + id: confluent.connect.custom_connector_plugins + name: custom_connector_plugins + title: Custom Connector Plugins + methods: + list_connect_v1_custom_connector_plugins: + operation: + $ref: '#/paths/~1connect~1v1~1custom-connector-plugins/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_connect_v1_custom_connector_plugin: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1connect~1v1~1custom-connector-plugins/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_connect_v1_custom_connector_plugin: + operation: + $ref: '#/paths/~1connect~1v1~1custom-connector-plugins~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_connect_v1_custom_connector_plugin: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1connect~1v1~1custom-connector-plugins~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_connect_v1_custom_connector_plugin: + operation: + $ref: '#/paths/~1connect~1v1~1custom-connector-plugins~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/custom_connector_plugins/methods/get_connect_v1_custom_connector_plugin + - $ref: >- + #/components/x-stackQL-resources/custom_connector_plugins/methods/list_connect_v1_custom_connector_plugins + insert: + - $ref: >- + #/components/x-stackQL-resources/custom_connector_plugins/methods/create_connect_v1_custom_connector_plugin + update: + - $ref: >- + #/components/x-stackQL-resources/custom_connector_plugins/methods/update_connect_v1_custom_connector_plugin + delete: + - $ref: >- + #/components/x-stackQL-resources/custom_connector_plugins/methods/delete_connect_v1_custom_connector_plugin + replace: [] + presigned_urls: + id: confluent.connect.presigned_urls + name: presigned_urls + title: Presigned Urls + methods: + presigned_upload_url_connect_v1_presigned_url: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1connect~1v1~1presigned-upload-url/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + custom_connector_runtimes: + id: confluent.connect.custom_connector_runtimes + name: custom_connector_runtimes + title: Custom Connector Runtimes + methods: + list_connect_v1_custom_connector_runtimes: + operation: + $ref: '#/paths/~1connect~1v1~1custom-connector-runtimes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/custom_connector_runtimes/methods/list_connect_v1_custom_connector_runtimes + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/encryption_keys.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/encryption_keys.yaml new file mode 100644 index 0000000..9d46a5d --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/encryption_keys.yaml @@ -0,0 +1,4772 @@ +openapi: 3.0.0 +info: + title: encryption_keys API + description: confluent encryption_keys API + version: 1.0.0 +paths: + /dek-registry/v1/keks: + get: + tags: + - Key Encryption Keys (v1) + operationId: getKekNames + parameters: + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + items: + example: mykek + type: string + type: array + application/vnd.schemaregistry+json; qs=0.9: + schema: + items: + example: mykek + type: string + type: array + application/json; qs=0.5: + schema: + items: + example: mykek + type: string + type: array + description: List of kek names + summary: Get a list of kek names + security: + - resource-api-key: [] + - external-access-token: [] + post: + tags: + - Key Encryption Keys (v1) + operationId: createKek + parameters: + - description: Whether to test kek sharing + explode: true + in: query + name: testSharing + required: false + schema: + type: boolean + default: false + style: form + requestBody: + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/CreateKekRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/CreateKekRequest' + application/json: + schema: + $ref: '#/components/schemas/CreateKekRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/CreateKekRequest' + description: The create request + required: true + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Kek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Kek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Kek' + description: The create response + '409': + description: >- + Conflict. Error code 40971 -- Key already exists. Error code 40972 + -- Too many keys. + '422': + description: Error code 42271 -- Invalid key + summary: Create a kek + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}: + delete: + tags: + - Key Encryption Keys (v1) + operationId: deleteKek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Whether to perform a permanent delete + explode: true + in: query + name: permanent + required: false + schema: + type: boolean + style: form + responses: + '204': + description: No Content + '404': + description: >- + Not found. Error code 40470 -- Key not found. Error code 40471 -- + Key not soft-deleted. + '422': + description: >- + Unprocessable entity. Error code 42271 -- Invalid key. Error code + 42272 -- References to key exist. + summary: Delete a kek + security: + - resource-api-key: [] + - external-access-token: [] + get: + tags: + - Key Encryption Keys (v1) + operationId: getKek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Kek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Kek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Kek' + description: The kek info + '404': + description: Error code 40470 -- Key not found + '422': + description: Error code 42271 -- Invalid key + summary: Get a kek by name + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Key Encryption Keys (v1) + operationId: putKek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Whether to test kek sharing + explode: true + in: query + name: testSharing + required: false + schema: + type: boolean + default: false + style: form + requestBody: + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/UpdateKekRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/UpdateKekRequest' + application/json: + schema: + $ref: '#/components/schemas/UpdateKekRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/UpdateKekRequest' + description: The update request + required: true + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Kek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Kek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Kek' + description: The update response + '404': + description: Error code 40470 -- Key not found + '409': + description: Error code 40971 -- Key already exists + '422': + description: Error code 42271 -- Invalid key + summary: Alters a kek + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/undelete: + post: + tags: + - Key Encryption Keys (v1) + operationId: undeleteKek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + responses: + '204': + description: No Content + '404': + description: Error code 40470 -- Key not found + '422': + description: >- + Unprocessable entity. Error code 42271 -- Invalid key. Error code + 42272 -- References to key exist. + summary: Undelete a kek + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/test: + post: + tags: + - Key Encryption Keys (v1) + operationId: testKek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Kek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Kek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Kek' + description: The test response + '422': + description: Error code 42271 -- Invalid key + '500': + description: Error code 50070 -- Dek generation error + summary: Test a kek + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/deks: + get: + tags: + - Data Encryption Keys (v1) + operationId: getDekSubjects + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + - description: Pagination offset for results + explode: true + in: query + name: offset + required: false + schema: + type: integer + default: 0 + style: form + - description: Pagination size for results. Ignored if negative + explode: true + in: query + name: limit + required: false + schema: + type: integer + default: -1 + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + items: + example: User + type: string + type: array + application/vnd.schemaregistry+json; qs=0.9: + schema: + items: + example: User + type: string + type: array + application/json; qs=0.5: + schema: + items: + example: User + type: string + type: array + description: List of dek subjects + '404': + description: Error code 40470 -- Key not found + '422': + description: Error code 42271 -- Invalid key + summary: Get a list of dek subjects + security: + - resource-api-key: [] + - external-access-token: [] + post: + tags: + - Data Encryption Keys (v1) + operationId: createDek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + requestBody: + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/CreateDekRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/CreateDekRequest' + application/json: + schema: + $ref: '#/components/schemas/CreateDekRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/CreateDekRequest' + description: The create request + required: true + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Dek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Dek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Dek' + description: The create response + '409': + description: >- + Conflict. Error code 40971 -- Key already exists. Error code 40972 + -- Too many keys. + '422': + description: Error code 42271 -- Invalid key + '500': + description: Error code 50070 -- Dek generation error + summary: Create a dek + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/deks/{subject}: + delete: + tags: + - Data Encryption Keys (v1) + operationId: deleteDekVersions + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + - description: Whether to perform a permanent delete + explode: true + in: query + name: permanent + required: false + schema: + type: boolean + style: form + responses: + '204': + description: No Content + '404': + description: >- + Not found. Error code 40470 -- Key not found. Error code 40471 -- + Key not soft-deleted. + '422': + description: Error code 42271 -- Invalid key + summary: Delete all versions of a dek + security: + - resource-api-key: [] + - external-access-token: [] + get: + tags: + - Data Encryption Keys (v1) + operationId: getDek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Dek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Dek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Dek' + description: The dek info + '404': + description: Error code 40470 -- Key not found + '422': + description: Error code 42271 -- Invalid key + '500': + description: Error code 50070 -- Dek generation error + summary: Get a dek by subject + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}: + delete: + tags: + - Data Encryption Keys (v1) + operationId: deleteDekVersion + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Version of the dek + explode: false + in: path + name: version + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + - description: Whether to perform a permanent delete + explode: true + in: query + name: permanent + required: false + schema: + type: boolean + style: form + responses: + '204': + description: No Content + '404': + description: >- + Not found. Error code 40470 -- Key not found. Error code 40471 -- + Key not soft-deleted. + '422': + description: >- + Unprocessable entity. Error code 42202 -- Invalid version. Error + code 42271 -- Invalid key. + summary: Delete a dek version + security: + - resource-api-key: [] + - external-access-token: [] + get: + tags: + - Data Encryption Keys (v1) + operationId: getDekByVersion + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Version of the dek + explode: false + in: path + name: version + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Dek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Dek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Dek' + description: The dek info + '404': + description: Error code 40470 -- Key not found + '422': + description: >- + Unprocessable entity. Error code 42202 -- Invalid version. Error + code 42271 -- Invalid key. + '500': + description: Error code 50070 -- Dek generation error + summary: Get a dek by subject and version + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/deks/{subject}/versions: + get: + tags: + - Data Encryption Keys (v1) + operationId: getDekVersions + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + - description: Pagination offset for results + explode: true + in: query + name: offset + required: false + schema: + type: integer + default: 0 + style: form + - description: Pagination size for results. Ignored if negative + explode: true + in: query + name: limit + required: false + schema: + type: integer + default: -1 + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + items: + example: 1 + format: int32 + type: integer + type: array + application/vnd.schemaregistry+json; qs=0.9: + schema: + items: + example: 1 + format: int32 + type: integer + type: array + application/json; qs=0.5: + schema: + items: + example: 1 + format: int32 + type: integer + type: array + description: List of version numbers for dek + '404': + description: Error code 40470 -- Key not found + '422': + description: Error code 42271 -- Invalid key + summary: List versions of dek + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}/undelete: + post: + tags: + - Data Encryption Keys (v1) + operationId: undeleteDekVersion + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Version of the dek + explode: false + in: path + name: version + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + responses: + '204': + description: No Content + '404': + description: >- + Not found. Error code 40470 -- Key not found. Error code 40472 -- + Key must be undeleted. + '422': + description: >- + Unprocessable entity. Error code 42202 -- Invalid version. Error + code 42271 -- Invalid key. + summary: Undelete a dek version + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/deks/{subject}/undelete: + post: + tags: + - Data Encryption Keys (v1) + operationId: undeleteDekVersions + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + responses: + '204': + description: No Content + '404': + description: >- + Not found. Error code 40470 -- Key not found. Error code 40472 -- + Key must be undeleted. + '422': + description: Error code 42271 -- Invalid key + summary: Undelete all versions of a dek + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /byok/v1/keys: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listByokV1Keys + summary: List of Keys + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all keys. + parameters: + - name: display_name + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: Key for billing cluster + description: Filter the results by a partial search of display_name. + - name: provider + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for provider. + - name: state + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: IN_USE + description: Filter the results by exact match for state. + - name: validation_phase + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + description: Filter the results by exact match for validation_phase. + - name: validation_region + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-west-2 + description: | + Filter keys by the cloud region where they are deployed. + - name: key + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: vault-name + description: > + Filters results by a partial match on the key identifier: key_arn + for AWS, key_id for Azure and GCP. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Keys (byok/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Key. + content: + application/json: + schema: + type: object + description: >- + `Key` objects represent customer managed keys on dedicated + Confluent Cloud clusters. + + + Keys are used to protect data at rest stored in your dedicated + Confluent Cloud clusters on AWS, Azure, and GCP. + + This API allows you to upload and retrieve self-managed keys + on Confluent Cloud. + + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) + Management + API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + + ## The Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud + organisation. | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - byok/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KeyList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Key` objects represent customer managed keys on + dedicated Confluent Cloud clusters. + + + Keys are used to protect data at rest stored in your + dedicated Confluent Cloud clusters on AWS, Azure, and + GCP. + + This API allows you to upload and retrieve self-managed + keys on Confluent Cloud. + + + + Related guide: [Confluent Cloud Bring Your Own Key + (BYOK) Management + API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + + ## The Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `byok.max_keys.per_org` | BYOK keys in one Confluent + Cloud organisation. | + properties: + api_version: + type: string + enum: + - byok/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Key + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + key: + type: object + description: | + The cloud-specific key details. + + For AWS, provide the corresponding `key_arn`. + + For Azure, provide the corresponding `key_id`. + + For GCP, provide the corresponding `key_id`. + discriminator: + propertyName: kind + mapping: + AwsKey: '#/components/schemas/byok.v1.AwsKey' + AzureKey: '#/components/schemas/byok.v1.AzureKey' + GcpKey: '#/components/schemas/byok.v1.GcpKey' + x-immutable: true + properties: + key_arn: + description: > + The Amazon Resource Name (ARN) of an AWS KMS + key. + type: string + example: >- + arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: > + The Amazon Resource Names (ARNs) of IAM Roles + created for this key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - >- + arn:aws:iam::123456789876:role/block_storage_manager + - >- + arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + application_id: + description: > + The Application ID created for this + key-environment combination. + type: string + readOnly: true + key_id: + description: > + The unique Key Object Identifier URL without + version of an Azure Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + tenant_id: + description: > + Tenant ID (uuid) hosting the Key Vault + containing the key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + required: + - key_arn + - kind + - key_id + - key_vault_id + - tenant_id + display_name: + type: string + description: | + The human-readable name of the key object. + example: Key for billing cluster + x-immutable: false + provider: + type: string + x-extensible-enum: + - AWS + - Azure + - GCP + description: The cloud provider of the Key. + readOnly: true + example: AWS + state: + type: string + x-extensible-enum: + - AVAILABLE + - IN_USE + description: | + The state of the key: + + AVAILABLE: key can be used for a Kafka cluster provisioning. + + IN_USE: key is already in use by a Kafka cluster provisioning. + readOnly: true + example: IN_USE + validation: + description: | + The validation details of the key. + readOnly: true + type: object + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: > + The timestamp since which the key is in the + current validation phase. + + Changes to the validation message or phase will + update this timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: > + The cloud region where the key is deployed. This + value is computed by the + + API after the key is successfully validated. + example: us-west-2 + readOnly: true + required: + - id + - metadata + - key + - provider + - state + - validation + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createByokV1Key + summary: Create a Key + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a key. + tags: + - Keys (byok/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Key` objects represent customer managed keys on dedicated + Confluent Cloud clusters. + + + Keys are used to protect data at rest stored in your dedicated + Confluent Cloud clusters on AWS, Azure, and GCP. + + This API allows you to upload and retrieve self-managed keys on + Confluent Cloud. + + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) + Management + API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + + ## The Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud + organisation. | + properties: + api_version: + type: string + enum: + - byok/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Key + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + key: + type: object + description: | + The cloud-specific key details. + + For AWS, provide the corresponding `key_arn`. + + For Azure, provide the corresponding `key_id`. + + For GCP, provide the corresponding `key_id`. + discriminator: + propertyName: kind + mapping: + AwsKey: '#/components/schemas/byok.v1.AwsKey' + AzureKey: '#/components/schemas/byok.v1.AzureKey' + GcpKey: '#/components/schemas/byok.v1.GcpKey' + x-immutable: true + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: >- + arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: > + The Amazon Resource Names (ARNs) of IAM Roles created + for this key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - arn:aws:iam::123456789876:role/block_storage_manager + - >- + arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + application_id: + description: > + The Application ID created for this key-environment + combination. + type: string + readOnly: true + key_id: + description: > + The unique Key Object Identifier URL without version of + an Azure Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + tenant_id: + description: > + Tenant ID (uuid) hosting the Key Vault containing the + key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + required: + - key_arn + - kind + - key_id + - key_vault_id + - tenant_id + display_name: + type: string + description: | + The human-readable name of the key object. + example: Key for billing cluster + x-immutable: false + provider: + type: string + x-extensible-enum: + - AWS + - Azure + - GCP + description: The cloud provider of the Key. + readOnly: true + example: AWS + state: + type: string + x-extensible-enum: + - AVAILABLE + - IN_USE + description: | + The state of the key: + + AVAILABLE: key can be used for a Kafka cluster provisioning. + + IN_USE: key is already in use by a Kafka cluster provisioning. + readOnly: true + example: IN_USE + validation: + description: | + The validation details of the key. + readOnly: true + type: object + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: > + The timestamp since which the key is in the current + validation phase. + + Changes to the validation message or phase will update + this timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: > + The cloud region where the key is deployed. This value + is computed by the + + API after the key is successfully validated. + example: us-west-2 + readOnly: true + required: + - key + responses: + '201': + description: A Key was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/byok/v1/keys/{id} + description: Key resource uri + content: + application/json: + schema: + type: object + description: >- + `Key` objects represent customer managed keys on dedicated + Confluent Cloud clusters. + + + Keys are used to protect data at rest stored in your dedicated + Confluent Cloud clusters on AWS, Azure, and GCP. + + This API allows you to upload and retrieve self-managed keys + on Confluent Cloud. + + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) + Management + API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + + ## The Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud + organisation. | + properties: + api_version: + type: string + enum: + - byok/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Key + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + key: + type: object + description: | + The cloud-specific key details. + + For AWS, provide the corresponding `key_arn`. + + For Azure, provide the corresponding `key_id`. + + For GCP, provide the corresponding `key_id`. + discriminator: + propertyName: kind + mapping: + AwsKey: '#/components/schemas/byok.v1.AwsKey' + AzureKey: '#/components/schemas/byok.v1.AzureKey' + GcpKey: '#/components/schemas/byok.v1.GcpKey' + x-immutable: true + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: >- + arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: > + The Amazon Resource Names (ARNs) of IAM Roles created + for this key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - arn:aws:iam::123456789876:role/block_storage_manager + - >- + arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + application_id: + description: > + The Application ID created for this key-environment + combination. + type: string + readOnly: true + key_id: + description: > + The unique Key Object Identifier URL without version + of an Azure Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + tenant_id: + description: > + Tenant ID (uuid) hosting the Key Vault containing the + key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + required: + - key_arn + - kind + - key_id + - key_vault_id + - tenant_id + display_name: + type: string + description: | + The human-readable name of the key object. + example: Key for billing cluster + x-immutable: false + provider: + type: string + x-extensible-enum: + - AWS + - Azure + - GCP + description: The cloud provider of the Key. + readOnly: true + example: AWS + state: + type: string + x-extensible-enum: + - AVAILABLE + - IN_USE + description: | + The state of the key: + + AVAILABLE: key can be used for a Kafka cluster provisioning. + + IN_USE: key is already in use by a Kafka cluster provisioning. + readOnly: true + example: IN_USE + validation: + description: | + The validation details of the key. + readOnly: true + type: object + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: > + The timestamp since which the key is in the current + validation phase. + + Changes to the validation message or phase will update + this timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: > + The cloud region where the key is deployed. This value + is computed by the + + API after the key is successfully validated. + example: us-west-2 + readOnly: true + required: + - key + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /byok/v1/keys/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getByokV1Key + summary: Read a Key + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a key. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the key. + tags: + - Keys (byok/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Key. + content: + application/json: + schema: + type: object + description: >- + `Key` objects represent customer managed keys on dedicated + Confluent Cloud clusters. + + + Keys are used to protect data at rest stored in your dedicated + Confluent Cloud clusters on AWS, Azure, and GCP. + + This API allows you to upload and retrieve self-managed keys + on Confluent Cloud. + + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) + Management + API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + + ## The Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud + organisation. | + properties: + api_version: + type: string + enum: + - byok/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Key + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + key: + type: object + description: | + The cloud-specific key details. + + For AWS, provide the corresponding `key_arn`. + + For Azure, provide the corresponding `key_id`. + + For GCP, provide the corresponding `key_id`. + discriminator: + propertyName: kind + mapping: + AwsKey: '#/components/schemas/byok.v1.AwsKey' + AzureKey: '#/components/schemas/byok.v1.AzureKey' + GcpKey: '#/components/schemas/byok.v1.GcpKey' + x-immutable: true + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: >- + arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: > + The Amazon Resource Names (ARNs) of IAM Roles created + for this key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - arn:aws:iam::123456789876:role/block_storage_manager + - >- + arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + application_id: + description: > + The Application ID created for this key-environment + combination. + type: string + readOnly: true + key_id: + description: > + The unique Key Object Identifier URL without version + of an Azure Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + tenant_id: + description: > + Tenant ID (uuid) hosting the Key Vault containing the + key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + required: + - key_arn + - kind + - key_id + - key_vault_id + - tenant_id + display_name: + type: string + description: | + The human-readable name of the key object. + example: Key for billing cluster + x-immutable: false + provider: + type: string + x-extensible-enum: + - AWS + - Azure + - GCP + description: The cloud provider of the Key. + readOnly: true + example: AWS + state: + type: string + x-extensible-enum: + - AVAILABLE + - IN_USE + description: | + The state of the key: + + AVAILABLE: key can be used for a Kafka cluster provisioning. + + IN_USE: key is already in use by a Kafka cluster provisioning. + readOnly: true + example: IN_USE + validation: + description: | + The validation details of the key. + readOnly: true + type: object + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: > + The timestamp since which the key is in the current + validation phase. + + Changes to the validation message or phase will update + this timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: > + The cloud region where the key is deployed. This value + is computed by the + + API after the key is successfully validated. + example: us-west-2 + readOnly: true + required: + - api_version + - kind + - id + - key + - provider + - state + - validation + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateByokV1Key + summary: Update a Key + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a key. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the key. + tags: + - Keys (byok/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/byok.v1.Key' + responses: + '200': + description: Key. + content: + application/json: + schema: + type: object + description: >- + `Key` objects represent customer managed keys on dedicated + Confluent Cloud clusters. + + + Keys are used to protect data at rest stored in your dedicated + Confluent Cloud clusters on AWS, Azure, and GCP. + + This API allows you to upload and retrieve self-managed keys + on Confluent Cloud. + + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) + Management + API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + + ## The Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud + organisation. | + properties: + api_version: + type: string + enum: + - byok/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Key + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + key: + type: object + description: | + The cloud-specific key details. + + For AWS, provide the corresponding `key_arn`. + + For Azure, provide the corresponding `key_id`. + + For GCP, provide the corresponding `key_id`. + discriminator: + propertyName: kind + mapping: + AwsKey: '#/components/schemas/byok.v1.AwsKey' + AzureKey: '#/components/schemas/byok.v1.AzureKey' + GcpKey: '#/components/schemas/byok.v1.GcpKey' + x-immutable: true + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: >- + arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: > + The Amazon Resource Names (ARNs) of IAM Roles created + for this key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - arn:aws:iam::123456789876:role/block_storage_manager + - >- + arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + application_id: + description: > + The Application ID created for this key-environment + combination. + type: string + readOnly: true + key_id: + description: > + The unique Key Object Identifier URL without version + of an Azure Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + tenant_id: + description: > + Tenant ID (uuid) hosting the Key Vault containing the + key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + required: + - key_arn + - kind + - key_id + - key_vault_id + - tenant_id + display_name: + type: string + description: | + The human-readable name of the key object. + example: Key for billing cluster + x-immutable: false + provider: + type: string + x-extensible-enum: + - AWS + - Azure + - GCP + description: The cloud provider of the Key. + readOnly: true + example: AWS + state: + type: string + x-extensible-enum: + - AVAILABLE + - IN_USE + description: | + The state of the key: + + AVAILABLE: key can be used for a Kafka cluster provisioning. + + IN_USE: key is already in use by a Kafka cluster provisioning. + readOnly: true + example: IN_USE + validation: + description: | + The validation details of the key. + readOnly: true + type: object + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: > + The timestamp since which the key is in the current + validation phase. + + Changes to the validation message or phase will update + this timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: > + The cloud region where the key is deployed. This value + is computed by the + + API after the key is successfully validated. + example: us-west-2 + readOnly: true + required: + - api_version + - kind + - id + - key + - provider + - state + - validation + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteByokV1Key + summary: Delete a Key + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a key. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the key. + tags: + - Keys (byok/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Key is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + CreateKekRequest: + example: + kmsProps: + key: kmsProps + shared: true + name: name + doc: doc + kmsKeyId: kmsKeyId + kmsType: kmsType + properties: + name: + type: string + description: Name of the kek + kmsType: + type: string + description: KMS type of the kek + kmsKeyId: + type: string + description: KMS key ID of the kek + kmsProps: + type: object + additionalProperties: + type: string + description: Properties of the kek + doc: + type: string + description: Description of the kek + shared: + type: boolean + description: Whether the kek is shared + deleted: + type: boolean + description: Whether the kek is deleted + type: object + Kek: + example: + kmsProps: + key: kmsProps + shared: true + deleted: true + name: name + doc: doc + kmsKeyId: kmsKeyId + kmsType: kmsType + ts: 0 + properties: + name: + type: string + description: Name of the kek + kmsType: + type: string + description: KMS type of the kek + kmsKeyId: + type: string + description: KMS key ID of the kek + kmsProps: + type: object + additionalProperties: + type: string + description: Properties of the kek + doc: + type: string + description: Description of the kek + shared: + type: boolean + description: Whether the kek is shared + ts: + type: integer + description: Timestamp of the kek + format: int64 + deleted: + type: boolean + description: Whether the kek is deleted + type: object + UpdateKekRequest: + example: + kmsProps: + key: kmsProps + shared: true + doc: doc + properties: + kmsProps: + type: object + additionalProperties: + type: string + description: Properties of the kek + doc: + type: string + description: Description of the kek + shared: + type: boolean + description: Whether the kek is shared + type: object + CreateDekRequest: + example: + subject: subject + encryptedKeyMaterial: encryptedKeyMaterial + version: 0 + algorithm: AES128_GCM + properties: + subject: + type: string + description: Subject of the dek + version: + type: integer + description: Version of the dek + format: int32 + algorithm: + type: string + description: Algorithm of the dek + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + encryptedKeyMaterial: + type: string + description: Encrypted key material of the dek + deleted: + type: boolean + description: Whether the dek is deleted + type: object + Dek: + example: + kekName: kekName + keyMaterial: keyMaterial + deleted: true + subject: subject + encryptedKeyMaterial: encryptedKeyMaterial + version: 0 + algorithm: AES128_GCM + ts: 6 + properties: + kekName: + type: string + description: Kek name of the dek + subject: + type: string + description: Subject of the dek + version: + type: integer + description: Version of the dek + format: int32 + algorithm: + type: string + description: Algorithm of the dek + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + encryptedKeyMaterial: + type: string + description: Encrypted key material of the dek + keyMaterial: + type: string + description: Raw key material of the dek + ts: + type: integer + description: Timestamp of the dek + format: int64 + deleted: + type: boolean + description: Whether the dek is deleted + type: object + SearchFilter: + description: Filter a collection by a string search + type: string + byok.v1.KeyList: + type: object + description: >- + `Key` objects represent customer managed keys on dedicated Confluent + Cloud clusters. + + + Keys are used to protect data at rest stored in your dedicated Confluent + Cloud clusters on AWS, Azure, and GCP. + + This API allows you to upload and retrieve self-managed keys on + Confluent Cloud. + + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management + API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + + ## The Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud + organisation. | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - byok/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KeyList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Key` objects represent customer managed keys on dedicated + Confluent Cloud clusters. + + + Keys are used to protect data at rest stored in your dedicated + Confluent Cloud clusters on AWS, Azure, and GCP. + + This API allows you to upload and retrieve self-managed keys on + Confluent Cloud. + + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) + Management + API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + + ## The Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud + organisation. | + properties: + api_version: + type: string + enum: + - byok/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Key + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + key: + type: object + description: | + The cloud-specific key details. + + For AWS, provide the corresponding `key_arn`. + + For Azure, provide the corresponding `key_id`. + + For GCP, provide the corresponding `key_id`. + discriminator: + propertyName: kind + mapping: + AwsKey: '#/components/schemas/byok.v1.AwsKey' + AzureKey: '#/components/schemas/byok.v1.AzureKey' + GcpKey: '#/components/schemas/byok.v1.GcpKey' + x-immutable: true + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: >- + arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: > + The Amazon Resource Names (ARNs) of IAM Roles created for + this key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - arn:aws:iam::123456789876:role/block_storage_manager + - >- + arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + application_id: + description: > + The Application ID created for this key-environment + combination. + type: string + readOnly: true + key_id: + description: > + The unique Key Object Identifier URL without version of an + Azure Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + tenant_id: + description: | + Tenant ID (uuid) hosting the Key Vault containing the key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + required: + - key_arn + - kind + - key_id + - key_vault_id + - tenant_id + display_name: + type: string + description: | + The human-readable name of the key object. + example: Key for billing cluster + x-immutable: false + provider: + type: string + x-extensible-enum: + - AWS + - Azure + - GCP + description: The cloud provider of the Key. + readOnly: true + example: AWS + state: + type: string + x-extensible-enum: + - AVAILABLE + - IN_USE + description: | + The state of the key: + + AVAILABLE: key can be used for a Kafka cluster provisioning. + + IN_USE: key is already in use by a Kafka cluster provisioning. + readOnly: true + example: IN_USE + validation: + description: | + The validation details of the key. + readOnly: true + type: object + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: > + The timestamp since which the key is in the current + validation phase. + + Changes to the validation message or phase will update + this timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: > + The cloud region where the key is deployed. This value is + computed by the + + API after the key is successfully validated. + example: us-west-2 + readOnly: true + required: + - id + - metadata + - key + - provider + - state + - validation + uniqueItems: true + byok.v1.Key: + type: object + description: >- + `Key` objects represent customer managed keys on dedicated Confluent + Cloud clusters. + + + Keys are used to protect data at rest stored in your dedicated Confluent + Cloud clusters on AWS, Azure, and GCP. + + This API allows you to upload and retrieve self-managed keys on + Confluent Cloud. + + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management + API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + + ## The Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud + organisation. | + properties: + api_version: + type: string + enum: + - byok/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Key + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + key: + type: object + description: | + The cloud-specific key details. + + For AWS, provide the corresponding `key_arn`. + + For Azure, provide the corresponding `key_id`. + + For GCP, provide the corresponding `key_id`. + discriminator: + propertyName: kind + mapping: + AwsKey: '#/components/schemas/byok.v1.AwsKey' + AzureKey: '#/components/schemas/byok.v1.AzureKey' + GcpKey: '#/components/schemas/byok.v1.GcpKey' + x-immutable: true + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: >- + arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: > + The Amazon Resource Names (ARNs) of IAM Roles created for this + key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - arn:aws:iam::123456789876:role/block_storage_manager + - >- + arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + application_id: + description: | + The Application ID created for this key-environment combination. + type: string + readOnly: true + key_id: + description: > + The unique Key Object Identifier URL without version of an Azure + Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + tenant_id: + description: | + Tenant ID (uuid) hosting the Key Vault containing the key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + required: + - key_arn + - kind + - key_id + - key_vault_id + - tenant_id + display_name: + type: string + description: | + The human-readable name of the key object. + example: Key for billing cluster + x-immutable: false + provider: + type: string + x-extensible-enum: + - AWS + - Azure + - GCP + description: The cloud provider of the Key. + readOnly: true + example: AWS + state: + type: string + x-extensible-enum: + - AVAILABLE + - IN_USE + description: | + The state of the key: + + AVAILABLE: key can be used for a Kafka cluster provisioning. + + IN_USE: key is already in use by a Kafka cluster provisioning. + readOnly: true + example: IN_USE + validation: + description: | + The validation details of the key. + readOnly: true + type: object + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: > + The timestamp since which the key is in the current validation + phase. + + Changes to the validation message or phase will update this + timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: > + The cloud region where the key is deployed. This value is + computed by the + + API after the key is successfully validated. + example: us-west-2 + readOnly: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + byok.v1.AwsKey: + type: object + description: | + The AWS BYOK details + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: >- + arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: > + The Amazon Resource Names (ARNs) of IAM Roles created for this + key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - arn:aws:iam::123456789876:role/block_storage_manager + - >- + arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + required: + - key_arn + - kind + byok.v1.AzureKey: + type: object + description: | + The Azure BYOK details. + properties: + application_id: + description: | + The Application ID created for this key-environment combination. + type: string + readOnly: true + key_id: + description: > + The unique Key Object Identifier URL without version of an Azure Key + Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + kind: + description: | + BYOK kind type. + type: string + enum: + - AzureKey + x-immutable: true + tenant_id: + description: | + Tenant ID (uuid) hosting the Key Vault containing the key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + required: + - key_id + - key_vault_id + - kind + - tenant_id + byok.v1.GcpKey: + type: object + description: | + The GCP BYOK details + properties: + key_id: + description: | + The Google Cloud Platform key ID. + type: string + example: >- + projects/exampleproject/locations/us-central1/keyRings/testkeyring/cryptoKeys/testbyokkey/cryptoKeyVersions/3 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + kind: + description: | + BYOK kind type. + type: string + enum: + - GcpKey + x-immutable: true + required: + - key_id + - kind + byok.v1.KeyValidation: + type: object + description: | + The validation details of the key. + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: > + The timestamp since which the key is in the current validation + phase. + + Changes to the validation message or phase will update this + timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: > + The cloud region where the key is deployed. This value is computed + by the + + API after the key is successfully validated. + example: us-west-2 + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + OverQuotaError: + x-summary: Over Quota + description: The request would exceed one or more quotas. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '402' + code: quota_exceeded + title: Kafka Clusters Per Org Quota Exceeded + detail: >- + The request would exceed the quota: + kafka_clusters_per_environment + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + x-stackQL-resources: + key_encryption_keys: + id: confluent.encryption_keys.key_encryption_keys + name: key_encryption_keys + title: Key Encryption Keys + methods: + get_kek_names: + operation: + $ref: '#/paths/~1dek-registry~1v1~1keks/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + objectKey: $ + create_kek: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dek-registry~1v1~1keks/post' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + delete_kek: + operation: + $ref: '#/paths/~1dek-registry~1v1~1keks~1{name}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + get_kek: + operation: + $ref: '#/paths/~1dek-registry~1v1~1keks~1{name}/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + put_kek: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dek-registry~1v1~1keks~1{name}/put' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + undelete_kek: + operation: + $ref: '#/paths/~1dek-registry~1v1~1keks~1{name}~1undelete/post' + response: + mediaType: application/json + openAPIDocKey: '204' + test_kek: + operation: + $ref: '#/paths/~1dek-registry~1v1~1keks~1{name}~1test/post' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/key_encryption_keys/methods/get_kek + - $ref: >- + #/components/x-stackQL-resources/key_encryption_keys/methods/get_kek_names + insert: + - $ref: >- + #/components/x-stackQL-resources/key_encryption_keys/methods/create_kek + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/key_encryption_keys/methods/delete_kek + replace: + - $ref: >- + #/components/x-stackQL-resources/key_encryption_keys/methods/put_kek + data_encryption_keys: + id: confluent.encryption_keys.data_encryption_keys + name: data_encryption_keys + title: Data Encryption Keys + methods: + get_dek_subjects: + operation: + $ref: '#/paths/~1dek-registry~1v1~1keks~1{name}~1deks/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + objectKey: $ + create_dek: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dek-registry~1v1~1keks~1{name}~1deks/post' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + delete_dek_versions: + operation: + $ref: '#/paths/~1dek-registry~1v1~1keks~1{name}~1deks~1{subject}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + get_dek: + operation: + $ref: '#/paths/~1dek-registry~1v1~1keks~1{name}~1deks~1{subject}/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + undelete_dek_versions: + operation: + $ref: >- + #/paths/~1dek-registry~1v1~1keks~1{name}~1deks~1{subject}~1undelete/post + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/data_encryption_keys/methods/get_dek + - $ref: >- + #/components/x-stackQL-resources/data_encryption_keys/methods/get_dek_subjects + insert: + - $ref: >- + #/components/x-stackQL-resources/data_encryption_keys/methods/create_dek + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/data_encryption_keys/methods/delete_dek_versions + replace: [] + dek_versions: + id: confluent.encryption_keys.dek_versions + name: dek_versions + title: Dek Versions + methods: + delete_dek_version: + operation: + $ref: >- + #/paths/~1dek-registry~1v1~1keks~1{name}~1deks~1{subject}~1versions~1{version}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + get_dek_by_version: + operation: + $ref: >- + #/paths/~1dek-registry~1v1~1keks~1{name}~1deks~1{subject}~1versions~1{version}/get + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + get_dek_versions: + operation: + $ref: >- + #/paths/~1dek-registry~1v1~1keks~1{name}~1deks~1{subject}~1versions/get + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + objectKey: $ + undelete_dek_version: + operation: + $ref: >- + #/paths/~1dek-registry~1v1~1keks~1{name}~1deks~1{subject}~1versions~1{version}~1undelete/post + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/dek_versions/methods/get_dek_by_version + - $ref: >- + #/components/x-stackQL-resources/dek_versions/methods/get_dek_versions + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/dek_versions/methods/delete_dek_version + replace: [] + keys: + id: confluent.encryption_keys.keys + name: keys + title: Keys + methods: + list_byok_v1_keys: + operation: + $ref: '#/paths/~1byok~1v1~1keys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_byok_v1_key: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1byok~1v1~1keys/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_byok_v1_key: + operation: + $ref: '#/paths/~1byok~1v1~1keys~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_byok_v1_key: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1byok~1v1~1keys~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_byok_v1_key: + operation: + $ref: '#/paths/~1byok~1v1~1keys~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/keys/methods/get_byok_v1_key' + - $ref: '#/components/x-stackQL-resources/keys/methods/list_byok_v1_keys' + insert: + - $ref: '#/components/x-stackQL-resources/keys/methods/create_byok_v1_key' + update: + - $ref: '#/components/x-stackQL-resources/keys/methods/update_byok_v1_key' + delete: + - $ref: '#/components/x-stackQL-resources/keys/methods/delete_byok_v1_key' + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/endpoints.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/endpoints.yaml new file mode 100644 index 0000000..faa2c6a --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/endpoints.yaml @@ -0,0 +1,1812 @@ +openapi: 3.0.0 +info: + title: endpoints API + description: confluent endpoints API + version: 1.0.0 +paths: + /endpoint/v1/endpoints: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listEndpointV1Endpoints + summary: List of Endpoints + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all endpoints. + parameters: + - name: cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for cloud. + - name: region + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-west-2 + description: Filter the results by exact match for region. + - name: service + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: KAFKA + description: Filter the results by exact match for service. + - name: is_private + in: query + required: false + schema: + $ref: '#/components/schemas/BooleanFilter' + example: true + description: > + Filter the results by whether the endpoint is private (true) or + public (false). + + If not specified, returns both private and public endpoints. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: resource + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-abc123 + description: Filter the results by exact match for resource. + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 1000 + x-max-page-items: 5000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Endpoints (endpoint/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Endpoint. + content: + application/json: + schema: + type: object + description: >- + An Endpoint object represents a Fully Qualified Domain Name + (FQDN) for a Confluent service resource + + via a specific networking solution for a given Confluent Cloud + environment. + + This API provides a list of Confluent Cloud endpoints filtered + by service, cloud provider, region, etc. + + + + Related guides: + + * [Resource Overview in Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/resource-overview.html). + + * [Manage Networking on Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + + ## The Endpoints Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - endpoint/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - EndpointList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + An Endpoint object represents a Fully Qualified Domain + Name (FQDN) for a Confluent service resource + + via a specific networking solution for a given Confluent + Cloud environment. + + This API provides a list of Confluent Cloud endpoints + filtered by service, cloud provider, region, etc. + + + + Related guides: + + * [Resource Overview in Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/resource-overview.html). + + * [Manage Networking on Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + + ## The Endpoints Model + + + properties: + api_version: + type: string + enum: + - endpoint/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Endpoint + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + readOnly: true + region: + type: string + description: >- + The cloud service provider region in which the + resource is located. + example: us-west-2 + readOnly: true + service: + type: string + description: The Confluent Cloud service. + x-extensible-enum: + - KAFKA + - SCHEMA_REGISTRY + - FLINK + example: KAFKA + readOnly: true + is_private: + type: boolean + description: >- + Whether the endpoint is private (true) or public + (false). + example: true + readOnly: true + connection_type: + type: string + description: The network connection type. + x-extensible-enum: + - PUBLIC + - PRIVATE_LINK + - PEERING + - TRANSIT_GATEWAY + - PRIVATE_NETWORK_INTERFACE + example: PRIVATE_LINK + readOnly: true + endpoint: + type: string + description: The endpoint URL or address. + example: >- + https://lkc-abc123-ap12345.us-west-2.aws.accesspoint.glb.confluent.cloud:443 + readOnly: true + endpoint_type: + type: string + description: > + The endpoint type enum values: + + * `REST` - REST API endpoint for HTTP/HTTPS access, + used by Kafka/Flink/Schema Registry services. + + * `BOOTSTRAP` - Kafka native protocol bootstrap + servers for direct client connections, used by Kafka + only. + + * `LANGUAGE_SERVICE` - Flink language service + endpoint for SQL/Table API, used by Flink only. + x-extensible-enum: + - REST + - BOOTSTRAP + - LANGUAGE_SERVICE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: >- + Environment of the referred resource, if + env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + resource: + description: > + The resource associated with the endpoint. + + The resource can be one of Kafka Cluster ID + (example: lkc-12345), + + or Schema Registry Cluster ID (example: lsrc-12345). + + May be null or omitted if not associated with a + resource. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: >- + Environment of the referred resource, if + env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + gateway: + description: The gateway to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: >- + Environment of the referred resource, if + env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + access_point: + description: The access_point to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: >- + Environment of the referred resource, if + env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - cloud + - region + - service + - is_private + - connection_type + - endpoint + - endpoint_type + - environment + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + BooleanFilter: + type: boolean + description: Filter for whether this value is true or false. + endpoint.v1.EndpointList: + type: object + description: >- + An Endpoint object represents a Fully Qualified Domain Name (FQDN) for a + Confluent service resource + + via a specific networking solution for a given Confluent Cloud + environment. + + This API provides a list of Confluent Cloud endpoints filtered by + service, cloud provider, region, etc. + + + + Related guides: + + * [Resource Overview in Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/resource-overview.html). + + * [Manage Networking on Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + + ## The Endpoints Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - endpoint/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - EndpointList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + An Endpoint object represents a Fully Qualified Domain Name (FQDN) + for a Confluent service resource + + via a specific networking solution for a given Confluent Cloud + environment. + + This API provides a list of Confluent Cloud endpoints filtered by + service, cloud provider, region, etc. + + + + Related guides: + + * [Resource Overview in Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/resource-overview.html). + + * [Manage Networking on Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + + ## The Endpoints Model + + + properties: + api_version: + type: string + enum: + - endpoint/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Endpoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + readOnly: true + region: + type: string + description: >- + The cloud service provider region in which the resource is + located. + example: us-west-2 + readOnly: true + service: + type: string + description: The Confluent Cloud service. + x-extensible-enum: + - KAFKA + - SCHEMA_REGISTRY + - FLINK + example: KAFKA + readOnly: true + is_private: + type: boolean + description: Whether the endpoint is private (true) or public (false). + example: true + readOnly: true + connection_type: + type: string + description: The network connection type. + x-extensible-enum: + - PUBLIC + - PRIVATE_LINK + - PEERING + - TRANSIT_GATEWAY + - PRIVATE_NETWORK_INTERFACE + example: PRIVATE_LINK + readOnly: true + endpoint: + type: string + description: The endpoint URL or address. + example: >- + https://lkc-abc123-ap12345.us-west-2.aws.accesspoint.glb.confluent.cloud:443 + readOnly: true + endpoint_type: + type: string + description: > + The endpoint type enum values: + + * `REST` - REST API endpoint for HTTP/HTTPS access, used by + Kafka/Flink/Schema Registry services. + + * `BOOTSTRAP` - Kafka native protocol bootstrap servers for + direct client connections, used by Kafka only. + + * `LANGUAGE_SERVICE` - Flink language service endpoint for + SQL/Table API, used by Flink only. + x-extensible-enum: + - REST + - BOOTSTRAP + - LANGUAGE_SERVICE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + resource: + description: > + The resource associated with the endpoint. + + The resource can be one of Kafka Cluster ID (example: + lkc-12345), + + or Schema Registry Cluster ID (example: lsrc-12345). + + May be null or omitted if not associated with a resource. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + gateway: + description: The gateway to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + access_point: + description: The access_point to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - cloud + - region + - service + - is_private + - connection_type + - endpoint + - endpoint_type + - environment + uniqueItems: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + endpoint.v1.Endpoint: + type: object + description: >- + An Endpoint object represents a Fully Qualified Domain Name (FQDN) for a + Confluent service resource + + via a specific networking solution for a given Confluent Cloud + environment. + + This API provides a list of Confluent Cloud endpoints filtered by + service, cloud provider, region, etc. + + + + Related guides: + + * [Resource Overview in Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/resource-overview.html). + + * [Manage Networking on Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + + ## The Endpoints Model + + + properties: + api_version: + type: string + enum: + - endpoint/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Endpoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + readOnly: true + region: + type: string + description: The cloud service provider region in which the resource is located. + example: us-west-2 + readOnly: true + service: + type: string + description: The Confluent Cloud service. + x-extensible-enum: + - KAFKA + - SCHEMA_REGISTRY + - FLINK + example: KAFKA + readOnly: true + is_private: + type: boolean + description: Whether the endpoint is private (true) or public (false). + example: true + readOnly: true + connection_type: + type: string + description: The network connection type. + x-extensible-enum: + - PUBLIC + - PRIVATE_LINK + - PEERING + - TRANSIT_GATEWAY + - PRIVATE_NETWORK_INTERFACE + example: PRIVATE_LINK + readOnly: true + endpoint: + type: string + description: The endpoint URL or address. + example: >- + https://lkc-abc123-ap12345.us-west-2.aws.accesspoint.glb.confluent.cloud:443 + readOnly: true + endpoint_type: + type: string + description: > + The endpoint type enum values: + + * `REST` - REST API endpoint for HTTP/HTTPS access, used by + Kafka/Flink/Schema Registry services. + + * `BOOTSTRAP` - Kafka native protocol bootstrap servers for direct + client connections, used by Kafka only. + + * `LANGUAGE_SERVICE` - Flink language service endpoint for SQL/Table + API, used by Flink only. + x-extensible-enum: + - REST + - BOOTSTRAP + - LANGUAGE_SERVICE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + resource: + description: | + The resource associated with the endpoint. + The resource can be one of Kafka Cluster ID (example: lkc-12345), + or Schema Registry Cluster ID (example: lsrc-12345). + May be null or omitted if not associated with a resource. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + gateway: + description: The gateway to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + access_point: + description: The access_point to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + ObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + TypedEnvScopedObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + x-stackQL-resources: + endpoints: + id: confluent.endpoints.endpoints + name: endpoints + title: Endpoints + methods: + list_endpoint_v1_endpoints: + operation: + $ref: '#/paths/~1endpoint~1v1~1endpoints/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/endpoints/methods/list_endpoint_v1_endpoints + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/flink_artifacts.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/flink_artifacts.yaml new file mode 100644 index 0000000..b64c96c --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/flink_artifacts.yaml @@ -0,0 +1,3435 @@ +openapi: 3.0.0 +info: + title: flink_artifacts API + description: confluent flink_artifacts API + version: 1.0.0 +paths: + /artifact/v1/flink-artifacts: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listArtifactV1FlinkArtifacts + summary: List of Flink Artifacts + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all flink artifacts. + parameters: + - name: cloud + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for cloud. + - name: region + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-1 + description: Filter the results by exact match for region. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Flink Artifacts (artifact/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Flink Artifact. + content: + application/json: + schema: + type: object + description: >- + FlinkArtifact objects represent Flink Artifacts on Confluent + Cloud. + + + + ## The Flink Artifacts Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - artifact/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifactList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + FlinkArtifact objects represent Flink Artifacts on + Confluent Cloud. + + + + ## The Flink Artifacts Model + + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - FlinkArtifact + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: >- + Cloud provider where the Flink Artifact archive is + uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: >- + The Cloud provider region the Flink Artifact archive + is uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: >- + Unique name of the Flink Artifact per cloud, region, + environment scope. + maxLength: 60 + class: + type: string + description: >- + Java class or alias for the artifact as provided by + developer. Deprecated + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + x-immutable: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + versions: + type: array + description: Versions associated with this Flink Artifact. + items: + $ref: >- + #/components/schemas/artifact.v1.FlinkArtifactVersion + required: + - id + - metadata + - cloud + - region + - environment + - display_name + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + summary: Create a new Flink Artifact. + requestBody: + content: + application/json: + schema: + type: object + properties: + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: >- + The Cloud provider region the Flink Artifact archive is + uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: >- + Unique name of the Flink Artifact per cloud, region, + environment scope. + maxLength: 60 + class: + type: string + description: >- + Java class or alias for the artifact as provided by + developer. Deprecated + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + upload_source: + type: object + description: Upload source of the Flink Artifact source. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: >- + #/components/schemas/artifact.v1.UploadSource.PresignedUrl + properties: + api_version: + type: string + enum: + - artifact.v1/UploadSource + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but + not space. That is, you can assume that the ID will not + be reclaimed and reused after an object is deleted + ("time"); however, it may collide with IDs for other + object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the + service location, API version, and other particulars + necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. + It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is + in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + location: + type: string + description: | + Location of the Flink Artifact source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: >- + Upload ID returned by the `/presigned-upload-url` API. + This field returns an empty string in all responses. + required: + - cloud + - region + - environment + - display_name + - upload_source + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createArtifactV1FlinkArtifact + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a flink artifact. + parameters: + - name: cloud + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Scope the operation to the given cloud. + - name: region + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-1 + description: Scope the operation to the given region. + tags: + - Flink Artifacts (artifact/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '201': + description: A Flink Artifact was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/artifact/v1/flink-artifacts/{id} + description: FlinkArtifact resource uri + content: + application/json: + schema: + type: object + description: >- + FlinkArtifact objects represent Flink Artifacts on Confluent + Cloud. + + + + ## The Flink Artifacts Model + + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifact + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + cloud: + type: string + description: >- + Cloud provider where the Flink Artifact archive is + uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: >- + The Cloud provider region the Flink Artifact archive is + uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: >- + Unique name of the Flink Artifact per cloud, region, + environment scope. + maxLength: 60 + class: + type: string + description: >- + Java class or alias for the artifact as provided by + developer. Deprecated + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + x-immutable: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + versions: + type: array + description: Versions associated with this Flink Artifact. + items: + $ref: '#/components/schemas/artifact.v1.FlinkArtifactVersion' + required: + - cloud + - region + - environment + - display_name + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /artifact/v1/flink-artifacts/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getArtifactV1FlinkArtifact + summary: Read a Flink Artifact + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a flink artifact. + parameters: + - name: cloud + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Scope the operation to the given cloud. + - name: region + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-1 + description: Scope the operation to the given region. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the flink artifact. + tags: + - Flink Artifacts (artifact/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Flink Artifact. + content: + application/json: + schema: + type: object + description: >- + FlinkArtifact objects represent Flink Artifacts on Confluent + Cloud. + + + + ## The Flink Artifacts Model + + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifact + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + cloud: + type: string + description: >- + Cloud provider where the Flink Artifact archive is + uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: >- + The Cloud provider region the Flink Artifact archive is + uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: >- + Unique name of the Flink Artifact per cloud, region, + environment scope. + maxLength: 60 + class: + type: string + description: >- + Java class or alias for the artifact as provided by + developer. Deprecated + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + x-immutable: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + versions: + type: array + description: Versions associated with this Flink Artifact. + items: + $ref: '#/components/schemas/artifact.v1.FlinkArtifactVersion' + required: + - api_version + - kind + - id + - cloud + - region + - environment + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateArtifactV1FlinkArtifact + summary: Update a Flink Artifact + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a flink artifact. + + parameters: + - name: cloud + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Scope the operation to the given cloud. + - name: region + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-1 + description: Scope the operation to the given region. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the flink artifact. + tags: + - Flink Artifacts (artifact/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/artifact.v1.FlinkArtifact' + responses: + '200': + description: Flink Artifact. + content: + application/json: + schema: + type: object + description: >- + FlinkArtifact objects represent Flink Artifacts on Confluent + Cloud. + + + + ## The Flink Artifacts Model + + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifact + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + cloud: + type: string + description: >- + Cloud provider where the Flink Artifact archive is + uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: >- + The Cloud provider region the Flink Artifact archive is + uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: >- + Unique name of the Flink Artifact per cloud, region, + environment scope. + maxLength: 60 + class: + type: string + description: >- + Java class or alias for the artifact as provided by + developer. Deprecated + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + x-immutable: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + versions: + type: array + description: Versions associated with this Flink Artifact. + items: + $ref: '#/components/schemas/artifact.v1.FlinkArtifactVersion' + required: + - api_version + - kind + - id + - cloud + - region + - environment + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteArtifactV1FlinkArtifact + summary: Delete a Flink Artifact + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a flink artifact. + parameters: + - name: cloud + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Scope the operation to the given cloud. + - name: region + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-1 + description: Scope the operation to the given region. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the flink artifact. + tags: + - Flink Artifacts (artifact/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Flink Artifact is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /artifact/v1/presigned-upload-url: + post: + summary: Request a presigned upload URL for a new Flink Artifact. + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Request a presigned upload URL to upload a Flink Artifact archive. + requestBody: + content: + application/json: + schema: + type: object + description: | + Request schema of the presigned upload URL. + properties: + api_version: + type: string + enum: + - artifact/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrlRequest + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + content_format: + type: string + example: JAR + description: Archive format of the Flink Artifact. + x-extensible-enum: + - JAR + - ZIP + cloud: + type: string + example: AWS + description: Cloud provider where the Flink Artifact archive is uploaded. + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + example: us-east-1 + description: >- + The Cloud provider region the Flink Artifact archive is + uploaded. + maxLength: 60 + environment: + type: string + example: env-00000 + description: The Environment the uploaded Flink Artifact belongs to. + maxLength: 255 + required: + - content_format + - cloud + - region + - environment + x-lifecycle-stage: General Availability + x-self-access: true + x-name: artifact.v1.PresignedUrl + operationId: presigned-upload-urlArtifactV1PresignedUrl + tags: + - Presigned Urls (artifact/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Presigned Url. + content: + application/json: + schema: + type: object + description: >- + Request a presigned upload URL for new Flink Artifact. Note + that + + the URL policy expires in one hour. If the policy expires, you + can request + + a new presigned upload URL. + + + + ## The Presigned Urls Model + + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Flink Artifact archive. + example: JAR + x-extensible-enum: + - ZIP + - JAR + readOnly: true + cloud: + type: string + description: >- + Cloud provider where the Flink Artifact archive is + uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + readOnly: true + region: + type: string + description: >- + The Cloud provider region the Flink Artifact archive is + uploaded. + example: us-east-1 + readOnly: true + environment: + type: string + description: The Environment the uploaded Flink Artifact belongs to. + example: env-00000 + readOnly: true + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Flink Artifact archive. + example: >- + https://confluent-flink-artifacts-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: string + description: >- + Upload form data of the Flink Artifact. All values should + be strings. (opaque JSON object) + example: + bucket: confluent-flink-artifacts-stag-us-west-2 + key: >- + staging/flink-artifact/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/flink-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/artifact.jar + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + readOnly: true + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + artifact.v1.FlinkArtifactList: + type: object + description: >- + FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. + + + + ## The Flink Artifacts Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - artifact/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifactList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + FlinkArtifact objects represent Flink Artifacts on Confluent + Cloud. + + + + ## The Flink Artifacts Model + + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifact + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: >- + The Cloud provider region the Flink Artifact archive is + uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: >- + Unique name of the Flink Artifact per cloud, region, + environment scope. + maxLength: 60 + class: + type: string + description: >- + Java class or alias for the artifact as provided by developer. + Deprecated + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + x-immutable: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + versions: + type: array + description: Versions associated with this Flink Artifact. + items: + $ref: '#/components/schemas/artifact.v1.FlinkArtifactVersion' + required: + - id + - metadata + - cloud + - region + - environment + - display_name + uniqueItems: true + artifact.v1.UploadSource.PresignedUrl: + type: object + description: >- + Request a presigned upload URL for new Flink Artifact. Note that + + the URL policy expires in one hour. If the policy expires, you can + request + + a new presigned upload URL. + + + + ## The Presigned Urls Model + + + properties: + api_version: + type: string + enum: + - artifact.v1/UploadSource + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + location: + type: string + description: | + Location of the Flink Artifact source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: >- + Upload ID returned by the `/presigned-upload-url` API. This field + returns an empty string in all responses. + artifact.v1.FlinkArtifact: + type: object + description: >- + FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. + + + + ## The Flink Artifacts Model + + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifact + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: The Cloud provider region the Flink Artifact archive is uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: >- + Unique name of the Flink Artifact per cloud, region, environment + scope. + maxLength: 60 + class: + type: string + description: >- + Java class or alias for the artifact as provided by developer. + Deprecated + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + x-immutable: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + versions: + type: array + description: Versions associated with this Flink Artifact. + items: + $ref: '#/components/schemas/artifact.v1.FlinkArtifactVersion' + artifact.v1.PresignedUrlRequest: + type: object + description: | + Request schema of the presigned upload URL. + properties: + api_version: + type: string + enum: + - artifact/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrlRequest + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + content_format: + type: string + example: JAR + description: Archive format of the Flink Artifact. + x-extensible-enum: + - JAR + - ZIP + cloud: + type: string + example: AWS + description: Cloud provider where the Flink Artifact archive is uploaded. + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + example: us-east-1 + description: The Cloud provider region the Flink Artifact archive is uploaded. + maxLength: 60 + environment: + type: string + example: env-00000 + description: The Environment the uploaded Flink Artifact belongs to. + maxLength: 255 + artifact.v1.PresignedUrl: + type: object + description: >- + Request a presigned upload URL for new Flink Artifact. Note that + + the URL policy expires in one hour. If the policy expires, you can + request + + a new presigned upload URL. + + + + ## The Presigned Urls Model + + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Flink Artifact archive. + example: JAR + x-extensible-enum: + - ZIP + - JAR + readOnly: true + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + readOnly: true + region: + type: string + description: The Cloud provider region the Flink Artifact archive is uploaded. + example: us-east-1 + readOnly: true + environment: + type: string + description: The Environment the uploaded Flink Artifact belongs to. + example: env-00000 + readOnly: true + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Flink Artifact archive. + example: >- + https://confluent-flink-artifacts-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: string + description: >- + Upload form data of the Flink Artifact. All values should be + strings. (opaque JSON object) + example: + bucket: confluent-flink-artifacts-stag-us-west-2 + key: >- + staging/flink-artifact/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/flink-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/artifact.jar + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + readOnly: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + artifact.v1.FlinkArtifactVersion: + type: object + description: | + Version of the Flink Artifact + properties: + version: + type: string + description: Version id of the Flink Artifact. + example: cfa-ver-001 + maxLength: 60 + release_notes: + type: string + description: Release Notes of the Flink Artifact version. + maxLength: 256 + is_beta: + type: boolean + description: Flag to specify stability of the version + artifact_id: + type: object + description: The Flink Artifact this version belongs to. + properties: + api_version: + type: string + enum: + - artifact/v1 + description: >- + APIVersion defines the schema version of this representation of + a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifact + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be reclaimed + and reused after an object is deleted ("time"); however, it may + collide with IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object + can be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as + a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It + is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: >- + The Cloud provider region the Flink Artifact archive is + uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: >- + Unique name of the Flink Artifact per cloud, region, environment + scope. + maxLength: 60 + class: + type: string + description: >- + Java class or alias for the artifact as provided by developer. + Deprecated + maxLength: 150 + pattern: >- + ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + x-immutable: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + versions: + type: array + description: Versions associated with this Flink Artifact. + items: + $ref: '#/components/schemas/artifact.v1.FlinkArtifactVersion' + upload_source: + type: object + description: Upload source of the Flink Artifact Version. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/artifact.v1.UploadSource.PresignedUrl' + properties: + api_version: + type: string + enum: + - artifact.v1/UploadSource + description: >- + APIVersion defines the schema version of this representation of + a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be reclaimed + and reused after an object is deleted ("time"); however, it may + collide with IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object + can be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as + a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It + is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + location: + type: string + description: | + Location of the Flink Artifact source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: >- + Upload ID returned by the `/presigned-upload-url` API. This + field returns an empty string in all responses. + required: + - version + - artifact_id + - upload_source + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + x-stackQL-resources: + flink_artifacts: + id: confluent.flink_artifacts.flink_artifacts + name: flink_artifacts + title: Flink Artifacts + methods: + list_artifact_v1_flink_artifacts: + operation: + $ref: '#/paths/~1artifact~1v1~1flink-artifacts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_artifact_v1_flink_artifact: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1artifact~1v1~1flink-artifacts/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_artifact_v1_flink_artifact: + operation: + $ref: '#/paths/~1artifact~1v1~1flink-artifacts~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_artifact_v1_flink_artifact: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1artifact~1v1~1flink-artifacts~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_artifact_v1_flink_artifact: + operation: + $ref: '#/paths/~1artifact~1v1~1flink-artifacts~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/flink_artifacts/methods/get_artifact_v1_flink_artifact + - $ref: >- + #/components/x-stackQL-resources/flink_artifacts/methods/list_artifact_v1_flink_artifacts + insert: + - $ref: >- + #/components/x-stackQL-resources/flink_artifacts/methods/create_artifact_v1_flink_artifact + update: + - $ref: >- + #/components/x-stackQL-resources/flink_artifacts/methods/update_artifact_v1_flink_artifact + delete: + - $ref: >- + #/components/x-stackQL-resources/flink_artifacts/methods/delete_artifact_v1_flink_artifact + replace: [] + presigned_urls: + id: confluent.flink_artifacts.presigned_urls + name: presigned_urls + title: Presigned Urls + methods: + presigned_upload_url_artifact_v1_presigned_url: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1artifact~1v1~1presigned-upload-url/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/flink_compute_pools.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/flink_compute_pools.yaml new file mode 100644 index 0000000..a45b9f6 --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/flink_compute_pools.yaml @@ -0,0 +1,3483 @@ +openapi: 3.0.0 +info: + title: flink_compute_pools API + description: confluent flink_compute_pools API + version: 1.0.0 +paths: + /fcpm/v2/compute-pools: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listFcpmV2ComputePools + summary: List of Compute Pools + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all compute pools. + parameters: + - name: spec.region + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-west-1 + description: Filter the results by exact match for spec.region. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: n-00000 + description: Filter the results by exact match for spec.network. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Compute Pools (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Compute Pool. + content: + application/json: + schema: + type: object + description: >- + A Compute Pool represents a set of compute resources that is + used to run your Queries. + + The resources (CPUs, memory,…) provided by a Compute Pool are + shared between all Queries that use it. + + Note that the Compute Pool API supports a limited pagination + API, only the `next` field will be populated. + + + + ## The Compute Pools Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePoolList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + A Compute Pool represents a set of compute resources + that is used to run your Queries. + + The resources (CPUs, memory,…) provided by a Compute + Pool are shared between all Queries that use it. + + Note that the Compute Pool API supports a limited + pagination API, only the `next` field will be populated. + + + + ## The Compute Pools Model + + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - ComputePool + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createFcpmV2ComputePool + summary: Create a Compute Pool + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a compute pool. + tags: + - Compute Pools (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + A Compute Pool represents a set of compute resources that is + used to run your Queries. + + The resources (CPUs, memory,…) provided by a Compute Pool are + shared between all Queries that use it. + + Note that the Compute Pool API supports a limited pagination + API, only the `next` field will be populated. + + + + ## The Compute Pools Model + + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + required: + - spec + responses: + '202': + description: A Compute Pool is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/fcpm/v2/compute-pools/{id} + description: ComputePool resource uri + content: + application/json: + schema: + type: object + description: >- + A Compute Pool represents a set of compute resources that is + used to run your Queries. + + The resources (CPUs, memory,…) provided by a Compute Pool are + shared between all Queries that use it. + + Note that the Compute Pool API supports a limited pagination + API, only the `next` field will be populated. + + + + ## The Compute Pools Model + + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /fcpm/v2/compute-pools/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getFcpmV2ComputePool + summary: Read a Compute Pool + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a compute pool. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the compute pool. + tags: + - Compute Pools (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Compute Pool. + content: + application/json: + schema: + type: object + description: >- + A Compute Pool represents a set of compute resources that is + used to run your Queries. + + The resources (CPUs, memory,…) provided by a Compute Pool are + shared between all Queries that use it. + + Note that the Compute Pool API supports a limited pagination + API, only the `next` field will be populated. + + + + ## The Compute Pools Model + + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateFcpmV2ComputePool + summary: Update a Compute Pool + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a compute pool. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the compute pool. + tags: + - Compute Pools (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + A Compute Pool represents a set of compute resources that is + used to run your Queries. + + The resources (CPUs, memory,…) provided by a Compute Pool are + shared between all Queries that use it. + + Note that the Compute Pool API supports a limited pagination + API, only the `next` field will be populated. + + + + ## The Compute Pools Model + + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + required: + - spec + responses: + '200': + description: Compute Pool. + content: + application/json: + schema: + type: object + description: >- + A Compute Pool represents a set of compute resources that is + used to run your Queries. + + The resources (CPUs, memory,…) provided by a Compute Pool are + shared between all Queries that use it. + + Note that the Compute Pool API supports a limited pagination + API, only the `next` field will be populated. + + + + ## The Compute Pools Model + + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteFcpmV2ComputePool + summary: Delete a Compute Pool + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a compute pool. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the compute pool. + tags: + - Compute Pools (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Compute Pool is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /fcpm/v2/regions: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listFcpmV2Regions + summary: List of Regions + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all regions. + parameters: + - name: cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for cloud. + - name: region_name + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-2 + description: Filter the results by exact match for region_name. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Regions (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Region. + content: + application/json: + schema: + type: object + description: >- + `Region` objects represent cloud provider regions available + when placing Flink compute pools. + + The API allows you to list Flink regions. + + + + ## The Regions Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RegionList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Region` objects represent cloud provider regions + available when placing Flink compute pools. + + The API allows you to list Flink regions. + + + + ## The Regions Model + + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Region + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The display name. + example: Ohio (us-east-2) + x-immutable: true + readOnly: true + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + readOnly: true + region_name: + type: string + description: The region name. + example: us-east-2 + x-immutable: true + readOnly: true + http_endpoint: + type: string + description: The regional API endpoint for Flink compute pools. + format: uri + x-immutable: true + readOnly: true + private_http_endpoint: + type: string + description: >- + The private regional API endpoint for Flink compute + pools. + format: uri + x-immutable: true + readOnly: true + required: + - id + - metadata + - display_name + - cloud + - region_name + - http_endpoint + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /fcpm/v2/compute-pool-config: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getFcpmV2OrgComputePoolConfig + summary: Read an Org Compute Pool Config + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read an org compute pool config. + tags: + - Org Compute Pool Configs (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Org Compute Pool Config. + content: + application/json: + schema: + type: object + description: >- + `OrgComputePoolConfig` manages compute pool configuration + settings for an organization. + + The API allows you to read and update organization-wide + settings such as whether default pools are enabled + + and their maximum CFU limits. + + + + ## The Org Compute Pool Configs Model + + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OrgComputePoolConfig + organization_id: + type: string + description: The ID of the organization. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + x-immutable: true + readOnly: true + spec: + type: object + description: >- + The desired state of the organization-level Compute Pool + configuration + properties: + default_pool_enabled: + type: boolean + default: true + description: > + Whether default compute pools are enabled for the + organization. + + When enabled, environments can have default compute + pools created automatically. + x-immutable: false + default_pool_max_cfu: + type: integer + format: int32 + example: 20 + description: > + Maximum number of Confluent Flink Units (CFUs) that + default compute pools + + in this organization should auto-scale to. + x-extensible-enum: + - 5 + - 10 + - 20 + - 30 + - 40 + - 50 + x-immutable: false + x-immutable: false + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateFcpmV2OrgComputePoolConfig + summary: Update an Org Compute Pool Config + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update an org compute pool config. + tags: + - Org Compute Pool Configs (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/fcpm.v2.OrgComputePoolConfig' + responses: + '200': + description: Org Compute Pool Config. + content: + application/json: + schema: + type: object + description: >- + `OrgComputePoolConfig` manages compute pool configuration + settings for an organization. + + The API allows you to read and update organization-wide + settings such as whether default pools are enabled + + and their maximum CFU limits. + + + + ## The Org Compute Pool Configs Model + + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OrgComputePoolConfig + organization_id: + type: string + description: The ID of the organization. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + x-immutable: true + readOnly: true + spec: + type: object + description: >- + The desired state of the organization-level Compute Pool + configuration + properties: + default_pool_enabled: + type: boolean + default: true + description: > + Whether default compute pools are enabled for the + organization. + + When enabled, environments can have default compute + pools created automatically. + x-immutable: false + default_pool_max_cfu: + type: integer + format: int32 + example: 20 + description: > + Maximum number of Confluent Flink Units (CFUs) that + default compute pools + + in this organization should auto-scale to. + x-extensible-enum: + - 5 + - 10 + - 20 + - 30 + - 40 + - 50 + x-immutable: false + x-immutable: false + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + fcpm.v2.ComputePoolList: + type: object + description: >- + A Compute Pool represents a set of compute resources that is used to run + your Queries. + + The resources (CPUs, memory,…) provided by a Compute Pool are shared + between all Queries that use it. + + Note that the Compute Pool API supports a limited pagination API, only + the `next` field will be populated. + + + + ## The Compute Pools Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePoolList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + A Compute Pool represents a set of compute resources that is used + to run your Queries. + + The resources (CPUs, memory,…) provided by a Compute Pool are + shared between all Queries that use it. + + Note that the Compute Pool API supports a limited pagination API, + only the `next` field will be populated. + + + + ## The Compute Pools Model + + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + fcpm.v2.ComputePool: + type: object + description: >- + A Compute Pool represents a set of compute resources that is used to run + your Queries. + + The resources (CPUs, memory,…) provided by a Compute Pool are shared + between all Queries that use it. + + Note that the Compute Pool API supports a limited pagination API, only + the `next` field will be populated. + + + + ## The Compute Pools Model + + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + fcpm.v2.RegionList: + type: object + description: >- + `Region` objects represent cloud provider regions available when placing + Flink compute pools. + + The API allows you to list Flink regions. + + + + ## The Regions Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RegionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Region` objects represent cloud provider regions available when + placing Flink compute pools. + + The API allows you to list Flink regions. + + + + ## The Regions Model + + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + description: The display name. + example: Ohio (us-east-2) + x-immutable: true + readOnly: true + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + readOnly: true + region_name: + type: string + description: The region name. + example: us-east-2 + x-immutable: true + readOnly: true + http_endpoint: + type: string + description: The regional API endpoint for Flink compute pools. + format: uri + x-immutable: true + readOnly: true + private_http_endpoint: + type: string + description: The private regional API endpoint for Flink compute pools. + format: uri + x-immutable: true + readOnly: true + required: + - id + - metadata + - display_name + - cloud + - region_name + - http_endpoint + uniqueItems: true + fcpm.v2.OrgComputePoolConfig: + type: object + description: >- + `OrgComputePoolConfig` manages compute pool configuration settings for + an organization. + + The API allows you to read and update organization-wide settings such as + whether default pools are enabled + + and their maximum CFU limits. + + + + ## The Org Compute Pool Configs Model + + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OrgComputePoolConfig + organization_id: + type: string + description: The ID of the organization. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + x-immutable: true + readOnly: true + spec: + type: object + description: >- + The desired state of the organization-level Compute Pool + configuration + properties: + default_pool_enabled: + type: boolean + default: true + description: > + Whether default compute pools are enabled for the organization. + + When enabled, environments can have default compute pools + created automatically. + x-immutable: false + default_pool_max_cfu: + type: integer + format: int32 + example: 20 + description: > + Maximum number of Confluent Flink Units (CFUs) that default + compute pools + + in this organization should auto-scale to. + x-extensible-enum: + - 5 + - 10 + - 20 + - 30 + - 40 + - 50 + x-immutable: false + x-immutable: false + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + fcpm.v2.ComputePoolSpec: + type: object + description: The desired state of the Compute Pool + properties: + display_name: + type: string + example: flink_compute_pool_0 + description: The name of the Flink compute pool. + pattern: ^(?:[0-9A-Za-z\-])[\w\.-]{0,63}$ + x-immutable: false + cloud: + type: string + description: The cloud service provider that runs the compute pool. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + example: us-west-1 + description: >- + Flink compute pools in the region provided will be able to use this + identity pool + x-immutable: true + max_cfu: + type: integer + format: int32 + example: 5 + description: > + Maximum number of Confluent Flink Units (CFUs) that the Flink + compute pool should auto-scale to. + x-extensible-enum: + - 5 + - 10 + - 20 + - 30 + - 40 + - 50 + x-immutable: false + enable_ai: + type: boolean + default: false + description: > + The flag to enable AI computing using Ray for the Flink compute + pool. It's available in the Early Access API + + lifecycle stage only. + x-immutable: true + default_pool: + type: boolean + default: false + description: > + The flag to indicate whether the Flink compute pool is a default + compute pool or not. + + Only one default compute pool per environment and region is allowed. + x-immutable: false + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + description: The network to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + fcpm.v2.ComputePoolStatus: + type: object + required: + - phase + - current_cfu + description: The status of the Compute Pool + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PROVISIONED + - FAILED + - DEPROVISIONING + description: Status of the Flink compute pool. + example: PROVISIONING + readOnly: true + current_cfu: + type: integer + format: int32 + example: 4 + description: >- + The number of Confluent Flink Units (CFUs) currently allocated to + this Flink compute pool. + readOnly: true + readOnly: true + fcpm.v2.Region: + type: object + description: >- + `Region` objects represent cloud provider regions available when placing + Flink compute pools. + + The API allows you to list Flink regions. + + + + ## The Regions Model + + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The display name. + example: Ohio (us-east-2) + x-immutable: true + readOnly: true + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + readOnly: true + region_name: + type: string + description: The region name. + example: us-east-2 + x-immutable: true + readOnly: true + http_endpoint: + type: string + description: The regional API endpoint for Flink compute pools. + format: uri + x-immutable: true + readOnly: true + private_http_endpoint: + type: string + description: The private regional API endpoint for Flink compute pools. + format: uri + x-immutable: true + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + GlobalObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + EnvScopedObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + x-stackQL-resources: + compute_pools: + id: confluent.flink_compute_pools.compute_pools + name: compute_pools + title: Compute Pools + methods: + list_fcpm_v2_compute_pools: + operation: + $ref: '#/paths/~1fcpm~1v2~1compute-pools/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_fcpm_v2_compute_pool: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1fcpm~1v2~1compute-pools/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_fcpm_v2_compute_pool: + operation: + $ref: '#/paths/~1fcpm~1v2~1compute-pools~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_fcpm_v2_compute_pool: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1fcpm~1v2~1compute-pools~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_fcpm_v2_compute_pool: + operation: + $ref: '#/paths/~1fcpm~1v2~1compute-pools~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/compute_pools/methods/get_fcpm_v2_compute_pool + - $ref: >- + #/components/x-stackQL-resources/compute_pools/methods/list_fcpm_v2_compute_pools + insert: + - $ref: >- + #/components/x-stackQL-resources/compute_pools/methods/create_fcpm_v2_compute_pool + update: + - $ref: >- + #/components/x-stackQL-resources/compute_pools/methods/update_fcpm_v2_compute_pool + delete: + - $ref: >- + #/components/x-stackQL-resources/compute_pools/methods/delete_fcpm_v2_compute_pool + replace: [] + regions: + id: confluent.flink_compute_pools.regions + name: regions + title: Regions + methods: + list_fcpm_v2_regions: + operation: + $ref: '#/paths/~1fcpm~1v2~1regions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/regions/methods/list_fcpm_v2_regions + insert: [] + update: [] + delete: [] + replace: [] + org_compute_pool_configs: + id: confluent.flink_compute_pools.org_compute_pool_configs + name: org_compute_pool_configs + title: Org Compute Pool Configs + methods: + get_fcpm_v2_org_compute_pool_config: + operation: + $ref: '#/paths/~1fcpm~1v2~1compute-pool-config/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_fcpm_v2_org_compute_pool_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1fcpm~1v2~1compute-pool-config/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_compute_pool_configs/methods/get_fcpm_v2_org_compute_pool_config + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/org_compute_pool_configs/methods/update_fcpm_v2_org_compute_pool_config + delete: [] + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/iam.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/iam.yaml new file mode 100644 index 0000000..15fb1c2 --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/iam.yaml @@ -0,0 +1,22690 @@ +openapi: 3.0.0 +info: + title: iam API + description: confluent iam API + version: 1.0.0 +paths: + /iam/v2/api-keys: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2ApiKeys + summary: List of API Keys + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all API keys. + + + This can show all keys for a single owner (across resources - Kafka + clusters), or all keys for a single + + resource (across owners). If no `owner` or `resource` filters are + specified, returns all API Keys in the + + organization. You will only see the keys that are accessible to the + account making the API request. + parameters: + - name: spec.owner + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + description: Filter the results by exact match for spec.owner. + - name: spec.resource + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + description: Filter the results by exact match for spec.resource. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - API Keys (iam/v2) + security: + - cloud-api-key: [] + responses: + '200': + description: API Key. + content: + application/json: + schema: + type: object + description: >- + `ApiKey` objects represent access to different parts of + Confluent Cloud. Some types + + of API keys represent access to a single cluster/resource such + as a Kafka cluster, + + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys + represent access to resources within an organization + + that are not tied to a specific cluster, such as the Org API, + IAM API, Metrics API or Connect API. + + Tableflow API keys are not tied to a specific cluster. + + + The API allows you to list, create, update and delete your API + Keys. + + + + Related guide: [API Keys in Confluent + Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + + ## The API Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `apikeys_per_org` | API Keys in one Confluent Cloud + organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKeyList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `ApiKey` objects represent access to different parts of + Confluent Cloud. Some types + + of API keys represent access to a single + cluster/resource such as a Kafka cluster, + + Schema Registry cluster or a ksqlDB cluster. Cloud API + Keys represent access to resources within an + organization + + that are not tied to a specific cluster, such as the Org + API, IAM API, Metrics API or Connect API. + + Tableflow API keys are not tied to a specific cluster. + + + The API allows you to list, create, update and delete + your API Keys. + + + + Related guide: [API Keys in Confluent + Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + + ## The API Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `apikeys_per_org` | API Keys in one Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - ApiKey + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/iam.v2.ApiKeySpec' + required: + - id + - metadata + - spec + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2ApiKey + summary: Create an API Key + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create an API key. + tags: + - API Keys (iam/v2) + security: + - cloud-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `ApiKey` objects represent access to different parts of + Confluent Cloud. Some types + + of API keys represent access to a single cluster/resource such + as a Kafka cluster, + + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys + represent access to resources within an organization + + that are not tied to a specific cluster, such as the Org API, + IAM API, Metrics API or Connect API. + + Tableflow API keys are not tied to a specific cluster. + + + The API allows you to list, create, update and delete your API + Keys. + + + + Related guide: [API Keys in Confluent + Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + + ## The API Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `apikeys_per_org` | API Keys in one Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKey + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/iam.v2.ApiKeySpec' + required: + - spec + responses: + '202': + description: An API Key is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/api-keys/{id} + description: ApiKey resource uri + content: + application/json: + schema: + type: object + description: >- + `ApiKey` objects represent access to different parts of + Confluent Cloud. Some types + + of API keys represent access to a single cluster/resource such + as a Kafka cluster, + + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys + represent access to resources within an organization + + that are not tied to a specific cluster, such as the Org API, + IAM API, Metrics API or Connect API. + + Tableflow API keys are not tied to a specific cluster. + + + The API allows you to list, create, update and delete your API + Keys. + + + + Related guide: [API Keys in Confluent + Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + + ## The API Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `apikeys_per_org` | API Keys in one Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKey + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/iam.v2.ApiKeySpec' + required: + - spec + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/api-keys/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2ApiKey + summary: Read an API Key + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read an API key. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the API key. + tags: + - API Keys (iam/v2) + security: + - cloud-api-key: [] + responses: + '200': + description: API Key. + content: + application/json: + schema: + type: object + description: >- + `ApiKey` objects represent access to different parts of + Confluent Cloud. Some types + + of API keys represent access to a single cluster/resource such + as a Kafka cluster, + + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys + represent access to resources within an organization + + that are not tied to a specific cluster, such as the Org API, + IAM API, Metrics API or Connect API. + + Tableflow API keys are not tied to a specific cluster. + + + The API allows you to list, create, update and delete your API + Keys. + + + + Related guide: [API Keys in Confluent + Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + + ## The API Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `apikeys_per_org` | API Keys in one Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKey + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/iam.v2.ApiKeySpec' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2ApiKey + summary: Update an API Key + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update an API key. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the API key. + tags: + - API Keys (iam/v2) + security: + - cloud-api-key: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.ApiKey' + responses: + '200': + description: API Key. + content: + application/json: + schema: + type: object + description: >- + `ApiKey` objects represent access to different parts of + Confluent Cloud. Some types + + of API keys represent access to a single cluster/resource such + as a Kafka cluster, + + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys + represent access to resources within an organization + + that are not tied to a specific cluster, such as the Org API, + IAM API, Metrics API or Connect API. + + Tableflow API keys are not tied to a specific cluster. + + + The API allows you to list, create, update and delete your API + Keys. + + + + Related guide: [API Keys in Confluent + Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + + ## The API Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `apikeys_per_org` | API Keys in one Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKey + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/iam.v2.ApiKeySpec' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2ApiKey + summary: Delete an API Key + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete an API key. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the API key. + tags: + - API Keys (iam/v2) + security: + - cloud-api-key: [] + responses: + '204': + description: An API Key is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/users: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2Users + summary: List of Users + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all users. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Users (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: User. + content: + application/json: + schema: + type: object + description: >- + `User` objects represent individuals who may access your + Confluent resources. + + + The API allows you to retrieve, update, and delete individual + users, as well as list of all your + + users. This API cannot be used to create new user accounts. + + + + Related guide: [Users in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + + ## The Users Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `users_per_org` | Users in one Confluent Cloud organization + | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - UserList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `User` objects represent individuals who may access your + Confluent resources. + + + The API allows you to retrieve, update, and delete + individual users, as well as list of all your + + users. This API cannot be used to create new user + accounts. + + + + Related guide: [Users in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + + ## The Users Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `users_per_org` | Users in one Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - User + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: marty.mcfly@example.com + description: The user's email address + x-immutable: true + full_name: + example: Marty McFly + type: string + description: The user's full name + auth_type: + type: string + description: The user's authentication method + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + readOnly: true + required: + - id + - metadata + - email + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/users/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2User + summary: Read a User + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a user. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the user. + tags: + - Users (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: User. + content: + application/json: + schema: + type: object + description: >- + `User` objects represent individuals who may access your + Confluent resources. + + + The API allows you to retrieve, update, and delete individual + users, as well as list of all your + + users. This API cannot be used to create new user accounts. + + + + Related guide: [Users in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + + ## The Users Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `users_per_org` | Users in one Confluent Cloud organization + | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - User + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: marty.mcfly@example.com + description: The user's email address + x-immutable: true + full_name: + example: Marty McFly + type: string + description: The user's full name + auth_type: + type: string + description: The user's authentication method + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + readOnly: true + required: + - api_version + - kind + - id + - email + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2User + summary: Update a User + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a user. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the user. + tags: + - Users (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.User' + responses: + '200': + description: User. + content: + application/json: + schema: + type: object + description: >- + `User` objects represent individuals who may access your + Confluent resources. + + + The API allows you to retrieve, update, and delete individual + users, as well as list of all your + + users. This API cannot be used to create new user accounts. + + + + Related guide: [Users in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + + ## The Users Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `users_per_org` | Users in one Confluent Cloud organization + | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - User + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: marty.mcfly@example.com + description: The user's email address + x-immutable: true + full_name: + example: Marty McFly + type: string + description: The user's full name + auth_type: + type: string + description: The user's authentication method + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + readOnly: true + required: + - api_version + - kind + - id + - email + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2User + summary: Delete a User + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a user. + + + If successful, this request will also recursively delete all of the + user's associated resources, + + including its cloud and cluster API keys. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the user. + tags: + - Users (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A User is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/users/{id}/auth: + patch: + summary: Update Auth Type of a User + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Update the auth type of a user + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.User.ConfigureUserAuthRequest' + x-lifecycle-stage: General Availability + x-self-access: true + x-name: iam.v2.User + operationId: update_auth_typeIamV2User + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the user. + tags: + - Users (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/service-accounts: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2ServiceAccounts + summary: List of Service Accounts + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all service accounts. + parameters: + - name: display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - tf_runner_sa + - mySA + description: >- + Filter the results by exact match for display_name. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Service Accounts (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Service Account. + content: + application/json: + schema: + type: object + description: >- + `ServiceAccount` objects are typically used to represent + applications and other non-human principals + + that may access your Confluent resources. + + + The API allows you to create, retrieve, update, and delete + individual service accounts, as well as + + list all your service accounts. + + + + Related guide: [Service Accounts in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + + ## The Service Accounts Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `service_accounts_per_org` | Service Accounts in one + Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccountList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `ServiceAccount` objects are typically used to represent + applications and other non-human principals + + that may access your Confluent resources. + + + The API allows you to create, retrieve, update, and + delete individual service accounts, as well as + + list all your service accounts. + + + + Related guide: [Service Accounts in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + + ## The Service Accounts Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `service_accounts_per_org` | Service Accounts in one + Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - ServiceAccount + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: DeLorean_auto_repair + description: A human-readable name for the Service Account + description: + type: string + example: Doc's repair bot for the DeLorean + description: A free-form description of the Service Account + required: + - id + - metadata + - display_name + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2ServiceAccount + summary: Create a Service Account + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a service account. + parameters: + - name: assigned_resource_owner + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: u-a83k9b + description: >- + The resource_id of the principal who will be assigned resource owner + on the created service account. Principal can be group-mapping + (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool + (pool-xxx). + tags: + - Service Accounts (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `ServiceAccount` objects are typically used to represent + applications and other non-human principals + + that may access your Confluent resources. + + + The API allows you to create, retrieve, update, and delete + individual service accounts, as well as + + list all your service accounts. + + + + Related guide: [Service Accounts in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + + ## The Service Accounts Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `service_accounts_per_org` | Service Accounts in one Confluent + Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccount + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + example: DeLorean_auto_repair + description: A human-readable name for the Service Account + description: + type: string + example: Doc's repair bot for the DeLorean + description: A free-form description of the Service Account + required: + - display_name + responses: + '201': + description: A Service Account was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/service-accounts/{id} + description: ServiceAccount resource uri + content: + application/json: + schema: + type: object + description: >- + `ServiceAccount` objects are typically used to represent + applications and other non-human principals + + that may access your Confluent resources. + + + The API allows you to create, retrieve, update, and delete + individual service accounts, as well as + + list all your service accounts. + + + + Related guide: [Service Accounts in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + + ## The Service Accounts Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `service_accounts_per_org` | Service Accounts in one + Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccount + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + example: DeLorean_auto_repair + description: A human-readable name for the Service Account + description: + type: string + example: Doc's repair bot for the DeLorean + description: A free-form description of the Service Account + required: + - display_name + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/service-accounts/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2ServiceAccount + summary: Read a Service Account + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a service account. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the service account. + tags: + - Service Accounts (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Service Account. + content: + application/json: + schema: + type: object + description: >- + `ServiceAccount` objects are typically used to represent + applications and other non-human principals + + that may access your Confluent resources. + + + The API allows you to create, retrieve, update, and delete + individual service accounts, as well as + + list all your service accounts. + + + + Related guide: [Service Accounts in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + + ## The Service Accounts Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `service_accounts_per_org` | Service Accounts in one + Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccount + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + example: DeLorean_auto_repair + description: A human-readable name for the Service Account + description: + type: string + example: Doc's repair bot for the DeLorean + description: A free-form description of the Service Account + required: + - api_version + - kind + - id + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2ServiceAccount + summary: Update a Service Account + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a service account. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the service account. + tags: + - Service Accounts (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.ServiceAccount' + responses: + '200': + description: Service Account. + content: + application/json: + schema: + type: object + description: >- + `ServiceAccount` objects are typically used to represent + applications and other non-human principals + + that may access your Confluent resources. + + + The API allows you to create, retrieve, update, and delete + individual service accounts, as well as + + list all your service accounts. + + + + Related guide: [Service Accounts in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + + ## The Service Accounts Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `service_accounts_per_org` | Service Accounts in one + Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccount + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + example: DeLorean_auto_repair + description: A human-readable name for the Service Account + description: + type: string + example: Doc's repair bot for the DeLorean + description: A free-form description of the Service Account + required: + - api_version + - kind + - id + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2ServiceAccount + summary: Delete a Service Account + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a service account. + + + If successful, this request will also recursively delete all of the + service account's associated resources, + + including its cloud and cluster API keys. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the service account. + tags: + - Service Accounts (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Service Account is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/invitations: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2Invitations + summary: List of Invitations + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all invitations. + parameters: + - name: email + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: johndoe@confluent.io + description: Filter the results by exact match for email. + - name: status + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: INVITE_STATUS_SENT + description: Filter the results by exact match for status. + - name: user + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: u-j93dy8 + description: Filter the results by exact match for user. + - name: creator + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: u-m2r9o7 + description: Filter the results by exact match for creator. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Invitations (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Invitation. + content: + application/json: + schema: + type: object + description: >- + `Invitation` objects represent invitations to invite users to + join your organizations in Confluent Cloud. + + + The API allows you to list all your invitations, as well as + create, read, and delete a specified invitation. + + + + Related guide: [User invitations in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + + ## The Invitations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `invitations_per_org` | Invitations in a Confluent Cloud + organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - InvitationList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Invitation` objects represent invitations to invite + users to join your organizations in Confluent Cloud. + + + The API allows you to list all your invitations, as well + as create, read, and delete a specified invitation. + + + + Related guide: [User invitations in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + + ## The Invitations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `invitations_per_org` | Invitations in a Confluent + Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Invitation + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: johndoe@confluent.io + description: The user/invitee's email address + x-immutable: true + auth_type: + type: string + description: > + The user/invitee's authentication type. Note that + only the [OrganizationAdmin + role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) + + can invite AUTH_TYPE_LOCAL users to SSO + organizations. + + The user's auth_type is set as AUTH_TYPE_SSO by + default if the organization has SSO enabled. + + Otherwise, the user's auth_type is AUTH_TYPE_LOCAL + by default. + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + status: + type: string + example: INVITE_STATUS_SENT + description: The status of invitations + x-extensible-enum: + - INVITE_STATUS_SENT + - INVITE_STATUS_STAGED + - INVITE_STATUS_ACCEPTED + - INVITE_STATUS_EXPIRED + - INVITE_STATUS_DEACTIVATED + readOnly: true + accepted_at: + type: string + format: date-time + example: '2022-07-06T17:21:33.000Z' + description: The timestamp that the invitation was accepted + nullable: true + readOnly: true + expires_at: + type: string + format: date-time + example: '2022-07-07T17:22:39.000Z' + description: The timestamp that the invitation will expire + readOnly: true + user: + description: The user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + creator: + description: The invitation creator + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - email + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2Invitation + summary: Create an Invitation + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create an invitation. + + + The newly invited user will not have any permissions. Give the user + permission by assigning them to one or + + more roles by creating + + [role + bindings](https://docs.confluent.io/cloud/current/api.html#tag/Role-Bindings-(iamv2)) + + for the created `user`. + tags: + - Invitations (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Invitation` objects represent invitations to invite users to + join your organizations in Confluent Cloud. + + + The API allows you to list all your invitations, as well as + create, read, and delete a specified invitation. + + + + Related guide: [User invitations in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + + ## The Invitations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `invitations_per_org` | Invitations in a Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Invitation + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + email: + type: string + format: email + example: johndoe@confluent.io + description: The user/invitee's email address + x-immutable: true + auth_type: + type: string + description: > + The user/invitee's authentication type. Note that only the + [OrganizationAdmin + role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) + + can invite AUTH_TYPE_LOCAL users to SSO organizations. + + The user's auth_type is set as AUTH_TYPE_SSO by default if + the organization has SSO enabled. + + Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by + default. + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + status: + type: string + example: INVITE_STATUS_SENT + description: The status of invitations + x-extensible-enum: + - INVITE_STATUS_SENT + - INVITE_STATUS_STAGED + - INVITE_STATUS_ACCEPTED + - INVITE_STATUS_EXPIRED + - INVITE_STATUS_DEACTIVATED + readOnly: true + accepted_at: + type: string + format: date-time + example: '2022-07-06T17:21:33.000Z' + description: The timestamp that the invitation was accepted + nullable: true + readOnly: true + expires_at: + type: string + format: date-time + example: '2022-07-07T17:22:39.000Z' + description: The timestamp that the invitation will expire + readOnly: true + user: + description: The user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + creator: + description: The invitation creator + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - email + responses: + '201': + description: An Invitation was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/invitations/{id} + description: Invitation resource uri + content: + application/json: + schema: + type: object + description: >- + `Invitation` objects represent invitations to invite users to + join your organizations in Confluent Cloud. + + + The API allows you to list all your invitations, as well as + create, read, and delete a specified invitation. + + + + Related guide: [User invitations in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + + ## The Invitations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `invitations_per_org` | Invitations in a Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Invitation + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: johndoe@confluent.io + description: The user/invitee's email address + x-immutable: true + auth_type: + type: string + description: > + The user/invitee's authentication type. Note that only the + [OrganizationAdmin + role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) + + can invite AUTH_TYPE_LOCAL users to SSO organizations. + + The user's auth_type is set as AUTH_TYPE_SSO by default if + the organization has SSO enabled. + + Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by + default. + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + status: + type: string + example: INVITE_STATUS_SENT + description: The status of invitations + x-extensible-enum: + - INVITE_STATUS_SENT + - INVITE_STATUS_STAGED + - INVITE_STATUS_ACCEPTED + - INVITE_STATUS_EXPIRED + - INVITE_STATUS_DEACTIVATED + readOnly: true + accepted_at: + type: string + format: date-time + example: '2022-07-06T17:21:33.000Z' + description: The timestamp that the invitation was accepted + nullable: true + readOnly: true + expires_at: + type: string + format: date-time + example: '2022-07-07T17:22:39.000Z' + description: The timestamp that the invitation will expire + readOnly: true + user: + description: The user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + creator: + description: The invitation creator + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - email + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/invitations/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2Invitation + summary: Read an Invitation + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read an invitation. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the invitation. + tags: + - Invitations (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Invitation. + content: + application/json: + schema: + type: object + description: >- + `Invitation` objects represent invitations to invite users to + join your organizations in Confluent Cloud. + + + The API allows you to list all your invitations, as well as + create, read, and delete a specified invitation. + + + + Related guide: [User invitations in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + + ## The Invitations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `invitations_per_org` | Invitations in a Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Invitation + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: johndoe@confluent.io + description: The user/invitee's email address + x-immutable: true + auth_type: + type: string + description: > + The user/invitee's authentication type. Note that only the + [OrganizationAdmin + role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) + + can invite AUTH_TYPE_LOCAL users to SSO organizations. + + The user's auth_type is set as AUTH_TYPE_SSO by default if + the organization has SSO enabled. + + Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by + default. + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + status: + type: string + example: INVITE_STATUS_SENT + description: The status of invitations + x-extensible-enum: + - INVITE_STATUS_SENT + - INVITE_STATUS_STAGED + - INVITE_STATUS_ACCEPTED + - INVITE_STATUS_EXPIRED + - INVITE_STATUS_DEACTIVATED + readOnly: true + accepted_at: + type: string + format: date-time + example: '2022-07-06T17:21:33.000Z' + description: The timestamp that the invitation was accepted + nullable: true + readOnly: true + expires_at: + type: string + format: date-time + example: '2022-07-07T17:22:39.000Z' + description: The timestamp that the invitation will expire + readOnly: true + user: + description: The user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + creator: + description: The invitation creator + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - email + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2Invitation + summary: Delete an Invitation + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete an invitation. + + + Delete will deactivate the user if the user didn't accept the invitation + yet. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the invitation. + tags: + - Invitations (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Invitation is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/ip-groups: + get: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + operationId: listIamV2IpGroups + summary: List of IP Groups + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all IP groups. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 25 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - IP Groups (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: IP Group. + content: + application/json: + schema: + type: object + description: >- + Definitions of networks which can be named and referred by IP + blocks, commonly used to attach to IP Filter rules. + + + + ## The IP Groups Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroupList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + Definitions of networks which can be named and referred + by IP blocks, commonly used to attach to IP Filter + rules. + + + + ## The IP Groups Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - IpGroup + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + group_name: + type: string + minLength: 1 + maxLength: 64 + example: CorpNet + description: > + A human readable name for an IP Group. Can contain + any unicode letter or number, the ASCII space + character, or + + any of the following special characters: `[`, `]`, + `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + cidr_blocks: + type: array + items: + type: string + minItems: 1 + maxItems: 25 + example: + - 192.168.0.0/24 + - 192.168.7.0/24 + description: A list of CIDRs. + required: + - id + - metadata + - group_name + - cidr_blocks + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-page-first-available: true + x-page-last-available: true + x-page-from-start: true + x-page-from-end: true + post: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + operationId: createIamV2IpGroup + summary: Create an IP Group + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create an IP group. + tags: + - IP Groups (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + Definitions of networks which can be named and referred by IP + blocks, commonly used to attach to IP Filter rules. + + + + ## The IP Groups Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroup + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + group_name: + type: string + minLength: 1 + maxLength: 64 + example: CorpNet + description: > + A human readable name for an IP Group. Can contain any + unicode letter or number, the ASCII space character, or + + any of the following special characters: `[`, `]`, `|`, `&`, + `+`, `-`, `_`, `/`, `.`, `,`. + cidr_blocks: + type: array + items: + type: string + minItems: 1 + maxItems: 25 + example: + - 192.168.0.0/24 + - 192.168.7.0/24 + description: A list of CIDRs. + required: + - group_name + - cidr_blocks + responses: + '201': + description: An IP Group was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/ip-groups/{id} + description: IpGroup resource uri + content: + application/json: + schema: + type: object + description: >- + Definitions of networks which can be named and referred by IP + blocks, commonly used to attach to IP Filter rules. + + + + ## The IP Groups Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroup + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + group_name: + type: string + minLength: 1 + maxLength: 64 + example: CorpNet + description: > + A human readable name for an IP Group. Can contain any + unicode letter or number, the ASCII space character, or + + any of the following special characters: `[`, `]`, `|`, + `&`, `+`, `-`, `_`, `/`, `.`, `,`. + cidr_blocks: + type: array + items: + type: string + minItems: 1 + maxItems: 25 + example: + - 192.168.0.0/24 + - 192.168.7.0/24 + description: A list of CIDRs. + required: + - group_name + - cidr_blocks + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + /iam/v2/ip-groups/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + operationId: getIamV2IpGroup + summary: Read an IP Group + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read an IP group. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP group. + tags: + - IP Groups (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: IP Group. + content: + application/json: + schema: + type: object + description: >- + Definitions of networks which can be named and referred by IP + blocks, commonly used to attach to IP Filter rules. + + + + ## The IP Groups Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroup + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + group_name: + type: string + minLength: 1 + maxLength: 64 + example: CorpNet + description: > + A human readable name for an IP Group. Can contain any + unicode letter or number, the ASCII space character, or + + any of the following special characters: `[`, `]`, `|`, + `&`, `+`, `-`, `_`, `/`, `.`, `,`. + cidr_blocks: + type: array + items: + type: string + minItems: 1 + maxItems: 25 + example: + - 192.168.0.0/24 + - 192.168.7.0/24 + description: A list of CIDRs. + required: + - api_version + - kind + - id + - group_name + - cidr_blocks + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + operationId: updateIamV2IpGroup + summary: Update an IP Group + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update an IP group. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP group. + tags: + - IP Groups (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.IpGroup' + responses: + '200': + description: IP Group. + content: + application/json: + schema: + type: object + description: >- + Definitions of networks which can be named and referred by IP + blocks, commonly used to attach to IP Filter rules. + + + + ## The IP Groups Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroup + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + group_name: + type: string + minLength: 1 + maxLength: 64 + example: CorpNet + description: > + A human readable name for an IP Group. Can contain any + unicode letter or number, the ASCII space character, or + + any of the following special characters: `[`, `]`, `|`, + `&`, `+`, `-`, `_`, `/`, `.`, `,`. + cidr_blocks: + type: array + items: + type: string + minItems: 1 + maxItems: 25 + example: + - 192.168.0.0/24 + - 192.168.7.0/24 + description: A list of CIDRs. + required: + - api_version + - kind + - id + - group_name + - cidr_blocks + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + operationId: deleteIamV2IpGroup + summary: Delete an IP Group + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete an IP group. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP group. + tags: + - IP Groups (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An IP Group is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + /iam/v2/ip-filters: + get: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + operationId: listIamV2IpFilters + summary: List of IP Filters + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all IP filters. + parameters: + - name: resource_scope + in: query + required: false + schema: + type: string + description: Lists all filters belonging to the specified resource scope. + - name: include_parent_scopes + in: query + required: false + schema: + type: string + description: >- + If set to true, this includes filters defined at the organization + level. The resource scope must also be set to use this parameter. + - name: page_size + in: query + required: false + schema: + type: integer + default: 25 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - IP Filters (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: IP Filter. + content: + application/json: + schema: + type: object + description: >- + `IP Filter` objects are bindings between IP Groups and + Confluent resource(s). + + For example, a binding between "CorpNet" and "Management APIs" + will enforce that + + access must come from one of the CIDR blocks associated with + CorpNet. + + If there are multiple IP filters bound to a resource, a + request matching any of the CIDR blocks + + for any of the IP Group will allow the request. + + If there are no IP Filters for a resource, then access will be + granted to requests originating + + from any IP Address. + + + + ## The IP Filters Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilterList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `IP Filter` objects are bindings between IP Groups and + Confluent resource(s). + + For example, a binding between "CorpNet" and "Management + APIs" will enforce that + + access must come from one of the CIDR blocks associated + with CorpNet. + + If there are multiple IP filters bound to a resource, a + request matching any of the CIDR blocks + + for any of the IP Group will allow the request. + + If there are no IP Filters for a resource, then access + will be granted to requests originating + + from any IP Address. + + + + ## The IP Filters Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - IpFilter + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + filter_name: + type: string + minLength: 1 + maxLength: 64 + example: Management API Rules + description: > + A human readable name for an IP Filter. Can contain + any unicode letter or number, the ASCII space + character, + + or any of the following special characters: `[`, + `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + resource_group: + type: string + example: management + description: > + Scope of resources covered by this IP filter. + Available resource groups include "management" and + "multiple". + resource_scope: + type: string + example: >- + crn://confluent.cloud/organization=org-123/environment=env-abc + format: uri + pattern: ^crn://.+$ + description: > + A CRN that specifies the scope of the ip filter, + specifically the organization + + or environment. Without specifying this property, + the ip filter + + would apply to the whole organization. + operation_groups: + type: array + items: + type: string + example: + - MANAGEMENT + - SCHEMA + - FLINK + description: > + Scope of resources covered by this IP filter. + Resource group must be set to 'multiple' + + in order to use this property.During update + operations, note that the operation + + groups passed in will replace the list of existing + operation groups + + (passing in an empty list will remove all operation + groups) from the filter + + (in line with the behavior for ip_groups). + ip_groups: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: A list of IP Groups. + minItems: 1 + maxItems: 25 + required: + - id + - metadata + - filter_name + - resource_group + - ip_groups + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-page-first-available: true + x-page-last-available: true + x-page-from-start: true + x-page-from-end: true + post: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + operationId: createIamV2IpFilter + summary: Create an IP Filter + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create an IP filter. + tags: + - IP Filters (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `IP Filter` objects are bindings between IP Groups and Confluent + resource(s). + + For example, a binding between "CorpNet" and "Management APIs" + will enforce that + + access must come from one of the CIDR blocks associated with + CorpNet. + + If there are multiple IP filters bound to a resource, a request + matching any of the CIDR blocks + + for any of the IP Group will allow the request. + + If there are no IP Filters for a resource, then access will be + granted to requests originating + + from any IP Address. + + + + ## The IP Filters Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilter + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + filter_name: + type: string + minLength: 1 + maxLength: 64 + example: Management API Rules + description: > + A human readable name for an IP Filter. Can contain any + unicode letter or number, the ASCII space character, + + or any of the following special characters: `[`, `]`, `|`, + `&`, `+`, `-`, `_`, `/`, `.`, `,`. + resource_group: + type: string + example: management + description: > + Scope of resources covered by this IP filter. Available + resource groups include "management" and "multiple". + resource_scope: + type: string + example: >- + crn://confluent.cloud/organization=org-123/environment=env-abc + format: uri + pattern: ^crn://.+$ + description: > + A CRN that specifies the scope of the ip filter, + specifically the organization + + or environment. Without specifying this property, the ip + filter + + would apply to the whole organization. + operation_groups: + type: array + items: + type: string + example: + - MANAGEMENT + - SCHEMA + - FLINK + description: > + Scope of resources covered by this IP filter. Resource group + must be set to 'multiple' + + in order to use this property.During update operations, note + that the operation + + groups passed in will replace the list of existing operation + groups + + (passing in an empty list will remove all operation groups) + from the filter + + (in line with the behavior for ip_groups). + ip_groups: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: A list of IP Groups. + minItems: 1 + maxItems: 25 + required: + - filter_name + - resource_group + - ip_groups + responses: + '201': + description: An IP Filter was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/ip-filters/{id} + description: IpFilter resource uri + content: + application/json: + schema: + type: object + description: >- + `IP Filter` objects are bindings between IP Groups and + Confluent resource(s). + + For example, a binding between "CorpNet" and "Management APIs" + will enforce that + + access must come from one of the CIDR blocks associated with + CorpNet. + + If there are multiple IP filters bound to a resource, a + request matching any of the CIDR blocks + + for any of the IP Group will allow the request. + + If there are no IP Filters for a resource, then access will be + granted to requests originating + + from any IP Address. + + + + ## The IP Filters Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilter + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + filter_name: + type: string + minLength: 1 + maxLength: 64 + example: Management API Rules + description: > + A human readable name for an IP Filter. Can contain any + unicode letter or number, the ASCII space character, + + or any of the following special characters: `[`, `]`, `|`, + `&`, `+`, `-`, `_`, `/`, `.`, `,`. + resource_group: + type: string + example: management + description: > + Scope of resources covered by this IP filter. Available + resource groups include "management" and "multiple". + resource_scope: + type: string + example: >- + crn://confluent.cloud/organization=org-123/environment=env-abc + format: uri + pattern: ^crn://.+$ + description: > + A CRN that specifies the scope of the ip filter, + specifically the organization + + or environment. Without specifying this property, the ip + filter + + would apply to the whole organization. + operation_groups: + type: array + items: + type: string + example: + - MANAGEMENT + - SCHEMA + - FLINK + description: > + Scope of resources covered by this IP filter. Resource + group must be set to 'multiple' + + in order to use this property.During update operations, + note that the operation + + groups passed in will replace the list of existing + operation groups + + (passing in an empty list will remove all operation + groups) from the filter + + (in line with the behavior for ip_groups). + ip_groups: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: A list of IP Groups. + minItems: 1 + maxItems: 25 + required: + - filter_name + - resource_group + - ip_groups + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + /iam/v2/ip-filters/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + operationId: getIamV2IpFilter + summary: Read an IP Filter + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read an IP filter. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP filter. + tags: + - IP Filters (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: IP Filter. + content: + application/json: + schema: + type: object + description: >- + `IP Filter` objects are bindings between IP Groups and + Confluent resource(s). + + For example, a binding between "CorpNet" and "Management APIs" + will enforce that + + access must come from one of the CIDR blocks associated with + CorpNet. + + If there are multiple IP filters bound to a resource, a + request matching any of the CIDR blocks + + for any of the IP Group will allow the request. + + If there are no IP Filters for a resource, then access will be + granted to requests originating + + from any IP Address. + + + + ## The IP Filters Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilter + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + filter_name: + type: string + minLength: 1 + maxLength: 64 + example: Management API Rules + description: > + A human readable name for an IP Filter. Can contain any + unicode letter or number, the ASCII space character, + + or any of the following special characters: `[`, `]`, `|`, + `&`, `+`, `-`, `_`, `/`, `.`, `,`. + resource_group: + type: string + example: management + description: > + Scope of resources covered by this IP filter. Available + resource groups include "management" and "multiple". + resource_scope: + type: string + example: >- + crn://confluent.cloud/organization=org-123/environment=env-abc + format: uri + pattern: ^crn://.+$ + description: > + A CRN that specifies the scope of the ip filter, + specifically the organization + + or environment. Without specifying this property, the ip + filter + + would apply to the whole organization. + operation_groups: + type: array + items: + type: string + example: + - MANAGEMENT + - SCHEMA + - FLINK + description: > + Scope of resources covered by this IP filter. Resource + group must be set to 'multiple' + + in order to use this property.During update operations, + note that the operation + + groups passed in will replace the list of existing + operation groups + + (passing in an empty list will remove all operation + groups) from the filter + + (in line with the behavior for ip_groups). + ip_groups: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: A list of IP Groups. + minItems: 1 + maxItems: 25 + required: + - api_version + - kind + - id + - filter_name + - resource_group + - ip_groups + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + operationId: updateIamV2IpFilter + summary: Update an IP Filter + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update an IP filter. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP filter. + tags: + - IP Filters (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.IpFilter' + responses: + '200': + description: IP Filter. + content: + application/json: + schema: + type: object + description: >- + `IP Filter` objects are bindings between IP Groups and + Confluent resource(s). + + For example, a binding between "CorpNet" and "Management APIs" + will enforce that + + access must come from one of the CIDR blocks associated with + CorpNet. + + If there are multiple IP filters bound to a resource, a + request matching any of the CIDR blocks + + for any of the IP Group will allow the request. + + If there are no IP Filters for a resource, then access will be + granted to requests originating + + from any IP Address. + + + + ## The IP Filters Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilter + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + filter_name: + type: string + minLength: 1 + maxLength: 64 + example: Management API Rules + description: > + A human readable name for an IP Filter. Can contain any + unicode letter or number, the ASCII space character, + + or any of the following special characters: `[`, `]`, `|`, + `&`, `+`, `-`, `_`, `/`, `.`, `,`. + resource_group: + type: string + example: management + description: > + Scope of resources covered by this IP filter. Available + resource groups include "management" and "multiple". + resource_scope: + type: string + example: >- + crn://confluent.cloud/organization=org-123/environment=env-abc + format: uri + pattern: ^crn://.+$ + description: > + A CRN that specifies the scope of the ip filter, + specifically the organization + + or environment. Without specifying this property, the ip + filter + + would apply to the whole organization. + operation_groups: + type: array + items: + type: string + example: + - MANAGEMENT + - SCHEMA + - FLINK + description: > + Scope of resources covered by this IP filter. Resource + group must be set to 'multiple' + + in order to use this property.During update operations, + note that the operation + + groups passed in will replace the list of existing + operation groups + + (passing in an empty list will remove all operation + groups) from the filter + + (in line with the behavior for ip_groups). + ip_groups: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: A list of IP Groups. + minItems: 1 + maxItems: 25 + required: + - api_version + - kind + - id + - filter_name + - resource_group + - ip_groups + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + operationId: deleteIamV2IpFilter + summary: Delete an IP Filter + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete an IP filter. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP filter. + tags: + - IP Filters (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An IP Filter is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + /iam/v2/ip-filter-summary: + get: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filter Summary API + operationId: getIamV2IpFilterSummary + summary: Read an IP Filter Summary + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read an IP filter summary. + parameters: + - name: scope + in: query + required: true + schema: + type: string + example: crn://confluent.cloud/organization=org-123/environment=env-abc + description: Scope the operation to the given scope. + tags: + - IP Filter Summaries (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: IP Filter Summary. + content: + application/json: + schema: + type: object + description: > + The IP Filter Summary endpoint returns an aggregation of the + IP Filters across the system. + + This API can be queried in the context of an organization or + an environment. It returns a + + summary of every operation group in the system grouped with a + higher summary by operation + + group category. + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilterSummary + scope: + type: string + description: The scope associated with this object. + categories: + type: array + items: + type: object + properties: + name: + type: string + description: Name of the category. + status: + type: string + description: Open, limited, or mixed. + operation_groups: + type: array + description: Operation groups part of this category. + items: + type: object + properties: + name: + type: string + description: Name of the operation group. + status: + type: string + description: Open, limited, or no access. + example: + - name: management + status: MIXED + operation_groups: + - name: MANAGEMENT + status: LIMITED + description: > + Summary of the operation groups and IP filters created in + those operation groups. + required: + - api_version + - kind + - categories + - scope + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filter Summary API + /iam/v2/role-bindings: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2RoleBindings + summary: List of Role Bindings + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all role bindings. + parameters: + - name: principal + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: User:u-111aaa + description: Filter the results by exact match for principal. + - name: role_name + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: CloudClusterAdmin + description: Filter the results by exact match for role_name. + - name: crn_pattern + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: >- + crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + description: Filter the results by a partial search of crn_pattern. + - name: page_size + in: query + required: false + schema: + type: integer + default: 1000 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Role Bindings (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Role Binding. + content: + application/json: + schema: + type: object + description: >- + A role binding grants a Principal a role on resources that + match a pattern. + + + The API allows you to perform create, delete, and list + operations on role bindings. + + + + Related guide: [Role-Based Access Control + (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + + ## The Role Bindings Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBindingList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + A role binding grants a Principal a role on resources + that match a pattern. + + + The API allows you to perform create, delete, and list + operations on role bindings. + + + + Related guide: [Role-Based Access Control + (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + + ## The Role Bindings Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - RoleBinding + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + principal: + type: string + description: The principal User to bind the role to + pattern: (^User:.+$) + example: User:u-111aaa + role_name: + type: string + description: The name of the role to bind to the principal + example: CloudClusterAdmin + crn_pattern: + type: string + description: >- + A CRN that specifies the scope and resource patterns + necessary for the role to bind + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + required: + - id + - metadata + - principal + - role_name + - crn_pattern + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2RoleBinding + summary: Create a Role Binding + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a role binding. + tags: + - Role Bindings (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + A role binding grants a Principal a role on resources that match + a pattern. + + + The API allows you to perform create, delete, and list + operations on role bindings. + + + + Related guide: [Role-Based Access Control + (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + + ## The Role Bindings Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBinding + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + principal: + type: string + description: The principal User to bind the role to + pattern: (^User:.+$) + example: User:u-111aaa + role_name: + type: string + description: The name of the role to bind to the principal + example: CloudClusterAdmin + crn_pattern: + type: string + description: >- + A CRN that specifies the scope and resource patterns + necessary for the role to bind + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + required: + - principal + - role_name + - crn_pattern + responses: + '201': + description: A Role Binding was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/role-bindings/{id} + description: RoleBinding resource uri + content: + application/json: + schema: + type: object + description: >- + A role binding grants a Principal a role on resources that + match a pattern. + + + The API allows you to perform create, delete, and list + operations on role bindings. + + + + Related guide: [Role-Based Access Control + (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + + ## The Role Bindings Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBinding + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + principal: + type: string + description: The principal User to bind the role to + pattern: (^User:.+$) + example: User:u-111aaa + role_name: + type: string + description: The name of the role to bind to the principal + example: CloudClusterAdmin + crn_pattern: + type: string + description: >- + A CRN that specifies the scope and resource patterns + necessary for the role to bind + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + required: + - principal + - role_name + - crn_pattern + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/role-bindings/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2RoleBinding + summary: Read a Role Binding + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a role binding. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the role binding. + tags: + - Role Bindings (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Role Binding. + content: + application/json: + schema: + type: object + description: >- + A role binding grants a Principal a role on resources that + match a pattern. + + + The API allows you to perform create, delete, and list + operations on role bindings. + + + + Related guide: [Role-Based Access Control + (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + + ## The Role Bindings Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBinding + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + principal: + type: string + description: The principal User to bind the role to + pattern: (^User:.+$) + example: User:u-111aaa + role_name: + type: string + description: The name of the role to bind to the principal + example: CloudClusterAdmin + crn_pattern: + type: string + description: >- + A CRN that specifies the scope and resource patterns + necessary for the role to bind + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + required: + - api_version + - kind + - id + - principal + - role_name + - crn_pattern + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2RoleBinding + summary: Delete a Role Binding + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a role binding. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the role binding. + tags: + - Role Bindings (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: A Role Binding is being deleted. + content: + application/json: + schema: + type: object + description: >- + A role binding grants a Principal a role on resources that + match a pattern. + + + The API allows you to perform create, delete, and list + operations on role bindings. + + + + Related guide: [Role-Based Access Control + (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + + ## The Role Bindings Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBinding + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + principal: + type: string + description: The principal User to bind the role to + pattern: (^User:.+$) + example: User:u-111aaa + role_name: + type: string + description: The name of the role to bind to the principal + example: CloudClusterAdmin + crn_pattern: + type: string + description: >- + A CRN that specifies the scope and resource patterns + necessary for the role to bind + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + required: + - api_version + - kind + - id + - principal + - role_name + - crn_pattern + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/identity-providers: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2IdentityProviders + summary: List of Identity Providers + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all identity providers. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 255 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Identity Providers (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Identity Provider. + content: + application/json: + schema: + type: object + description: >- + `IdentityProvider` objects represent external OAuth-OIDC + providers in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your Identity Provider. + + + + Related guide: [OAuth for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + + ## The Identity Providers Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_providers_per_org` | Number of OAuth identity + providers per organization | + + | `public_keys_per_provider` | Number of public keys saved per + identity provider | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProviderList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `IdentityProvider` objects represent external OAuth-OIDC + providers in Confluent Cloud. + + + The API allows you to list, create, read, update, and + delete your Identity Provider. + + + + Related guide: [OAuth for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + + ## The Identity Providers Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_providers_per_org` | Number of OAuth + identity providers per organization | + + | `public_keys_per_provider` | Number of public keys + saved per identity provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - IdentityProvider + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: >- + The human-readable name of the OAuth identity + provider. + example: My OIDC Provider + description: + type: string + description: A description of the identity provider. + identity_claim: + type: string + description: >- + The JSON Web Token (JWT) claim to extract the + authenticating identity to Confluent resources from + + [Registered Claim + Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). + This appears + + in audit log records. Note: if the client specifies + mapping to one identity pool ID, the identity + + claim configured with that pool will be used + instead. + + Note - The attribute is in an [Early Access + lifecycle stage] + + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: claims.sub + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity provider. + example: ENABLED + readOnly: true + issuer: + type: string + format: uri + description: >- + A publicly accessible URL uniquely identifying the + OAuth + + identity provider authorized to issue access tokens. + example: https://login.microsoftonline.com/{tenantid}/v2.0 + x-immutable: false + jwks_uri: + type: string + format: uri + description: >- + A publicly accessible JSON Web Key Set (JWKS) URI + for the OAuth + + identity provider. JWKS provides a set of + crypotgraphic keys + + used to verify the authenticity and integrity of + JSON Web + + Tokens (JWTs) issued by the OAuth identity provider. + example: >- + https://login.microsoftonline.com/common/discovery/v2.0/keys + x-immutable: false + keys: + type: array + items: + $ref: '#/components/schemas/iam.v2.JwksObject' + description: >- + The JWKS issued by the OAuth identity provider. Only + `kid` (key ID) + + and `alg` (algorithm) properties for each key set + are included. + readOnly: true + required: + - id + - metadata + - display_name + - description + - state + - issuer + - jwks_uri + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2IdentityProvider + summary: Create an Identity Provider + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create an identity provider. + tags: + - Identity Providers (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `IdentityProvider` objects represent external OAuth-OIDC + providers in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your Identity Provider. + + + + Related guide: [OAuth for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + + ## The Identity Providers Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_providers_per_org` | Number of OAuth identity + providers per organization | + + | `public_keys_per_provider` | Number of public keys saved per + identity provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProvider + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the OAuth identity provider. + example: My OIDC Provider + description: + type: string + description: A description of the identity provider. + identity_claim: + type: string + description: >- + The JSON Web Token (JWT) claim to extract the authenticating + identity to Confluent resources from + + [Registered Claim + Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). + This appears + + in audit log records. Note: if the client specifies mapping + to one identity pool ID, the identity + + claim configured with that pool will be used instead. + + Note - The attribute is in an [Early Access lifecycle stage] + + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: claims.sub + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity provider. + example: ENABLED + readOnly: true + issuer: + type: string + format: uri + description: |- + A publicly accessible URL uniquely identifying the OAuth + identity provider authorized to issue access tokens. + example: https://login.microsoftonline.com/{tenantid}/v2.0 + x-immutable: false + jwks_uri: + type: string + format: uri + description: >- + A publicly accessible JSON Web Key Set (JWKS) URI for the + OAuth + + identity provider. JWKS provides a set of crypotgraphic keys + + used to verify the authenticity and integrity of JSON Web + + Tokens (JWTs) issued by the OAuth identity provider. + example: https://login.microsoftonline.com/common/discovery/v2.0/keys + x-immutable: false + keys: + type: array + items: + $ref: '#/components/schemas/iam.v2.JwksObject' + description: >- + The JWKS issued by the OAuth identity provider. Only `kid` + (key ID) + + and `alg` (algorithm) properties for each key set are + included. + readOnly: true + required: + - display_name + - description + - issuer + - jwks_uri + responses: + '201': + description: An Identity Provider was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/identity-providers/{id} + description: IdentityProvider resource uri + content: + application/json: + schema: + type: object + description: >- + `IdentityProvider` objects represent external OAuth-OIDC + providers in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your Identity Provider. + + + + Related guide: [OAuth for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + + ## The Identity Providers Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_providers_per_org` | Number of OAuth identity + providers per organization | + + | `public_keys_per_provider` | Number of public keys saved per + identity provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProvider + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the OAuth identity provider. + example: My OIDC Provider + description: + type: string + description: A description of the identity provider. + identity_claim: + type: string + description: >- + The JSON Web Token (JWT) claim to extract the + authenticating identity to Confluent resources from + + [Registered Claim + Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). + This appears + + in audit log records. Note: if the client specifies + mapping to one identity pool ID, the identity + + claim configured with that pool will be used instead. + + Note - The attribute is in an [Early Access lifecycle + stage] + + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: claims.sub + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity provider. + example: ENABLED + readOnly: true + issuer: + type: string + format: uri + description: |- + A publicly accessible URL uniquely identifying the OAuth + identity provider authorized to issue access tokens. + example: https://login.microsoftonline.com/{tenantid}/v2.0 + x-immutable: false + jwks_uri: + type: string + format: uri + description: >- + A publicly accessible JSON Web Key Set (JWKS) URI for the + OAuth + + identity provider. JWKS provides a set of crypotgraphic + keys + + used to verify the authenticity and integrity of JSON Web + + Tokens (JWTs) issued by the OAuth identity provider. + example: >- + https://login.microsoftonline.com/common/discovery/v2.0/keys + x-immutable: false + keys: + type: array + items: + $ref: '#/components/schemas/iam.v2.JwksObject' + description: >- + The JWKS issued by the OAuth identity provider. Only `kid` + (key ID) + + and `alg` (algorithm) properties for each key set are + included. + readOnly: true + required: + - display_name + - description + - issuer + - jwks_uri + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/identity-providers/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2IdentityProvider + summary: Read an Identity Provider + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read an identity provider. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity provider. + tags: + - Identity Providers (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Identity Provider. + content: + application/json: + schema: + type: object + description: >- + `IdentityProvider` objects represent external OAuth-OIDC + providers in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your Identity Provider. + + + + Related guide: [OAuth for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + + ## The Identity Providers Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_providers_per_org` | Number of OAuth identity + providers per organization | + + | `public_keys_per_provider` | Number of public keys saved per + identity provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProvider + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the OAuth identity provider. + example: My OIDC Provider + description: + type: string + description: A description of the identity provider. + identity_claim: + type: string + description: >- + The JSON Web Token (JWT) claim to extract the + authenticating identity to Confluent resources from + + [Registered Claim + Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). + This appears + + in audit log records. Note: if the client specifies + mapping to one identity pool ID, the identity + + claim configured with that pool will be used instead. + + Note - The attribute is in an [Early Access lifecycle + stage] + + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: claims.sub + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity provider. + example: ENABLED + readOnly: true + issuer: + type: string + format: uri + description: |- + A publicly accessible URL uniquely identifying the OAuth + identity provider authorized to issue access tokens. + example: https://login.microsoftonline.com/{tenantid}/v2.0 + x-immutable: false + jwks_uri: + type: string + format: uri + description: >- + A publicly accessible JSON Web Key Set (JWKS) URI for the + OAuth + + identity provider. JWKS provides a set of crypotgraphic + keys + + used to verify the authenticity and integrity of JSON Web + + Tokens (JWTs) issued by the OAuth identity provider. + example: >- + https://login.microsoftonline.com/common/discovery/v2.0/keys + x-immutable: false + keys: + type: array + items: + $ref: '#/components/schemas/iam.v2.JwksObject' + description: >- + The JWKS issued by the OAuth identity provider. Only `kid` + (key ID) + + and `alg` (algorithm) properties for each key set are + included. + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - state + - issuer + - jwks_uri + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2IdentityProvider + summary: Update an Identity Provider + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update an identity provider. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity provider. + tags: + - Identity Providers (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.IdentityProvider' + responses: + '200': + description: Identity Provider. + content: + application/json: + schema: + type: object + description: >- + `IdentityProvider` objects represent external OAuth-OIDC + providers in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your Identity Provider. + + + + Related guide: [OAuth for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + + ## The Identity Providers Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_providers_per_org` | Number of OAuth identity + providers per organization | + + | `public_keys_per_provider` | Number of public keys saved per + identity provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProvider + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the OAuth identity provider. + example: My OIDC Provider + description: + type: string + description: A description of the identity provider. + identity_claim: + type: string + description: >- + The JSON Web Token (JWT) claim to extract the + authenticating identity to Confluent resources from + + [Registered Claim + Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). + This appears + + in audit log records. Note: if the client specifies + mapping to one identity pool ID, the identity + + claim configured with that pool will be used instead. + + Note - The attribute is in an [Early Access lifecycle + stage] + + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: claims.sub + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity provider. + example: ENABLED + readOnly: true + issuer: + type: string + format: uri + description: |- + A publicly accessible URL uniquely identifying the OAuth + identity provider authorized to issue access tokens. + example: https://login.microsoftonline.com/{tenantid}/v2.0 + x-immutable: false + jwks_uri: + type: string + format: uri + description: >- + A publicly accessible JSON Web Key Set (JWKS) URI for the + OAuth + + identity provider. JWKS provides a set of crypotgraphic + keys + + used to verify the authenticity and integrity of JSON Web + + Tokens (JWTs) issued by the OAuth identity provider. + example: >- + https://login.microsoftonline.com/common/discovery/v2.0/keys + x-immutable: false + keys: + type: array + items: + $ref: '#/components/schemas/iam.v2.JwksObject' + description: >- + The JWKS issued by the OAuth identity provider. Only `kid` + (key ID) + + and `alg` (algorithm) properties for each key set are + included. + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - state + - issuer + - jwks_uri + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2IdentityProvider + summary: Delete an Identity Provider + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete an identity provider. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity provider. + tags: + - Identity Providers (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Identity Provider is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/identity-providers/{provider_id}/jwks: + patch: + summary: Refresh a provider's JWKS + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to refresh the provider's JWKS + + x-lifecycle-stage: General Availability + x-self-access: true + operationId: refreshIamV2JsonWebKeySet + parameters: + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + tags: + - Jwks (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.Jwks' + responses: + '200': + description: Jwks. + content: + application/json: + schema: + type: object + description: >- + `JWKS` objects represent public key sets for a specific + OAuth/OpenID Connect provider within + + Confluent Cloud. + + + The API allows you to refresh JWKS public key data. + + + + Related guide: [OAuth for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + + ## The Jwks Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Jwks + spec: + $ref: '#/components/schemas/iam.v2.JwksSpec' + status: + $ref: '#/components/schemas/iam.v2.JwksStatus' + required: + - api_version + - kind + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/identity-providers/{provider_id}/identity-pools: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2IdentityPools + summary: List of Identity Pools + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all identity pools. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 255 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + tags: + - Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Identity Pool. + content: + application/json: + schema: + type: object + description: >- + `IdentityPool` objects represent groups of identities tied to + a given a `IdentityProvider` + + that authorizes them to Confluent Cloud resources. + + + It provides a mapping functionality of your `Identity + Provider` user to a Confluent identity pool that + + is then used to provide access to Confluent Resources. + + + + Related guide: [Use identity pools with your OAuth + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + + ## The Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_provider` | Number of Identity Pools per + Identity Provider | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPoolList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `IdentityPool` objects represent groups of identities + tied to a given a `IdentityProvider` + + that authorizes them to Confluent Cloud resources. + + + It provides a mapping functionality of your `Identity + Provider` user to a Confluent identity pool that + + is then used to provide access to Confluent Resources. + + + + Related guide: [Use identity pools with your OAuth + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + + ## The Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_provider` | Number of Identity + Pools per Identity Provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - IdentityPool + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + identity_claim: + type: string + description: >- + The JSON Web Token (JWT) claim to extract the + authenticating identity to Confluent resources from + + (see [Registered Claim + Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) + for more details). + + This appears in the audit log records, showing, for + example, that "identity Z used identity pool X to + access + + topic A". + example: claims.sub + filter: + type: string + description: >- + A filter expression in [Supported Common Expression + Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) + that specifies which identities can authenticate + using your identity pool (see [Set identity pool + filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) + for more details). + maxLength: 300 + example: >- + claims.aud=="confluent" && + claims.group!="invalid_group" + principal: + type: string + description: >- + Represents the federated identity associated with + this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - identity_claim + - filter + - principal + - state + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2IdentityPool + summary: Create an Identity Pool + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create an identity pool. + parameters: + - name: assigned_resource_owner + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: u-a83k9b + description: >- + The resource_id of the principal who will be assigned resource owner + on the created identity pool. Principal can be group-mapping + (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool + (pool-xxx). + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + tags: + - Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `IdentityPool` objects represent groups of identities tied to a + given a `IdentityProvider` + + that authorizes them to Confluent Cloud resources. + + + It provides a mapping functionality of your `Identity Provider` + user to a Confluent identity pool that + + is then used to provide access to Confluent Resources. + + + + Related guide: [Use identity pools with your OAuth + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + + ## The Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_provider` | Number of Identity Pools per + Identity Provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + identity_claim: + type: string + description: >- + The JSON Web Token (JWT) claim to extract the authenticating + identity to Confluent resources from + + (see [Registered Claim + Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) + for more details). + + This appears in the audit log records, showing, for example, + that "identity Z used identity pool X to access + + topic A". + example: claims.sub + filter: + type: string + description: >- + A filter expression in [Supported Common Expression Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) + that specifies which identities can authenticate using your + identity pool (see [Set identity pool + filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) + for more details). + maxLength: 300 + example: claims.aud=="confluent" && claims.group!="invalid_group" + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - display_name + - description + - identity_claim + - filter + responses: + '201': + description: An Identity Pool was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: >- + https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools/{id} + description: IdentityPool resource uri + content: + application/json: + schema: + type: object + description: >- + `IdentityPool` objects represent groups of identities tied to + a given a `IdentityProvider` + + that authorizes them to Confluent Cloud resources. + + + It provides a mapping functionality of your `Identity + Provider` user to a Confluent identity pool that + + is then used to provide access to Confluent Resources. + + + + Related guide: [Use identity pools with your OAuth + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + + ## The Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_provider` | Number of Identity Pools per + Identity Provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + identity_claim: + type: string + description: >- + The JSON Web Token (JWT) claim to extract the + authenticating identity to Confluent resources from + + (see [Registered Claim + Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) + for more details). + + This appears in the audit log records, showing, for + example, that "identity Z used identity pool X to access + + topic A". + example: claims.sub + filter: + type: string + description: >- + A filter expression in [Supported Common Expression + Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) + that specifies which identities can authenticate using + your identity pool (see [Set identity pool + filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) + for more details). + maxLength: 300 + example: claims.aud=="confluent" && claims.group!="invalid_group" + principal: + type: string + description: >- + Represents the federated identity associated with this + pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - display_name + - description + - identity_claim + - filter + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/identity-providers/{provider_id}/identity-pools/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2IdentityPool + summary: Read an Identity Pool + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read an identity pool. + parameters: + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity pool. + tags: + - Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Identity Pool. + content: + application/json: + schema: + type: object + description: >- + `IdentityPool` objects represent groups of identities tied to + a given a `IdentityProvider` + + that authorizes them to Confluent Cloud resources. + + + It provides a mapping functionality of your `Identity + Provider` user to a Confluent identity pool that + + is then used to provide access to Confluent Resources. + + + + Related guide: [Use identity pools with your OAuth + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + + ## The Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_provider` | Number of Identity Pools per + Identity Provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + identity_claim: + type: string + description: >- + The JSON Web Token (JWT) claim to extract the + authenticating identity to Confluent resources from + + (see [Registered Claim + Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) + for more details). + + This appears in the audit log records, showing, for + example, that "identity Z used identity pool X to access + + topic A". + example: claims.sub + filter: + type: string + description: >- + A filter expression in [Supported Common Expression + Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) + that specifies which identities can authenticate using + your identity pool (see [Set identity pool + filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) + for more details). + maxLength: 300 + example: claims.aud=="confluent" && claims.group!="invalid_group" + principal: + type: string + description: >- + Represents the federated identity associated with this + pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - identity_claim + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2IdentityPool + summary: Update an Identity Pool + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update an identity pool. + + parameters: + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity pool. + tags: + - Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.IdentityPool' + responses: + '200': + description: Identity Pool. + content: + application/json: + schema: + type: object + description: >- + `IdentityPool` objects represent groups of identities tied to + a given a `IdentityProvider` + + that authorizes them to Confluent Cloud resources. + + + It provides a mapping functionality of your `Identity + Provider` user to a Confluent identity pool that + + is then used to provide access to Confluent Resources. + + + + Related guide: [Use identity pools with your OAuth + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + + ## The Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_provider` | Number of Identity Pools per + Identity Provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + identity_claim: + type: string + description: >- + The JSON Web Token (JWT) claim to extract the + authenticating identity to Confluent resources from + + (see [Registered Claim + Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) + for more details). + + This appears in the audit log records, showing, for + example, that "identity Z used identity pool X to access + + topic A". + example: claims.sub + filter: + type: string + description: >- + A filter expression in [Supported Common Expression + Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) + that specifies which identities can authenticate using + your identity pool (see [Set identity pool + filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) + for more details). + maxLength: 300 + example: claims.aud=="confluent" && claims.group!="invalid_group" + principal: + type: string + description: >- + Represents the federated identity associated with this + pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - identity_claim + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2IdentityPool + summary: Delete an Identity Pool + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete an identity pool. + parameters: + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity pool. + tags: + - Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Identity Pool is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/sso/group-mappings: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2SsoGroupMappings + summary: List of Group Mappings + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all group mappings. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 255 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Group Mappings (iam/v2/sso) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Group Mapping. + content: + application/json: + schema: + type: object + description: >- + `GroupMapping` objects establish relationships between user + groups in your SSO + + identity provider and specific RBAC roles in Confluent Cloud. + + + Group mappings enable automated and secure access control to + Confluent Cloud resources, + + reducing administrative workload by streamlining user + provisioning and authorization. + + + + Related guide: [Use group mappings with your SSO identity + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + + ## The Group Mappings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `group_mappings_per_org` | Number of group mappings per + organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMappingList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `GroupMapping` objects establish relationships between + user groups in your SSO + + identity provider and specific RBAC roles in Confluent + Cloud. + + + Group mappings enable automated and secure access + control to Confluent Cloud resources, + + reducing administrative workload by streamlining user + provisioning and authorization. + + + + Related guide: [Use group mappings with your SSO + identity + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + + ## The Group Mappings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `group_mappings_per_org` | Number of group mappings + per organization | + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - GroupMapping + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the group mapping. + example: Application Developers + description: + type: string + description: >- + A description explaining the purpose and use of the + group mapping. + example: >- + Admin access to production environment for + Engineering + filter: + type: string + description: >- + A single group identifier or a condition based on + [supported CEL + operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) + that defines which groups are included. + maxLength: 300 + example: >- + "kafka" in groups && "all" in groups || "everyone" + in groups + principal: + type: string + description: >- + The unique federated identity associated with this + group mapping. + example: group-a1b2 + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the group mapping. + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - filter + - principal + - state + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2SsoGroupMapping + summary: Create a Group Mapping + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a group mapping. + tags: + - Group Mappings (iam/v2/sso) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `GroupMapping` objects establish relationships between user + groups in your SSO + + identity provider and specific RBAC roles in Confluent Cloud. + + + Group mappings enable automated and secure access control to + Confluent Cloud resources, + + reducing administrative workload by streamlining user + provisioning and authorization. + + + + Related guide: [Use group mappings with your SSO identity + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + + ## The Group Mappings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `group_mappings_per_org` | Number of group mappings per + organization | + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMapping + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the group mapping. + example: Application Developers + description: + type: string + description: >- + A description explaining the purpose and use of the group + mapping. + example: Admin access to production environment for Engineering + filter: + type: string + description: >- + A single group identifier or a condition based on [supported + CEL + operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) + that defines which groups are included. + maxLength: 300 + example: '"kafka" in groups && "all" in groups || "everyone" in groups' + principal: + type: string + description: >- + The unique federated identity associated with this group + mapping. + example: group-a1b2 + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the group mapping. + example: ENABLED + readOnly: true + required: + - display_name + - description + - filter + responses: + '201': + description: A Group Mapping was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/sso/group-mappings/{id} + description: GroupMapping resource uri + content: + application/json: + schema: + type: object + description: >- + `GroupMapping` objects establish relationships between user + groups in your SSO + + identity provider and specific RBAC roles in Confluent Cloud. + + + Group mappings enable automated and secure access control to + Confluent Cloud resources, + + reducing administrative workload by streamlining user + provisioning and authorization. + + + + Related guide: [Use group mappings with your SSO identity + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + + ## The Group Mappings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `group_mappings_per_org` | Number of group mappings per + organization | + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMapping + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the group mapping. + example: Application Developers + description: + type: string + description: >- + A description explaining the purpose and use of the group + mapping. + example: Admin access to production environment for Engineering + filter: + type: string + description: >- + A single group identifier or a condition based on + [supported CEL + operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) + that defines which groups are included. + maxLength: 300 + example: >- + "kafka" in groups && "all" in groups || "everyone" in + groups + principal: + type: string + description: >- + The unique federated identity associated with this group + mapping. + example: group-a1b2 + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the group mapping. + example: ENABLED + readOnly: true + required: + - display_name + - description + - filter + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/sso/group-mappings/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2SsoGroupMapping + summary: Read a Group Mapping + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a group mapping. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the group mapping. + tags: + - Group Mappings (iam/v2/sso) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Group Mapping. + content: + application/json: + schema: + type: object + description: >- + `GroupMapping` objects establish relationships between user + groups in your SSO + + identity provider and specific RBAC roles in Confluent Cloud. + + + Group mappings enable automated and secure access control to + Confluent Cloud resources, + + reducing administrative workload by streamlining user + provisioning and authorization. + + + + Related guide: [Use group mappings with your SSO identity + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + + ## The Group Mappings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `group_mappings_per_org` | Number of group mappings per + organization | + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMapping + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the group mapping. + example: Application Developers + description: + type: string + description: >- + A description explaining the purpose and use of the group + mapping. + example: Admin access to production environment for Engineering + filter: + type: string + description: >- + A single group identifier or a condition based on + [supported CEL + operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) + that defines which groups are included. + maxLength: 300 + example: >- + "kafka" in groups && "all" in groups || "everyone" in + groups + principal: + type: string + description: >- + The unique federated identity associated with this group + mapping. + example: group-a1b2 + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the group mapping. + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2SsoGroupMapping + summary: Update a Group Mapping + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a group mapping. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the group mapping. + tags: + - Group Mappings (iam/v2/sso) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.sso.GroupMapping' + responses: + '200': + description: Group Mapping. + content: + application/json: + schema: + type: object + description: >- + `GroupMapping` objects establish relationships between user + groups in your SSO + + identity provider and specific RBAC roles in Confluent Cloud. + + + Group mappings enable automated and secure access control to + Confluent Cloud resources, + + reducing administrative workload by streamlining user + provisioning and authorization. + + + + Related guide: [Use group mappings with your SSO identity + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + + ## The Group Mappings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `group_mappings_per_org` | Number of group mappings per + organization | + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMapping + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the group mapping. + example: Application Developers + description: + type: string + description: >- + A description explaining the purpose and use of the group + mapping. + example: Admin access to production environment for Engineering + filter: + type: string + description: >- + A single group identifier or a condition based on + [supported CEL + operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) + that defines which groups are included. + maxLength: 300 + example: >- + "kafka" in groups && "all" in groups || "everyone" in + groups + principal: + type: string + description: >- + The unique federated identity associated with this group + mapping. + example: group-a1b2 + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the group mapping. + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2SsoGroupMapping + summary: Delete a Group Mapping + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a group mapping. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the group mapping. + tags: + - Group Mappings (iam/v2/sso) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Group Mapping is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/certificate-authorities: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2CertificateAuthorities + summary: List of Certificate Authorities + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all certificate + authorities. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 255 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Certificate Authorities (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Certificate Authority. + content: + application/json: + schema: + type: object + description: > + `CertificateAuthority` objects represent signing certificate + authorities in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your Certificate Authority. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthorityList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: > + `CertificateAuthority` objects represent signing + certificate authorities in Confluent Cloud. + + + The API allows you to list, create, read, update, and + delete your Certificate Authority. + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - CertificateAuthority + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: >- + The human-readable name of the certificate + authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + fingerprints: + type: array + items: + type: string + description: >- + The fingerprints for each certificate in the + certificate chain. These are SHA-1 encoded + + strings that act as unique identifiers for the + certificates in the chain. + example: + - B1BC968BD4f49D622AA89A81F2150152A41D829C + readOnly: true + expiration_dates: + type: array + items: + type: string + format: date-time + description: The expiration dates of certificates in the chain. + example: + - '2017-07-21T17:32:28.000Z' + readOnly: true + serial_numbers: + type: array + items: + type: string + description: >- + The serial numbers for each certificate in the + certificate chain. + example: + - 219C542DE8f6EC7177FA4EE8C3705797 + readOnly: true + certificate_chain_filename: + type: string + description: >- + The file name of the uploaded pem file for this + certificate authority. + example: certificate.pem + readOnly: true + crl_source: + type: string + description: >- + The source specifies whether the Certificate + Revocation List (CRL) is updated from + + either local file uploaded (LOCAL) or from url of + CRL (URL). + x-extensible-enum: + - LOCAL + - URL + example: LOCAL + readOnly: true + crl_url: + type: string + format: uri + description: >- + The url from which to fetch the CRL for the + certificate authority if crl_source is URL. + readOnly: true + crl_updated_at: + type: string + format: date-time + description: The timestamp for when CRL was last updated. + example: '2017-07-21T17:32:28.000Z' + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the certificate authority. + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - fingerprints + - expiration_dates + - serial_numbers + - certificate_chain_filename + - state + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.CreateCertRequest' + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2CertificateAuthority + summary: Create a Certificate Authority + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a certificate authority. + tags: + - Certificate Authorities (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '201': + description: A Certificate Authority was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: >- + https://api.confluent.cloud/iam/v2/certificate-authorities/{id} + description: CertificateAuthority resource uri + content: + application/json: + schema: + type: object + description: > + `CertificateAuthority` objects represent signing certificate + authorities in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your Certificate Authority. + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthority + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + fingerprints: + type: array + items: + type: string + description: >- + The fingerprints for each certificate in the certificate + chain. These are SHA-1 encoded + + strings that act as unique identifiers for the + certificates in the chain. + example: + - B1BC968BD4f49D622AA89A81F2150152A41D829C + readOnly: true + expiration_dates: + type: array + items: + type: string + format: date-time + description: The expiration dates of certificates in the chain. + example: + - '2017-07-21T17:32:28.000Z' + readOnly: true + serial_numbers: + type: array + items: + type: string + description: >- + The serial numbers for each certificate in the certificate + chain. + example: + - 219C542DE8f6EC7177FA4EE8C3705797 + readOnly: true + certificate_chain_filename: + type: string + description: >- + The file name of the uploaded pem file for this + certificate authority. + example: certificate.pem + readOnly: true + crl_source: + type: string + description: >- + The source specifies whether the Certificate Revocation + List (CRL) is updated from + + either local file uploaded (LOCAL) or from url of CRL + (URL). + x-extensible-enum: + - LOCAL + - URL + example: LOCAL + readOnly: true + crl_url: + type: string + format: uri + description: >- + The url from which to fetch the CRL for the certificate + authority if crl_source is URL. + readOnly: true + crl_updated_at: + type: string + format: date-time + description: The timestamp for when CRL was last updated. + example: '2017-07-21T17:32:28.000Z' + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the certificate authority. + example: ENABLED + readOnly: true + required: + - display_name + - description + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/certificate-authorities/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2CertificateAuthority + summary: Read a Certificate Authority + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a certificate authority. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate authority. + tags: + - Certificate Authorities (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Certificate Authority. + content: + application/json: + schema: + type: object + description: > + `CertificateAuthority` objects represent signing certificate + authorities in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your Certificate Authority. + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthority + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + fingerprints: + type: array + items: + type: string + description: >- + The fingerprints for each certificate in the certificate + chain. These are SHA-1 encoded + + strings that act as unique identifiers for the + certificates in the chain. + example: + - B1BC968BD4f49D622AA89A81F2150152A41D829C + readOnly: true + expiration_dates: + type: array + items: + type: string + format: date-time + description: The expiration dates of certificates in the chain. + example: + - '2017-07-21T17:32:28.000Z' + readOnly: true + serial_numbers: + type: array + items: + type: string + description: >- + The serial numbers for each certificate in the certificate + chain. + example: + - 219C542DE8f6EC7177FA4EE8C3705797 + readOnly: true + certificate_chain_filename: + type: string + description: >- + The file name of the uploaded pem file for this + certificate authority. + example: certificate.pem + readOnly: true + crl_source: + type: string + description: >- + The source specifies whether the Certificate Revocation + List (CRL) is updated from + + either local file uploaded (LOCAL) or from url of CRL + (URL). + x-extensible-enum: + - LOCAL + - URL + example: LOCAL + readOnly: true + crl_url: + type: string + format: uri + description: >- + The url from which to fetch the CRL for the certificate + authority if crl_source is URL. + readOnly: true + crl_updated_at: + type: string + format: date-time + description: The timestamp for when CRL was last updated. + example: '2017-07-21T17:32:28.000Z' + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the certificate authority. + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - fingerprints + - expiration_dates + - serial_numbers + - certificate_chain_filename + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.UpdateCertRequest' + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2CertificateAuthority + summary: Update a Certificate Authority + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a certificate authority. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate authority. + tags: + - Certificate Authorities (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Certificate Authority. + content: + application/json: + schema: + type: object + description: > + `CertificateAuthority` objects represent signing certificate + authorities in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your Certificate Authority. + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthority + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + fingerprints: + type: array + items: + type: string + description: >- + The fingerprints for each certificate in the certificate + chain. These are SHA-1 encoded + + strings that act as unique identifiers for the + certificates in the chain. + example: + - B1BC968BD4f49D622AA89A81F2150152A41D829C + readOnly: true + expiration_dates: + type: array + items: + type: string + format: date-time + description: The expiration dates of certificates in the chain. + example: + - '2017-07-21T17:32:28.000Z' + readOnly: true + serial_numbers: + type: array + items: + type: string + description: >- + The serial numbers for each certificate in the certificate + chain. + example: + - 219C542DE8f6EC7177FA4EE8C3705797 + readOnly: true + certificate_chain_filename: + type: string + description: >- + The file name of the uploaded pem file for this + certificate authority. + example: certificate.pem + readOnly: true + crl_source: + type: string + description: >- + The source specifies whether the Certificate Revocation + List (CRL) is updated from + + either local file uploaded (LOCAL) or from url of CRL + (URL). + x-extensible-enum: + - LOCAL + - URL + example: LOCAL + readOnly: true + crl_url: + type: string + format: uri + description: >- + The url from which to fetch the CRL for the certificate + authority if crl_source is URL. + readOnly: true + crl_updated_at: + type: string + format: date-time + description: The timestamp for when CRL was last updated. + example: '2017-07-21T17:32:28.000Z' + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the certificate authority. + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - fingerprints + - expiration_dates + - serial_numbers + - certificate_chain_filename + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2CertificateAuthority + summary: Delete a Certificate Authority + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a certificate authority. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate authority. + tags: + - Certificate Authorities (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: A Certificate Authority is being deleted. + content: + application/json: + schema: + type: object + description: > + `CertificateAuthority` objects represent signing certificate + authorities in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your Certificate Authority. + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthority + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + fingerprints: + type: array + items: + type: string + description: >- + The fingerprints for each certificate in the certificate + chain. These are SHA-1 encoded + + strings that act as unique identifiers for the + certificates in the chain. + example: + - B1BC968BD4f49D622AA89A81F2150152A41D829C + readOnly: true + expiration_dates: + type: array + items: + type: string + format: date-time + description: The expiration dates of certificates in the chain. + example: + - '2017-07-21T17:32:28.000Z' + readOnly: true + serial_numbers: + type: array + items: + type: string + description: >- + The serial numbers for each certificate in the certificate + chain. + example: + - 219C542DE8f6EC7177FA4EE8C3705797 + readOnly: true + certificate_chain_filename: + type: string + description: >- + The file name of the uploaded pem file for this + certificate authority. + example: certificate.pem + readOnly: true + crl_source: + type: string + description: >- + The source specifies whether the Certificate Revocation + List (CRL) is updated from + + either local file uploaded (LOCAL) or from url of CRL + (URL). + x-extensible-enum: + - LOCAL + - URL + example: LOCAL + readOnly: true + crl_url: + type: string + format: uri + description: >- + The url from which to fetch the CRL for the certificate + authority if crl_source is URL. + readOnly: true + crl_updated_at: + type: string + format: date-time + description: The timestamp for when CRL was last updated. + example: '2017-07-21T17:32:28.000Z' + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the certificate authority. + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - fingerprints + - expiration_dates + - serial_numbers + - certificate_chain_filename + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2CertificateIdentityPools + summary: List of Certificate Identity Pools + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all certificate identity + pools. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 255 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + - name: certificate_authority_id + in: path + required: true + schema: + type: string + description: The Certificate Authority + tags: + - Certificate Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Certificate Identity Pool. + content: + application/json: + schema: + type: object + description: >- + `Identitypool` objects represent workload identities in + Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your identity pools associated + + with Certificate Authorities + + + + Related guide: [Manage Certificate Identity Pools for Granular + Client Access + Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + + ## The Certificate Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_certificate_authority` | Number of + Identity Pools per Certificate Authority | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPoolList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Identitypool` objects represent workload identities in + Confluent Cloud. + + + The API allows you to list, create, read, update, and + delete your identity pools associated + + with Certificate Authorities + + + + Related guide: [Manage Certificate Identity Pools for + Granular Client Access + Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + + ## The Certificate Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_certificate_authority` | Number of + Identity Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: >- + The certificate field that will be used to represent + the + + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: >- + A filter expression in [Supported Common Expression + Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + that specifies which identities can authenticate + using your certificate identity pool (see [CEL + filter for + mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: >- + Represents the federated identity associated with + this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - external_identifier + - filter + - principal + - state + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2CertificateIdentityPool + summary: Create a Certificate Identity Pool + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a certificate identity pool. + parameters: + - name: assigned_resource_owner + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: u-a83k9b + description: >- + The resource_id of the principal who will be assigned resource owner + on the created certificate identity pool. Principal can be + group-mapping (group-xxx), user (u-xxx), service-account (sa-xxx) or + identity-pool (pool-xxx). + - name: certificate_authority_id + in: path + required: true + schema: + type: string + description: The Certificate Authority + tags: + - Certificate Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Identitypool` objects represent workload identities in + Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your identity pools associated + + with Certificate Authorities + + + + Related guide: [Manage Certificate Identity Pools for Granular + Client Access + Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + + ## The Certificate Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_certificate_authority` | Number of + Identity Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: >- + A filter expression in [Supported Common Expression Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + that specifies which identities can authenticate using your + certificate identity pool (see [CEL filter for + mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - display_name + - description + - external_identifier + - filter + responses: + '201': + description: A Certificate Identity Pool was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: >- + https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id} + description: CertificateIdentityPool resource uri + content: + application/json: + schema: + type: object + description: >- + `Identitypool` objects represent workload identities in + Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your identity pools associated + + with Certificate Authorities + + + + Related guide: [Manage Certificate Identity Pools for Granular + Client Access + Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + + ## The Certificate Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_certificate_authority` | Number of + Identity Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: >- + A filter expression in [Supported Common Expression + Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + that specifies which identities can authenticate using + your certificate identity pool (see [CEL filter for + mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: >- + Represents the federated identity associated with this + pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - display_name + - description + - external_identifier + - filter + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2CertificateIdentityPool + summary: Read a Certificate Identity Pool + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a certificate identity pool. + parameters: + - name: certificate_authority_id + in: path + required: true + schema: + type: string + description: The Certificate Authority + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate identity pool. + tags: + - Certificate Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Certificate Identity Pool. + content: + application/json: + schema: + type: object + description: >- + `Identitypool` objects represent workload identities in + Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your identity pools associated + + with Certificate Authorities + + + + Related guide: [Manage Certificate Identity Pools for Granular + Client Access + Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + + ## The Certificate Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_certificate_authority` | Number of + Identity Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: >- + A filter expression in [Supported Common Expression + Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + that specifies which identities can authenticate using + your certificate identity pool (see [CEL filter for + mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: >- + Represents the federated identity associated with this + pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - external_identifier + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2CertificateIdentityPool + summary: Update a Certificate Identity Pool + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a certificate identity pool. + + parameters: + - name: certificate_authority_id + in: path + required: true + schema: + type: string + description: The Certificate Authority + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate identity pool. + tags: + - Certificate Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.CertificateIdentityPool' + responses: + '200': + description: Certificate Identity Pool. + content: + application/json: + schema: + type: object + description: >- + `Identitypool` objects represent workload identities in + Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your identity pools associated + + with Certificate Authorities + + + + Related guide: [Manage Certificate Identity Pools for Granular + Client Access + Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + + ## The Certificate Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_certificate_authority` | Number of + Identity Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: >- + A filter expression in [Supported Common Expression + Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + that specifies which identities can authenticate using + your certificate identity pool (see [CEL filter for + mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: >- + Represents the federated identity associated with this + pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - external_identifier + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2CertificateIdentityPool + summary: Delete a Certificate Identity Pool + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a certificate identity pool. + parameters: + - name: certificate_authority_id + in: path + required: true + schema: + type: string + description: The Certificate Authority + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate identity pool. + tags: + - Certificate Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: A Certificate Identity Pool is being deleted. + content: + application/json: + schema: + type: object + description: >- + `Identitypool` objects represent workload identities in + Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your identity pools associated + + with Certificate Authorities + + + + Related guide: [Manage Certificate Identity Pools for Granular + Client Access + Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + + ## The Certificate Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_certificate_authority` | Number of + Identity Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: >- + A filter expression in [Supported Common Expression + Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + that specifies which identities can authenticate using + your certificate identity pool (see [CEL filter for + mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: >- + Represents the federated identity associated with this + pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - external_identifier + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + iam.v2.ApiKeyList: + type: object + description: >- + `ApiKey` objects represent access to different parts of Confluent Cloud. + Some types + + of API keys represent access to a single cluster/resource such as a + Kafka cluster, + + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys represent + access to resources within an organization + + that are not tied to a specific cluster, such as the Org API, IAM API, + Metrics API or Connect API. + + Tableflow API keys are not tied to a specific cluster. + + + The API allows you to list, create, update and delete your API Keys. + + + + Related guide: [API Keys in Confluent + Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + + ## The API Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `apikeys_per_org` | API Keys in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKeyList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `ApiKey` objects represent access to different parts of Confluent + Cloud. Some types + + of API keys represent access to a single cluster/resource such as + a Kafka cluster, + + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys + represent access to resources within an organization + + that are not tied to a specific cluster, such as the Org API, IAM + API, Metrics API or Connect API. + + Tableflow API keys are not tied to a specific cluster. + + + The API allows you to list, create, update and delete your API + Keys. + + + + Related guide: [API Keys in Confluent + Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + + ## The API Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `apikeys_per_org` | API Keys in one Confluent Cloud organization + | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKey + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/iam.v2.ApiKeySpec' + required: + - id + - metadata + - spec + uniqueItems: true + iam.v2.ApiKey: + type: object + description: >- + `ApiKey` objects represent access to different parts of Confluent Cloud. + Some types + + of API keys represent access to a single cluster/resource such as a + Kafka cluster, + + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys represent + access to resources within an organization + + that are not tied to a specific cluster, such as the Org API, IAM API, + Metrics API or Connect API. + + Tableflow API keys are not tied to a specific cluster. + + + The API allows you to list, create, update and delete your API Keys. + + + + Related guide: [API Keys in Confluent + Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + + ## The API Keys Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `apikeys_per_org` | API Keys in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKey + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/iam.v2.ApiKeySpec' + iam.v2.UserList: + type: object + description: >- + `User` objects represent individuals who may access your Confluent + resources. + + + The API allows you to retrieve, update, and delete individual users, as + well as list of all your + + users. This API cannot be used to create new user accounts. + + + + Related guide: [Users in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + + ## The Users Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `users_per_org` | Users in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - UserList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `User` objects represent individuals who may access your Confluent + resources. + + + The API allows you to retrieve, update, and delete individual + users, as well as list of all your + + users. This API cannot be used to create new user accounts. + + + + Related guide: [Users in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + + ## The Users Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `users_per_org` | Users in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - User + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + email: + type: string + format: email + example: marty.mcfly@example.com + description: The user's email address + x-immutable: true + full_name: + example: Marty McFly + type: string + description: The user's full name + auth_type: + type: string + description: The user's authentication method + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + readOnly: true + required: + - id + - metadata + - email + uniqueItems: true + iam.v2.User: + type: object + description: >- + `User` objects represent individuals who may access your Confluent + resources. + + + The API allows you to retrieve, update, and delete individual users, as + well as list of all your + + users. This API cannot be used to create new user accounts. + + + + Related guide: [Users in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + + ## The Users Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `users_per_org` | Users in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - User + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: marty.mcfly@example.com + description: The user's email address + x-immutable: true + full_name: + example: Marty McFly + type: string + description: The user's full name + auth_type: + type: string + description: The user's authentication method + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + readOnly: true + iam.v2.User.ConfigureUserAuthRequest: + type: object + description: Configure user auth type + properties: + api_version: + type: string + enum: + - iam.v2/User + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConfigureUserAuthRequest + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + auth_type: + type: string + description: The user's authentication method. + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + MultipleSearchFilter: + description: Filter a collection by a string search for one or more values + type: array + items: + type: string + iam.v2.ServiceAccountList: + type: object + description: >- + `ServiceAccount` objects are typically used to represent applications + and other non-human principals + + that may access your Confluent resources. + + + The API allows you to create, retrieve, update, and delete individual + service accounts, as well as + + list all your service accounts. + + + + Related guide: [Service Accounts in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + + ## The Service Accounts Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `service_accounts_per_org` | Service Accounts in one Confluent Cloud + organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccountList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `ServiceAccount` objects are typically used to represent + applications and other non-human principals + + that may access your Confluent resources. + + + The API allows you to create, retrieve, update, and delete + individual service accounts, as well as + + list all your service accounts. + + + + Related guide: [Service Accounts in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + + ## The Service Accounts Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `service_accounts_per_org` | Service Accounts in one Confluent + Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccount + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + example: DeLorean_auto_repair + description: A human-readable name for the Service Account + description: + type: string + example: Doc's repair bot for the DeLorean + description: A free-form description of the Service Account + required: + - id + - metadata + - display_name + uniqueItems: true + iam.v2.ServiceAccount: + type: object + description: >- + `ServiceAccount` objects are typically used to represent applications + and other non-human principals + + that may access your Confluent resources. + + + The API allows you to create, retrieve, update, and delete individual + service accounts, as well as + + list all your service accounts. + + + + Related guide: [Service Accounts in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + + ## The Service Accounts Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `service_accounts_per_org` | Service Accounts in one Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccount + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: DeLorean_auto_repair + description: A human-readable name for the Service Account + description: + type: string + example: Doc's repair bot for the DeLorean + description: A free-form description of the Service Account + iam.v2.InvitationList: + type: object + description: >- + `Invitation` objects represent invitations to invite users to join your + organizations in Confluent Cloud. + + + The API allows you to list all your invitations, as well as create, + read, and delete a specified invitation. + + + + Related guide: [User invitations in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + + ## The Invitations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `invitations_per_org` | Invitations in a Confluent Cloud organization + | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - InvitationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Invitation` objects represent invitations to invite users to join + your organizations in Confluent Cloud. + + + The API allows you to list all your invitations, as well as + create, read, and delete a specified invitation. + + + + Related guide: [User invitations in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + + ## The Invitations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `invitations_per_org` | Invitations in a Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Invitation + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + email: + type: string + format: email + example: johndoe@confluent.io + description: The user/invitee's email address + x-immutable: true + auth_type: + type: string + description: > + The user/invitee's authentication type. Note that only the + [OrganizationAdmin + role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) + + can invite AUTH_TYPE_LOCAL users to SSO organizations. + + The user's auth_type is set as AUTH_TYPE_SSO by default if the + organization has SSO enabled. + + Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default. + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + status: + type: string + example: INVITE_STATUS_SENT + description: The status of invitations + x-extensible-enum: + - INVITE_STATUS_SENT + - INVITE_STATUS_STAGED + - INVITE_STATUS_ACCEPTED + - INVITE_STATUS_EXPIRED + - INVITE_STATUS_DEACTIVATED + readOnly: true + accepted_at: + type: string + format: date-time + example: '2022-07-06T17:21:33.000Z' + description: The timestamp that the invitation was accepted + nullable: true + readOnly: true + expires_at: + type: string + format: date-time + example: '2022-07-07T17:22:39.000Z' + description: The timestamp that the invitation will expire + readOnly: true + user: + description: The user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + creator: + description: The invitation creator + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - email + uniqueItems: true + iam.v2.Invitation: + type: object + description: >- + `Invitation` objects represent invitations to invite users to join your + organizations in Confluent Cloud. + + + The API allows you to list all your invitations, as well as create, + read, and delete a specified invitation. + + + + Related guide: [User invitations in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + + ## The Invitations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `invitations_per_org` | Invitations in a Confluent Cloud organization + | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Invitation + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: johndoe@confluent.io + description: The user/invitee's email address + x-immutable: true + auth_type: + type: string + description: > + The user/invitee's authentication type. Note that only the + [OrganizationAdmin + role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) + + can invite AUTH_TYPE_LOCAL users to SSO organizations. + + The user's auth_type is set as AUTH_TYPE_SSO by default if the + organization has SSO enabled. + + Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default. + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + status: + type: string + example: INVITE_STATUS_SENT + description: The status of invitations + x-extensible-enum: + - INVITE_STATUS_SENT + - INVITE_STATUS_STAGED + - INVITE_STATUS_ACCEPTED + - INVITE_STATUS_EXPIRED + - INVITE_STATUS_DEACTIVATED + readOnly: true + accepted_at: + type: string + format: date-time + example: '2022-07-06T17:21:33.000Z' + description: The timestamp that the invitation was accepted + nullable: true + readOnly: true + expires_at: + type: string + format: date-time + example: '2022-07-07T17:22:39.000Z' + description: The timestamp that the invitation will expire + readOnly: true + user: + description: The user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + creator: + description: The invitation creator + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + iam.v2.IpGroupList: + type: object + description: >- + Definitions of networks which can be named and referred by IP blocks, + commonly used to attach to IP Filter rules. + + + + ## The IP Groups Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroupList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + Definitions of networks which can be named and referred by IP + blocks, commonly used to attach to IP Filter rules. + + + + ## The IP Groups Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroup + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + group_name: + type: string + minLength: 1 + maxLength: 64 + example: CorpNet + description: > + A human readable name for an IP Group. Can contain any unicode + letter or number, the ASCII space character, or + + any of the following special characters: `[`, `]`, `|`, `&`, + `+`, `-`, `_`, `/`, `.`, `,`. + cidr_blocks: + type: array + items: + type: string + minItems: 1 + maxItems: 25 + example: + - 192.168.0.0/24 + - 192.168.7.0/24 + description: A list of CIDRs. + required: + - id + - metadata + - group_name + - cidr_blocks + uniqueItems: true + iam.v2.IpGroup: + type: object + description: >- + Definitions of networks which can be named and referred by IP blocks, + commonly used to attach to IP Filter rules. + + + + ## The IP Groups Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroup + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + group_name: + type: string + minLength: 1 + maxLength: 64 + example: CorpNet + description: > + A human readable name for an IP Group. Can contain any unicode + letter or number, the ASCII space character, or + + any of the following special characters: `[`, `]`, `|`, `&`, `+`, + `-`, `_`, `/`, `.`, `,`. + cidr_blocks: + type: array + items: + type: string + minItems: 1 + maxItems: 25 + example: + - 192.168.0.0/24 + - 192.168.7.0/24 + description: A list of CIDRs. + iam.v2.IpFilterList: + type: object + description: >- + `IP Filter` objects are bindings between IP Groups and Confluent + resource(s). + + For example, a binding between "CorpNet" and "Management APIs" will + enforce that + + access must come from one of the CIDR blocks associated with CorpNet. + + If there are multiple IP filters bound to a resource, a request matching + any of the CIDR blocks + + for any of the IP Group will allow the request. + + If there are no IP Filters for a resource, then access will be granted + to requests originating + + from any IP Address. + + + + ## The IP Filters Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `IP Filter` objects are bindings between IP Groups and Confluent + resource(s). + + For example, a binding between "CorpNet" and "Management APIs" + will enforce that + + access must come from one of the CIDR blocks associated with + CorpNet. + + If there are multiple IP filters bound to a resource, a request + matching any of the CIDR blocks + + for any of the IP Group will allow the request. + + If there are no IP Filters for a resource, then access will be + granted to requests originating + + from any IP Address. + + + + ## The IP Filters Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilter + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + filter_name: + type: string + minLength: 1 + maxLength: 64 + example: Management API Rules + description: > + A human readable name for an IP Filter. Can contain any + unicode letter or number, the ASCII space character, + + or any of the following special characters: `[`, `]`, `|`, + `&`, `+`, `-`, `_`, `/`, `.`, `,`. + resource_group: + type: string + example: management + description: > + Scope of resources covered by this IP filter. Available + resource groups include "management" and "multiple". + resource_scope: + type: string + example: crn://confluent.cloud/organization=org-123/environment=env-abc + format: uri + pattern: ^crn://.+$ + description: > + A CRN that specifies the scope of the ip filter, specifically + the organization + + or environment. Without specifying this property, the ip + filter + + would apply to the whole organization. + operation_groups: + type: array + items: + type: string + example: + - MANAGEMENT + - SCHEMA + - FLINK + description: > + Scope of resources covered by this IP filter. Resource group + must be set to 'multiple' + + in order to use this property.During update operations, note + that the operation + + groups passed in will replace the list of existing operation + groups + + (passing in an empty list will remove all operation groups) + from the filter + + (in line with the behavior for ip_groups). + ip_groups: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: A list of IP Groups. + minItems: 1 + maxItems: 25 + required: + - id + - metadata + - filter_name + - resource_group + - ip_groups + uniqueItems: true + iam.v2.IpFilter: + type: object + description: >- + `IP Filter` objects are bindings between IP Groups and Confluent + resource(s). + + For example, a binding between "CorpNet" and "Management APIs" will + enforce that + + access must come from one of the CIDR blocks associated with CorpNet. + + If there are multiple IP filters bound to a resource, a request matching + any of the CIDR blocks + + for any of the IP Group will allow the request. + + If there are no IP Filters for a resource, then access will be granted + to requests originating + + from any IP Address. + + + + ## The IP Filters Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilter + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + filter_name: + type: string + minLength: 1 + maxLength: 64 + example: Management API Rules + description: > + A human readable name for an IP Filter. Can contain any unicode + letter or number, the ASCII space character, + + or any of the following special characters: `[`, `]`, `|`, `&`, `+`, + `-`, `_`, `/`, `.`, `,`. + resource_group: + type: string + example: management + description: > + Scope of resources covered by this IP filter. Available resource + groups include "management" and "multiple". + resource_scope: + type: string + example: crn://confluent.cloud/organization=org-123/environment=env-abc + format: uri + pattern: ^crn://.+$ + description: > + A CRN that specifies the scope of the ip filter, specifically the + organization + + or environment. Without specifying this property, the ip filter + + would apply to the whole organization. + operation_groups: + type: array + items: + type: string + example: + - MANAGEMENT + - SCHEMA + - FLINK + description: > + Scope of resources covered by this IP filter. Resource group must be + set to 'multiple' + + in order to use this property.During update operations, note that + the operation + + groups passed in will replace the list of existing operation groups + + (passing in an empty list will remove all operation groups) from the + filter + + (in line with the behavior for ip_groups). + ip_groups: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: A list of IP Groups. + minItems: 1 + maxItems: 25 + iam.v2.IpFilterSummary: + type: object + description: > + The IP Filter Summary endpoint returns an aggregation of the IP Filters + across the system. + + This API can be queried in the context of an organization or an + environment. It returns a + + summary of every operation group in the system grouped with a higher + summary by operation + + group category. + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilterSummary + scope: + type: string + description: The scope associated with this object. + categories: + type: array + items: + type: object + properties: + name: + type: string + description: Name of the category. + status: + type: string + description: Open, limited, or mixed. + operation_groups: + type: array + description: Operation groups part of this category. + items: + type: object + properties: + name: + type: string + description: Name of the operation group. + status: + type: string + description: Open, limited, or no access. + example: + - name: management + status: MIXED + operation_groups: + - name: MANAGEMENT + status: LIMITED + description: > + Summary of the operation groups and IP filters created in those + operation groups. + iam.v2.RoleBindingList: + type: object + description: >- + A role binding grants a Principal a role on resources that match a + pattern. + + + The API allows you to perform create, delete, and list operations on + role bindings. + + + + Related guide: [Role-Based Access Control + (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + + ## The Role Bindings Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBindingList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + A role binding grants a Principal a role on resources that match a + pattern. + + + The API allows you to perform create, delete, and list operations + on role bindings. + + + + Related guide: [Role-Based Access Control + (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + + ## The Role Bindings Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBinding + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + principal: + type: string + description: The principal User to bind the role to + pattern: (^User:.+$) + example: User:u-111aaa + role_name: + type: string + description: The name of the role to bind to the principal + example: CloudClusterAdmin + crn_pattern: + type: string + description: >- + A CRN that specifies the scope and resource patterns necessary + for the role to bind + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + required: + - id + - metadata + - principal + - role_name + - crn_pattern + uniqueItems: true + iam.v2.RoleBinding: + type: object + description: >- + A role binding grants a Principal a role on resources that match a + pattern. + + + The API allows you to perform create, delete, and list operations on + role bindings. + + + + Related guide: [Role-Based Access Control + (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + + ## The Role Bindings Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBinding + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + principal: + type: string + description: The principal User to bind the role to + pattern: (^User:.+$) + example: User:u-111aaa + role_name: + type: string + description: The name of the role to bind to the principal + example: CloudClusterAdmin + crn_pattern: + type: string + description: >- + A CRN that specifies the scope and resource patterns necessary for + the role to bind + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + iam.v2.IdentityProviderList: + type: object + description: >- + `IdentityProvider` objects represent external OAuth-OIDC providers in + Confluent Cloud. + + + The API allows you to list, create, read, update, and delete your + Identity Provider. + + + + Related guide: [OAuth for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + + ## The Identity Providers Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_providers_per_org` | Number of OAuth identity providers per + organization | + + | `public_keys_per_provider` | Number of public keys saved per identity + provider | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProviderList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `IdentityProvider` objects represent external OAuth-OIDC providers + in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete your + Identity Provider. + + + + Related guide: [OAuth for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + + ## The Identity Providers Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_providers_per_org` | Number of OAuth identity + providers per organization | + + | `public_keys_per_provider` | Number of public keys saved per + identity provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProvider + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the OAuth identity provider. + example: My OIDC Provider + description: + type: string + description: A description of the identity provider. + identity_claim: + type: string + description: >- + The JSON Web Token (JWT) claim to extract the authenticating + identity to Confluent resources from + + [Registered Claim + Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). + This appears + + in audit log records. Note: if the client specifies mapping to + one identity pool ID, the identity + + claim configured with that pool will be used instead. + + Note - The attribute is in an [Early Access lifecycle stage] + + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: claims.sub + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity provider. + example: ENABLED + readOnly: true + issuer: + type: string + format: uri + description: |- + A publicly accessible URL uniquely identifying the OAuth + identity provider authorized to issue access tokens. + example: https://login.microsoftonline.com/{tenantid}/v2.0 + x-immutable: false + jwks_uri: + type: string + format: uri + description: >- + A publicly accessible JSON Web Key Set (JWKS) URI for the + OAuth + + identity provider. JWKS provides a set of crypotgraphic keys + + used to verify the authenticity and integrity of JSON Web + + Tokens (JWTs) issued by the OAuth identity provider. + example: https://login.microsoftonline.com/common/discovery/v2.0/keys + x-immutable: false + keys: + type: array + items: + $ref: '#/components/schemas/iam.v2.JwksObject' + description: >- + The JWKS issued by the OAuth identity provider. Only `kid` + (key ID) + + and `alg` (algorithm) properties for each key set are + included. + readOnly: true + required: + - id + - metadata + - display_name + - description + - state + - issuer + - jwks_uri + uniqueItems: true + iam.v2.IdentityProvider: + type: object + description: >- + `IdentityProvider` objects represent external OAuth-OIDC providers in + Confluent Cloud. + + + The API allows you to list, create, read, update, and delete your + Identity Provider. + + + + Related guide: [OAuth for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + + ## The Identity Providers Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_providers_per_org` | Number of OAuth identity providers per + organization | + + | `public_keys_per_provider` | Number of public keys saved per identity + provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProvider + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the OAuth identity provider. + example: My OIDC Provider + description: + type: string + description: A description of the identity provider. + identity_claim: + type: string + description: >- + The JSON Web Token (JWT) claim to extract the authenticating + identity to Confluent resources from + + [Registered Claim + Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). + This appears + + in audit log records. Note: if the client specifies mapping to one + identity pool ID, the identity + + claim configured with that pool will be used instead. + + Note - The attribute is in an [Early Access lifecycle stage] + + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: claims.sub + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity provider. + example: ENABLED + readOnly: true + issuer: + type: string + format: uri + description: |- + A publicly accessible URL uniquely identifying the OAuth + identity provider authorized to issue access tokens. + example: https://login.microsoftonline.com/{tenantid}/v2.0 + x-immutable: false + jwks_uri: + type: string + format: uri + description: |- + A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth + identity provider. JWKS provides a set of crypotgraphic keys + used to verify the authenticity and integrity of JSON Web + Tokens (JWTs) issued by the OAuth identity provider. + example: https://login.microsoftonline.com/common/discovery/v2.0/keys + x-immutable: false + keys: + type: array + items: + $ref: '#/components/schemas/iam.v2.JwksObject' + description: |- + The JWKS issued by the OAuth identity provider. Only `kid` (key ID) + and `alg` (algorithm) properties for each key set are included. + readOnly: true + iam.v2.Jwks: + type: object + description: >- + `JWKS` objects represent public key sets for a specific OAuth/OpenID + Connect provider within + + Confluent Cloud. + + + The API allows you to refresh JWKS public key data. + + + + Related guide: [OAuth for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + + ## The Jwks Model + + + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Jwks + spec: + $ref: '#/components/schemas/iam.v2.JwksSpec' + status: + $ref: '#/components/schemas/iam.v2.JwksStatus' + iam.v2.IdentityPoolList: + type: object + description: >- + `IdentityPool` objects represent groups of identities tied to a given a + `IdentityProvider` + + that authorizes them to Confluent Cloud resources. + + + It provides a mapping functionality of your `Identity Provider` user to + a Confluent identity pool that + + is then used to provide access to Confluent Resources. + + + + Related guide: [Use identity pools with your OAuth + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + + ## The Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_provider` | Number of Identity Pools per Identity + Provider | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPoolList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `IdentityPool` objects represent groups of identities tied to a + given a `IdentityProvider` + + that authorizes them to Confluent Cloud resources. + + + It provides a mapping functionality of your `Identity Provider` + user to a Confluent identity pool that + + is then used to provide access to Confluent Resources. + + + + Related guide: [Use identity pools with your OAuth + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + + ## The Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_provider` | Number of Identity Pools per + Identity Provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + identity_claim: + type: string + description: >- + The JSON Web Token (JWT) claim to extract the authenticating + identity to Confluent resources from + + (see [Registered Claim + Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) + for more details). + + This appears in the audit log records, showing, for example, + that "identity Z used identity pool X to access + + topic A". + example: claims.sub + filter: + type: string + description: >- + A filter expression in [Supported Common Expression Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) + that specifies which identities can authenticate using your + identity pool (see [Set identity pool + filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) + for more details). + maxLength: 300 + example: claims.aud=="confluent" && claims.group!="invalid_group" + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - identity_claim + - filter + - principal + - state + uniqueItems: true + iam.v2.IdentityPool: + type: object + description: >- + `IdentityPool` objects represent groups of identities tied to a given a + `IdentityProvider` + + that authorizes them to Confluent Cloud resources. + + + It provides a mapping functionality of your `Identity Provider` user to + a Confluent identity pool that + + is then used to provide access to Confluent Resources. + + + + Related guide: [Use identity pools with your OAuth + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + + ## The Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_provider` | Number of Identity Pools per Identity + Provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + identity_claim: + type: string + description: >- + The JSON Web Token (JWT) claim to extract the authenticating + identity to Confluent resources from + + (see [Registered Claim + Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) + for more details). + + This appears in the audit log records, showing, for example, that + "identity Z used identity pool X to access + + topic A". + example: claims.sub + filter: + type: string + description: >- + A filter expression in [Supported Common Expression Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) + that specifies which identities can authenticate using your identity + pool (see [Set identity pool + filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) + for more details). + maxLength: 300 + example: claims.aud=="confluent" && claims.group!="invalid_group" + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + iam.v2.sso.GroupMappingList: + type: object + description: >- + `GroupMapping` objects establish relationships between user groups in + your SSO + + identity provider and specific RBAC roles in Confluent Cloud. + + + Group mappings enable automated and secure access control to Confluent + Cloud resources, + + reducing administrative workload by streamlining user provisioning and + authorization. + + + + Related guide: [Use group mappings with your SSO identity + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + + ## The Group Mappings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `group_mappings_per_org` | Number of group mappings per organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMappingList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `GroupMapping` objects establish relationships between user groups + in your SSO + + identity provider and specific RBAC roles in Confluent Cloud. + + + Group mappings enable automated and secure access control to + Confluent Cloud resources, + + reducing administrative workload by streamlining user provisioning + and authorization. + + + + Related guide: [Use group mappings with your SSO identity + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + + ## The Group Mappings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `group_mappings_per_org` | Number of group mappings per + organization | + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMapping + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the group mapping. + example: Application Developers + description: + type: string + description: >- + A description explaining the purpose and use of the group + mapping. + example: Admin access to production environment for Engineering + filter: + type: string + description: >- + A single group identifier or a condition based on [supported + CEL + operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) + that defines which groups are included. + maxLength: 300 + example: '"kafka" in groups && "all" in groups || "everyone" in groups' + principal: + type: string + description: >- + The unique federated identity associated with this group + mapping. + example: group-a1b2 + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the group mapping. + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - filter + - principal + - state + uniqueItems: true + iam.v2.sso.GroupMapping: + type: object + description: >- + `GroupMapping` objects establish relationships between user groups in + your SSO + + identity provider and specific RBAC roles in Confluent Cloud. + + + Group mappings enable automated and secure access control to Confluent + Cloud resources, + + reducing administrative workload by streamlining user provisioning and + authorization. + + + + Related guide: [Use group mappings with your SSO identity + provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + + ## The Group Mappings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `group_mappings_per_org` | Number of group mappings per organization | + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMapping + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the group mapping. + example: Application Developers + description: + type: string + description: A description explaining the purpose and use of the group mapping. + example: Admin access to production environment for Engineering + filter: + type: string + description: >- + A single group identifier or a condition based on [supported CEL + operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) + that defines which groups are included. + maxLength: 300 + example: '"kafka" in groups && "all" in groups || "everyone" in groups' + principal: + type: string + description: The unique federated identity associated with this group mapping. + example: group-a1b2 + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the group mapping. + example: ENABLED + readOnly: true + iam.v2.CertificateAuthorityList: + type: object + description: > + `CertificateAuthority` objects represent signing certificate authorities + in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete your + Certificate Authority. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthorityList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: > + `CertificateAuthority` objects represent signing certificate + authorities in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete your + Certificate Authority. + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthority + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + fingerprints: + type: array + items: + type: string + description: >- + The fingerprints for each certificate in the certificate + chain. These are SHA-1 encoded + + strings that act as unique identifiers for the certificates in + the chain. + example: + - B1BC968BD4f49D622AA89A81F2150152A41D829C + readOnly: true + expiration_dates: + type: array + items: + type: string + format: date-time + description: The expiration dates of certificates in the chain. + example: + - '2017-07-21T17:32:28.000Z' + readOnly: true + serial_numbers: + type: array + items: + type: string + description: >- + The serial numbers for each certificate in the certificate + chain. + example: + - 219C542DE8f6EC7177FA4EE8C3705797 + readOnly: true + certificate_chain_filename: + type: string + description: >- + The file name of the uploaded pem file for this certificate + authority. + example: certificate.pem + readOnly: true + crl_source: + type: string + description: >- + The source specifies whether the Certificate Revocation List + (CRL) is updated from + + either local file uploaded (LOCAL) or from url of CRL (URL). + x-extensible-enum: + - LOCAL + - URL + example: LOCAL + readOnly: true + crl_url: + type: string + format: uri + description: >- + The url from which to fetch the CRL for the certificate + authority if crl_source is URL. + readOnly: true + crl_updated_at: + type: string + format: date-time + description: The timestamp for when CRL was last updated. + example: '2017-07-21T17:32:28.000Z' + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the certificate authority. + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - fingerprints + - expiration_dates + - serial_numbers + - certificate_chain_filename + - state + uniqueItems: true + iam.v2.CreateCertRequest: + type: object + description: This contains the json schema used to create a Certificate Authority + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CreateCertRequest + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + certificate_chain: + type: string + description: |- + The PEM encoded string containing the signing certificate chain + used to validate client certs. + example: >- + -----BEGIN CERTIFICATE----- + + MIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx + + GTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds + + b2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV + + BAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD + + VQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa + + DuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc + + THAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb + + Kk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP + + c1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX + + gzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV + + HRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF + + AAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj + + Y1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG + + j/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH + + hm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC + + X4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A== + + -----END CERTIFICATE----- + certificate_chain_filename: + type: string + description: The name of the certificate file. + example: certificate.pem + crl_url: + type: string + format: uri + description: >- + The url from which to fetch the CRL for the certificate authority if + crl_source is URL. + crl_chain: + type: string + description: >- + The PEM encoded string containing the CRL for this certificate + authority. + + Defaults to this over `crl_url` if available. + example: |- + -----BEGIN X509 CRL----- + MIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD + VQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1 + ZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0 + eS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt + MS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl + AhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U + BAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX + CKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4 + xqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl + gIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE + jatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6 + cGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg= + -----END X509 CRL----- + iam.v2.CertificateAuthority: + type: object + description: > + `CertificateAuthority` objects represent signing certificate authorities + in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete your + Certificate Authority. + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthority + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + fingerprints: + type: array + items: + type: string + description: >- + The fingerprints for each certificate in the certificate chain. + These are SHA-1 encoded + + strings that act as unique identifiers for the certificates in the + chain. + example: + - B1BC968BD4f49D622AA89A81F2150152A41D829C + readOnly: true + expiration_dates: + type: array + items: + type: string + format: date-time + description: The expiration dates of certificates in the chain. + example: + - '2017-07-21T17:32:28.000Z' + readOnly: true + serial_numbers: + type: array + items: + type: string + description: The serial numbers for each certificate in the certificate chain. + example: + - 219C542DE8f6EC7177FA4EE8C3705797 + readOnly: true + certificate_chain_filename: + type: string + description: >- + The file name of the uploaded pem file for this certificate + authority. + example: certificate.pem + readOnly: true + crl_source: + type: string + description: >- + The source specifies whether the Certificate Revocation List (CRL) + is updated from + + either local file uploaded (LOCAL) or from url of CRL (URL). + x-extensible-enum: + - LOCAL + - URL + example: LOCAL + readOnly: true + crl_url: + type: string + format: uri + description: >- + The url from which to fetch the CRL for the certificate authority if + crl_source is URL. + readOnly: true + crl_updated_at: + type: string + format: date-time + description: The timestamp for when CRL was last updated. + example: '2017-07-21T17:32:28.000Z' + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the certificate authority. + example: ENABLED + readOnly: true + iam.v2.UpdateCertRequest: + type: object + description: This contains the form fields used to update a Certificate Authority + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - UpdateCertRequest + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + certificate_chain: + type: string + description: |- + The PEM encoded string containing the signing certificate chain + used to validate client certs. + example: >- + -----BEGIN CERTIFICATE----- + + MIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx + + GTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds + + b2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV + + BAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD + + VQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa + + DuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc + + THAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb + + Kk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP + + c1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX + + gzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV + + HRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF + + AAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj + + Y1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG + + j/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH + + hm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC + + X4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A== + + -----END CERTIFICATE----- + certificate_chain_filename: + type: string + description: >- + The name of the certificate file. Must be set if certificate is + updated. + example: certificate.pem + crl_url: + type: string + format: uri + description: >- + The url from which to fetch the CRL for the certificate authority if + crl_source is URL. + crl_chain: + type: string + description: >- + The PEM encoded string containing the CRL for this certificate + authority. + + Defaults to this over `crl_url` if available. + example: |- + -----BEGIN X509 CRL----- + MIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD + VQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1 + ZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0 + eS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt + MS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl + AhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U + BAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX + CKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4 + xqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl + gIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE + jatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6 + cGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg= + -----END X509 CRL----- + iam.v2.CertificateIdentityPoolList: + type: object + description: >- + `Identitypool` objects represent workload identities in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete your + identity pools associated + + with Certificate Authorities + + + + Related guide: [Manage Certificate Identity Pools for Granular Client + Access + Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + + ## The Certificate Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_certificate_authority` | Number of Identity Pools + per Certificate Authority | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPoolList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Identitypool` objects represent workload identities in Confluent + Cloud. + + + The API allows you to list, create, read, update, and delete your + identity pools associated + + with Certificate Authorities + + + + Related guide: [Manage Certificate Identity Pools for Granular + Client Access + Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + + ## The Certificate Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_certificate_authority` | Number of Identity + Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: >- + A filter expression in [Supported Common Expression Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + that specifies which identities can authenticate using your + certificate identity pool (see [CEL filter for + mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - external_identifier + - filter + - principal + - state + uniqueItems: true + iam.v2.CertificateIdentityPool: + type: object + description: >- + `Identitypool` objects represent workload identities in Confluent Cloud. + + + The API allows you to list, create, read, update, and delete your + identity pools associated + + with Certificate Authorities + + + + Related guide: [Manage Certificate Identity Pools for Granular Client + Access + Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + + ## The Certificate Identity Pools Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `identity_pools_per_certificate_authority` | Number of Identity Pools + per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: >- + A filter expression in [Supported Common Expression Language + (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + that specifies which identities can authenticate using your + certificate identity pool (see [CEL filter for + mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) + for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + iam.v2.ApiKeySpec: + type: object + description: The desired state of the Api Key + properties: + secret: + type: string + example: R15hoiDIq8Nxu/lY4mPO3DwAVIfU5W7OI+efsB607mLgHTnVW5XJGVqX2ysDx987 + description: >- + The API key secret. Only provided in `create` responses, not in + `get` or `list`. + x-redact: true + x-immutable: true + readOnly: true + display_name: + type: string + example: CI kafka access key + description: A human readable name for the API key + description: + type: string + example: This API key provides kafka access to cluster x + description: A human readable description for the API key + owner: + description: >- + The owner to which this belongs. The owner can be one of + iam.v2.User, iam.v2.ServiceAccount. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + resource: + nullable: true + description: > + The resource associated with this object. The resource can be one of + Kafka Cluster ID (example: lkc-12345), + + Schema Registry Cluster ID (example: lsrc-12345), ksqlDB Cluster ID + (example: lksqlc-12345), or Flink + + (Environment + Region pair, example: env-abc123.aws.us-east-2). + + May be null or omitted if not associated with a resource. For + creating Cloud API key, resource should be `CLOUD`, + + for creating Tableflow API key, resource should be `TABLEFLOW`. The + resource id is case-insensitive. + + [Learn more in + Authentication](https://docs.confluent.io/cloud/current/api.html#section/Authentication). + + + Note - Flink is in the [Preview lifecycle + stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + GlobalObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + iam.v2.JwksObject: + type: object + description: '`JWKS` contains the published keys for the given OpenIDProvider' + required: + - kty + - kid + - alg + properties: + kty: + type: string + x-extensible-enum: + - RSA + description: Specifies the cryptographic algorithm family used with the key + example: RSA + kid: + type: string + description: >- + Specifies the key-id issued by the OpenIDProvider for the particular + tenant + example: nOo3ZDrODXEK1jKWhXslHR_KXEg + alg: + type: string + description: Specifies the algorithm to be used to generate the public key + example: RS256 + use: + type: string + description: Specifies the intended usage of the key + example: sig + 'n': + type: string + description: >- + Specifies the modulus of the RSA public key. Represented as a + Base64urlUInt-encoded value + e: + type: string + description: Specifies the exponent of the RSA public key. + example: AQAB + iam.v2.JwksSpec: + type: object + description: The desired state of the Jwks + properties: + jwks_status: + type: string + x-extensible-enum: + - REFRESHED + description: The desired state of the public key data + example: REFRESHED + x-enable-id: false + x-enable-listmeta: true + x-enable-objectmeta: false + iam.v2.JwksStatus: + description: The status of the Jwks + type: object + properties: + jwks_status: + type: string + x-extensible-enum: + - REFRESHED + - OK + - INVALID_JWKS_URI + - ERROR_FETCHING_JWKS + description: The actual state of the public key data + example: REFRESHED + jwks_last_refresh_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + description: The last successful refresh time for the public key data + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + TypedGlobalObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + TypedEnvScopedObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + OverQuotaError: + x-summary: Over Quota + description: The request would exceed one or more quotas. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '402' + code: quota_exceeded + title: Kafka Clusters Per Org Quota Exceeded + detail: >- + The request would exceed the quota: + kafka_clusters_per_environment + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + x-stackQL-resources: + api_keys: + id: confluent.iam.api_keys + name: api_keys + title: Api Keys + methods: + list_iam_v2_api_keys: + operation: + $ref: '#/paths/~1iam~1v2~1api-keys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_iam_v2_api_key: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1api-keys/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_iam_v2_api_key: + operation: + $ref: '#/paths/~1iam~1v2~1api-keys~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_iam_v2_api_key: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1api-keys~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_iam_v2_api_key: + operation: + $ref: '#/paths/~1iam~1v2~1api-keys~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/api_keys/methods/get_iam_v2_api_key + - $ref: >- + #/components/x-stackQL-resources/api_keys/methods/list_iam_v2_api_keys + insert: + - $ref: >- + #/components/x-stackQL-resources/api_keys/methods/create_iam_v2_api_key + update: + - $ref: >- + #/components/x-stackQL-resources/api_keys/methods/update_iam_v2_api_key + delete: + - $ref: >- + #/components/x-stackQL-resources/api_keys/methods/delete_iam_v2_api_key + replace: [] + users: + id: confluent.iam.users + name: users + title: Users + methods: + list_iam_v2_users: + operation: + $ref: '#/paths/~1iam~1v2~1users/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_iam_v2_user: + operation: + $ref: '#/paths/~1iam~1v2~1users~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_iam_v2_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1users~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_iam_v2_user: + operation: + $ref: '#/paths/~1iam~1v2~1users~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + update_auth_type_iam_v2_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1users~1{id}~1auth/patch' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/users/methods/get_iam_v2_user' + - $ref: '#/components/x-stackQL-resources/users/methods/list_iam_v2_users' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/users/methods/update_iam_v2_user' + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete_iam_v2_user' + replace: [] + service_accounts: + id: confluent.iam.service_accounts + name: service_accounts + title: Service Accounts + methods: + list_iam_v2_service_accounts: + operation: + $ref: '#/paths/~1iam~1v2~1service-accounts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_iam_v2_service_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1service-accounts/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_iam_v2_service_account: + operation: + $ref: '#/paths/~1iam~1v2~1service-accounts~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_iam_v2_service_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1service-accounts~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_iam_v2_service_account: + operation: + $ref: '#/paths/~1iam~1v2~1service-accounts~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/service_accounts/methods/get_iam_v2_service_account + - $ref: >- + #/components/x-stackQL-resources/service_accounts/methods/list_iam_v2_service_accounts + insert: + - $ref: >- + #/components/x-stackQL-resources/service_accounts/methods/create_iam_v2_service_account + update: + - $ref: >- + #/components/x-stackQL-resources/service_accounts/methods/update_iam_v2_service_account + delete: + - $ref: >- + #/components/x-stackQL-resources/service_accounts/methods/delete_iam_v2_service_account + replace: [] + invitations: + id: confluent.iam.invitations + name: invitations + title: Invitations + methods: + list_iam_v2_invitations: + operation: + $ref: '#/paths/~1iam~1v2~1invitations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_iam_v2_invitation: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1invitations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_iam_v2_invitation: + operation: + $ref: '#/paths/~1iam~1v2~1invitations~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_iam_v2_invitation: + operation: + $ref: '#/paths/~1iam~1v2~1invitations~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/invitations/methods/get_iam_v2_invitation + - $ref: >- + #/components/x-stackQL-resources/invitations/methods/list_iam_v2_invitations + insert: + - $ref: >- + #/components/x-stackQL-resources/invitations/methods/create_iam_v2_invitation + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/invitations/methods/delete_iam_v2_invitation + replace: [] + ip_groups: + id: confluent.iam.ip_groups + name: ip_groups + title: Ip Groups + methods: + list_iam_v2_ip_groups: + operation: + $ref: '#/paths/~1iam~1v2~1ip-groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_iam_v2_ip_group: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1ip-groups/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_iam_v2_ip_group: + operation: + $ref: '#/paths/~1iam~1v2~1ip-groups~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_iam_v2_ip_group: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1ip-groups~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_iam_v2_ip_group: + operation: + $ref: '#/paths/~1iam~1v2~1ip-groups~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/ip_groups/methods/get_iam_v2_ip_group + - $ref: >- + #/components/x-stackQL-resources/ip_groups/methods/list_iam_v2_ip_groups + insert: + - $ref: >- + #/components/x-stackQL-resources/ip_groups/methods/create_iam_v2_ip_group + update: + - $ref: >- + #/components/x-stackQL-resources/ip_groups/methods/update_iam_v2_ip_group + delete: + - $ref: >- + #/components/x-stackQL-resources/ip_groups/methods/delete_iam_v2_ip_group + replace: [] + ip_filters: + id: confluent.iam.ip_filters + name: ip_filters + title: Ip Filters + methods: + list_iam_v2_ip_filters: + operation: + $ref: '#/paths/~1iam~1v2~1ip-filters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_iam_v2_ip_filter: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1ip-filters/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_iam_v2_ip_filter: + operation: + $ref: '#/paths/~1iam~1v2~1ip-filters~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_iam_v2_ip_filter: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1ip-filters~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_iam_v2_ip_filter: + operation: + $ref: '#/paths/~1iam~1v2~1ip-filters~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/ip_filters/methods/get_iam_v2_ip_filter + - $ref: >- + #/components/x-stackQL-resources/ip_filters/methods/list_iam_v2_ip_filters + insert: + - $ref: >- + #/components/x-stackQL-resources/ip_filters/methods/create_iam_v2_ip_filter + update: + - $ref: >- + #/components/x-stackQL-resources/ip_filters/methods/update_iam_v2_ip_filter + delete: + - $ref: >- + #/components/x-stackQL-resources/ip_filters/methods/delete_iam_v2_ip_filter + replace: [] + ip_filter_summaries: + id: confluent.iam.ip_filter_summaries + name: ip_filter_summaries + title: Ip Filter Summaries + methods: + get_iam_v2_ip_filter_summary: + operation: + $ref: '#/paths/~1iam~1v2~1ip-filter-summary/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/ip_filter_summaries/methods/get_iam_v2_ip_filter_summary + insert: [] + update: [] + delete: [] + replace: [] + role_bindings: + id: confluent.iam.role_bindings + name: role_bindings + title: Role Bindings + methods: + list_iam_v2_role_bindings: + operation: + $ref: '#/paths/~1iam~1v2~1role-bindings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_iam_v2_role_binding: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1role-bindings/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_iam_v2_role_binding: + operation: + $ref: '#/paths/~1iam~1v2~1role-bindings~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_iam_v2_role_binding: + operation: + $ref: '#/paths/~1iam~1v2~1role-bindings~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/role_bindings/methods/get_iam_v2_role_binding + - $ref: >- + #/components/x-stackQL-resources/role_bindings/methods/list_iam_v2_role_bindings + insert: + - $ref: >- + #/components/x-stackQL-resources/role_bindings/methods/create_iam_v2_role_binding + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/role_bindings/methods/delete_iam_v2_role_binding + replace: [] + identity_providers: + id: confluent.iam.identity_providers + name: identity_providers + title: Identity Providers + methods: + list_iam_v2_identity_providers: + operation: + $ref: '#/paths/~1iam~1v2~1identity-providers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_iam_v2_identity_provider: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1identity-providers/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_iam_v2_identity_provider: + operation: + $ref: '#/paths/~1iam~1v2~1identity-providers~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_iam_v2_identity_provider: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1identity-providers~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_iam_v2_identity_provider: + operation: + $ref: '#/paths/~1iam~1v2~1identity-providers~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + refresh_iam_v2_json_web_key_set: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1identity-providers~1{provider_id}~1jwks/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/identity_providers/methods/get_iam_v2_identity_provider + - $ref: >- + #/components/x-stackQL-resources/identity_providers/methods/list_iam_v2_identity_providers + insert: + - $ref: >- + #/components/x-stackQL-resources/identity_providers/methods/create_iam_v2_identity_provider + update: + - $ref: >- + #/components/x-stackQL-resources/identity_providers/methods/update_iam_v2_identity_provider + delete: + - $ref: >- + #/components/x-stackQL-resources/identity_providers/methods/delete_iam_v2_identity_provider + replace: [] + identity_pools: + id: confluent.iam.identity_pools + name: identity_pools + title: Identity Pools + methods: + list_iam_v2_identity_pools: + operation: + $ref: >- + #/paths/~1iam~1v2~1identity-providers~1{provider_id}~1identity-pools/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_iam_v2_identity_pool: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1iam~1v2~1identity-providers~1{provider_id}~1identity-pools/post + response: + mediaType: application/json + openAPIDocKey: '201' + get_iam_v2_identity_pool: + operation: + $ref: >- + #/paths/~1iam~1v2~1identity-providers~1{provider_id}~1identity-pools~1{id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_iam_v2_identity_pool: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1iam~1v2~1identity-providers~1{provider_id}~1identity-pools~1{id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_iam_v2_identity_pool: + operation: + $ref: >- + #/paths/~1iam~1v2~1identity-providers~1{provider_id}~1identity-pools~1{id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/identity_pools/methods/get_iam_v2_identity_pool + - $ref: >- + #/components/x-stackQL-resources/identity_pools/methods/list_iam_v2_identity_pools + insert: + - $ref: >- + #/components/x-stackQL-resources/identity_pools/methods/create_iam_v2_identity_pool + update: + - $ref: >- + #/components/x-stackQL-resources/identity_pools/methods/update_iam_v2_identity_pool + delete: + - $ref: >- + #/components/x-stackQL-resources/identity_pools/methods/delete_iam_v2_identity_pool + replace: [] + group_mappings: + id: confluent.iam.group_mappings + name: group_mappings + title: Group Mappings + methods: + list_iam_v2_sso_group_mappings: + operation: + $ref: '#/paths/~1iam~1v2~1sso~1group-mappings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_iam_v2_sso_group_mapping: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1sso~1group-mappings/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_iam_v2_sso_group_mapping: + operation: + $ref: '#/paths/~1iam~1v2~1sso~1group-mappings~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_iam_v2_sso_group_mapping: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1sso~1group-mappings~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_iam_v2_sso_group_mapping: + operation: + $ref: '#/paths/~1iam~1v2~1sso~1group-mappings~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/group_mappings/methods/get_iam_v2_sso_group_mapping + - $ref: >- + #/components/x-stackQL-resources/group_mappings/methods/list_iam_v2_sso_group_mappings + insert: + - $ref: >- + #/components/x-stackQL-resources/group_mappings/methods/create_iam_v2_sso_group_mapping + update: + - $ref: >- + #/components/x-stackQL-resources/group_mappings/methods/update_iam_v2_sso_group_mapping + delete: + - $ref: >- + #/components/x-stackQL-resources/group_mappings/methods/delete_iam_v2_sso_group_mapping + replace: [] + certificate_authorities: + id: confluent.iam.certificate_authorities + name: certificate_authorities + title: Certificate Authorities + methods: + list_iam_v2_certificate_authorities: + operation: + $ref: '#/paths/~1iam~1v2~1certificate-authorities/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_iam_v2_certificate_authority: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1certificate-authorities/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_iam_v2_certificate_authority: + operation: + $ref: '#/paths/~1iam~1v2~1certificate-authorities~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_iam_v2_certificate_authority: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1iam~1v2~1certificate-authorities~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_iam_v2_certificate_authority: + operation: + $ref: '#/paths/~1iam~1v2~1certificate-authorities~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/certificate_authorities/methods/get_iam_v2_certificate_authority + - $ref: >- + #/components/x-stackQL-resources/certificate_authorities/methods/list_iam_v2_certificate_authorities + insert: + - $ref: >- + #/components/x-stackQL-resources/certificate_authorities/methods/create_iam_v2_certificate_authority + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/certificate_authorities/methods/delete_iam_v2_certificate_authority + replace: + - $ref: >- + #/components/x-stackQL-resources/certificate_authorities/methods/update_iam_v2_certificate_authority + certificate_identity_pools: + id: confluent.iam.certificate_identity_pools + name: certificate_identity_pools + title: Certificate Identity Pools + methods: + list_iam_v2_certificate_identity_pools: + operation: + $ref: >- + #/paths/~1iam~1v2~1certificate-authorities~1{certificate_authority_id}~1identity-pools/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_iam_v2_certificate_identity_pool: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1iam~1v2~1certificate-authorities~1{certificate_authority_id}~1identity-pools/post + response: + mediaType: application/json + openAPIDocKey: '201' + get_iam_v2_certificate_identity_pool: + operation: + $ref: >- + #/paths/~1iam~1v2~1certificate-authorities~1{certificate_authority_id}~1identity-pools~1{id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_iam_v2_certificate_identity_pool: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1iam~1v2~1certificate-authorities~1{certificate_authority_id}~1identity-pools~1{id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + delete_iam_v2_certificate_identity_pool: + operation: + $ref: >- + #/paths/~1iam~1v2~1certificate-authorities~1{certificate_authority_id}~1identity-pools~1{id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/certificate_identity_pools/methods/get_iam_v2_certificate_identity_pool + - $ref: >- + #/components/x-stackQL-resources/certificate_identity_pools/methods/list_iam_v2_certificate_identity_pools + insert: + - $ref: >- + #/components/x-stackQL-resources/certificate_identity_pools/methods/create_iam_v2_certificate_identity_pool + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/certificate_identity_pools/methods/delete_iam_v2_certificate_identity_pool + replace: + - $ref: >- + #/components/x-stackQL-resources/certificate_identity_pools/methods/update_iam_v2_certificate_identity_pool +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/kafka.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/kafka.yaml new file mode 100644 index 0000000..2057a1b --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/kafka.yaml @@ -0,0 +1,6279 @@ +openapi: 3.0.0 +info: + title: kafka API + description: confluent kafka API + version: 1.0.0 +paths: + /kafka/v3/clusters/{cluster_id}: + get: + summary: Get Cluster + operationId: getKafkaCluster + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Return the Kafka cluster with the specified ``cluster_id``. + tags: + - Cluster (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetClusterResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/acls:batch: + post: + summary: Batch Create ACLs + operationId: batchCreateKafkaAcls + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Create ACLs. + tags: + - ACL (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/BatchCreateAclRequest' + responses: + '201': + description: Created + '400': + $ref: '#/components/responses/BadRequestErrorResponse_CreateAcls' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/acls: + get: + summary: List ACLs + operationId: getKafkaAcls + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + - When calling `/acls` without the `principal` parameter, service + accounts are returned in numeric ID format (e.g., `User:12345`). + - To retrieve service accounts in the `sa-xxx` format, use + `/acls?principal=UserV2:*`. + - The `principal` parameter supports both legacy `User:` format and + new `UserV2:` format for service accounts. + Return a list of ACLs that match the search criteria. + tags: + - ACL (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/AclResourceType' + - $ref: '#/components/parameters/AclResourceName' + - $ref: '#/components/parameters/AclPatternType' + - $ref: '#/components/parameters/AclPrincipal' + - $ref: '#/components/parameters/AclHost' + - $ref: '#/components/parameters/AclOperation' + - $ref: '#/components/parameters/AclPermission' + responses: + '200': + $ref: '#/components/responses/SearchAclsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + post: + summary: Create an ACL + operationId: createKafkaAcls + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Create an ACL. + tags: + - ACL (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/CreateAclRequest' + responses: + '201': + description: Created + '400': + $ref: '#/components/responses/BadRequestErrorResponse_CreateAcls' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Delete ACLs + operationId: deleteKafkaAcls + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Delete the ACLs that match the search criteria. + tags: + - ACL (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/AclResourceTypeRequired' + - $ref: '#/components/parameters/AclResourceName' + - $ref: '#/components/parameters/AclPatternTypeRequired' + - $ref: '#/components/parameters/AclPrincipal' + - $ref: '#/components/parameters/AclHost' + - $ref: '#/components/parameters/AclOperationRequired' + - $ref: '#/components/parameters/AclPermissionRequired' + responses: + '200': + $ref: '#/components/responses/DeleteAclsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse_DeleteAcls' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/broker-configs: + get: + summary: List Dynamic Broker Configs + operationId: listKafkaClusterConfigs + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Return a list of dynamic cluster-wide broker configuration parameters + for the specified Kafka + + cluster. Returns an empty list if there are no dynamic cluster-wide + broker configuration parameters. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListClusterConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/broker-configs:alter: + post: + summary: Batch Alter Dynamic Broker Configs + operationId: updateKafkaClusterConfigs + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Update or delete a set of dynamic cluster-wide broker configuration + parameters. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterClusterConfigBatchRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/broker-configs/{name}: + get: + summary: Get Dynamic Broker Config + operationId: getKafkaClusterConfig + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Return the dynamic cluster-wide broker configuration parameter specified + by ``name``. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetClusterConfigResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + put: + summary: Update Dynamic Broker Config + operationId: updateKafkaClusterConfig + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Update the dynamic cluster-wide broker configuration parameter specified + by ``name``. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/UpdateClusterConfigRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Reset Dynamic Broker Config + operationId: deleteKafkaClusterConfig + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Reset the configuration parameter specified by ``name`` to its + + default value by deleting a dynamic cluster-wide configuration. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConfigName' + /kafka/v3/clusters/{cluster_id}/consumer-groups: + get: + summary: List Consumer Groups + operationId: listKafkaConsumerGroups + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Return the list of consumer groups that belong to the specified + + Kafka cluster. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListConsumerGroupsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}: + get: + summary: Get Consumer Group + operationId: getKafkaConsumerGroup + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Return the consumer group specified by the ``consumer_group_id``. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetConsumerGroupResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers: + get: + summary: List Consumers + operationId: listKafkaConsumers + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Return a list of consumers that belong to the specified consumer + + group. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListConsumersResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary: + get: + summary: Get Consumer Group Lag Summary + operationId: getKafkaConsumerGroupLagSummary + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Available in dedicated clusters + only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) + + + Return the maximum and total lag of the consumers belonging to the + + specified consumer group. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetConsumerGroupLagSummaryResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags: + get: + summary: List Consumer Lags + operationId: listKafkaConsumerLags + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Available in dedicated clusters + only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) + + + Return a list of consumer lags of the consumers belonging to the + + specified consumer group. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListConsumerLagsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id}: + get: + summary: Get Consumer Lag + operationId: getKafkaConsumerLag + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Available in dedicated clusters + only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) + + + Return the consumer lag on a partition with the given `partition_id`. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetConsumerLagResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/PartitionId' + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id}: + get: + summary: Get Consumer + operationId: getKafkaConsumer + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Return the consumer specified by the ``consumer_id``. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetConsumerResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + - $ref: '#/components/parameters/ConsumerId' + /kafka/v3/clusters/{cluster_id}/topics: + get: + summary: List Topics + operationId: listKafkaTopics + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Return the list of topics that belong to the specified Kafka cluster. + tags: + - Topic (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListTopicsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + post: + summary: Create Topic + operationId: createKafkaTopic + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Create a topic. + + Also supports a dry-run mode that only validates whether the topic + creation would succeed + + if the ``validate_only`` request property is explicitly specified and + set to true. Note that + + when dry-run mode is being used the response status would be 200 OK + instead of 201 Created. + tags: + - Topic (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/CreateTopicRequest' + responses: + '200': + $ref: '#/components/responses/CreateTopicResponse' + '201': + $ref: '#/components/responses/CreateTopicResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse_CreateTopic' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}: + get: + summary: Get Topic + operationId: getKafkaTopic + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Return the topic with the given `topic_name`. + tags: + - Topic (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/IncludeAuthorizedOperations' + responses: + '200': + $ref: '#/components/responses/GetTopicResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + patch: + summary: Update Partition Count + operationId: updatePartitionCountKafkaTopic + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Increase the number of partitions for a topic. To update other topic + + configurations, see + https://docs.confluent.io/cloud/current/api.html#tag/Configs-(v3)/operation/updateKafkaTopicConfig. + tags: + - Topic (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePartitionCountRequestData' + responses: + '200': + $ref: '#/components/responses/GetTopicResponse' + '400': + $ref: >- + #/components/responses/BadRequestErrorResponse_UpdatePartitionCountTopic + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Delete Topic + operationId: deleteKafkaTopic + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Delete the topic with the given `topic_name`. + tags: + - Topic (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs: + get: + summary: List Topic Configs + operationId: listKafkaTopicConfigs + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Return the list of configuration parameters that belong to the specified + topic. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListTopicConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs:alter: + post: + summary: Batch Alter Topic Configs + operationId: updateKafkaTopicConfigBatch + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Update or delete a set of topic configuration parameters. + + Also supports a dry-run mode that only validates whether the operation + would succeed if the + + ``validate_only`` request property is explicitly specified and set to + true. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterTopicConfigBatchRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name}: + get: + summary: Get Topic Config + operationId: getKafkaTopicConfig + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Return the configuration parameter with the given `name`. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetTopicConfigResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + put: + summary: Update Topic Config + operationId: updateKafkaTopicConfig + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Update the configuration parameter with given `name`. To update the + + number of partitions, see + + https://docs.confluent.io/cloud/current/api.html#tag/Topic-(v3)/operation/updatePartitionCountKafkaTopic. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/UpdateTopicConfigRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Reset Topic Config + operationId: deleteKafkaTopicConfig + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Reset the configuration parameter with given `name` to its default + value. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/ConfigName' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions: + get: + summary: List Partitions + operationId: listKafkaPartitions + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Return the list of partitions that belong to the specified topic. + tags: + - Partition (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListPartitionsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}: + get: + summary: Get Partition + operationId: getKafkaPartition + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Return the partition with the given `partition_id`. + tags: + - Partition (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetPartitionResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/PartitionId' + /kafka/v3/clusters/{cluster_id}/topics/-/configs: + get: + summary: List All Topic Configs + operationId: listKafkaAllTopicConfigs + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Return the list of configuration parameters for all topics hosted by the + specified + + cluster. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListTopicConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/records: + post: + summary: Produce Records + operationId: produceRecord + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Produce records to the given topic, returning delivery reports for each + + record produced. This API can be used in streaming mode by setting + + "Transfer-Encoding: chunked" header. For as long as the connection is + + kept open, the server will keep accepting records. Records are streamed + + to and from the server as Concatenated JSON. For each record sent to the + + server, the server will asynchronously send back a delivery report, in + + the same order, each with its own error_code. An error_code of 200 + + indicates success. The HTTP status code will be HTTP 200 OK as long as + + the connection is successfully established. To identify records that + + have encountered an error, check the error_code of each delivery report. + + + Note that the cluster_id is validated only when running in Confluent + Cloud. + + + This API currently does not support Schema Registry integration. Sending + + schemas is not supported. Only BINARY, JSON, and STRING formats are + + supported. + tags: + - Records (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/ProduceRequest' + responses: + '200': + $ref: '#/components/responses/ProduceResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse_ProduceRecords' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '413': + $ref: '#/components/responses/RequestEntityTooLargeErrorResponse' + '415': + $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse' + '422': + $ref: '#/components/responses/UnprocessableEntity_ProduceRecord' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + /kafka/v3/clusters/{cluster_id}/links: + get: + summary: List all cluster links in the dest cluster + operationId: listKafkaLinks + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + ``link_id`` in ``ListLinksResponseData`` is deprecated and may be + removed in a future release. Use the new ``cluster_link_id`` instead. + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListLinksResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + post: + summary: Create a cluster link + operationId: createKafkaLink + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Cluster link creation requires source cluster security configurations in + + the configs JSON section of the data request payload. + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/QueryParamLinkName' + - $ref: '#/components/parameters/ValidateOnly' + - $ref: '#/components/parameters/ValidateLink' + requestBody: + $ref: '#/components/requestBodies/CreateLinkRequest' + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/links/{link_name}: + get: + summary: Describe the cluster link + operationId: getKafkaLink + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + ``link_id`` in ``ListLinksResponseData`` is deprecated and may be + removed in a future release. Use the new ``cluster_link_id`` instead. + tags: + - Cluster Linking (v3) + parameters: + - $ref: '#/components/parameters/IncludeTasks' + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetLinkResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Delete the cluster link + operationId: deleteKafkaLink + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/Force' + - $ref: '#/components/parameters/ValidateOnly' + responses: + '200': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/default-configs: + get: + summary: List New Topic Default Configs + operationId: listKafkaDefaultTopicConfigs + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + List the default configuration parameters used if the topic were to be + newly created. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListTopicConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs: + get: + summary: List all configs of the cluster link + operationId: listKafkaLinkConfigs + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListLinkConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name}: + get: + summary: Describe the config under the cluster link + operationId: getKafkaLinkConfigs + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetLinkConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + put: + summary: Alter the config under the cluster link + operationId: updateKafkaLinkConfig + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/UpdateLinkConfigRequest' + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Reset the given config to default value + operationId: deleteKafkaLinkConfig + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/LinkConfigName' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs:alter: + put: + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Batch Alter Cluster Link Configs + operationId: updateKafkaLinkConfigBatch + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/ValidateOnly' + requestBody: + $ref: '#/components/requestBodies/AlterLinkConfigBatchRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + summary: Batch Alter Cluster Link Configs + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors: + post: + summary: Create a mirror topic + operationId: createKafkaMirrorTopic + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Create a topic in the destination cluster mirroring a topic in + + the source cluster + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/CreateMirrorTopicRequest' + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + get: + summary: List mirror topics + operationId: listKafkaMirrorTopicsUnderLink + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + List all mirror topics under the link + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/MirrorTopicStatus' + responses: + '200': + $ref: '#/components/responses/ListMirrorTopicsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + /kafka/v3/clusters/{cluster_id}/links/-/mirrors: + get: + summary: List mirror topics + operationId: listKafkaMirrorTopics + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + List all mirror topics in the cluster + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/MirrorTopicStatus' + responses: + '200': + $ref: '#/components/responses/ListMirrorTopicsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors/{mirror_topic_name}: + get: + summary: Describe the mirror topic + operationId: readKafkaMirrorTopic + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + parameters: + - $ref: '#/components/parameters/IncludeStateTransitionErrors' + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/DescribeMirrorTopicResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/MirrorTopicName' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:promote: + post: + summary: Promote the mirror topics + operationId: updateKafkaMirrorTopicsPromote + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:failover: + post: + summary: Failover the mirror topics + operationId: updateKafkaMirrorTopicsFailover + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:pause: + post: + summary: Pause the mirror topics + operationId: updateKafkaMirrorTopicsPause + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:resume: + post: + summary: Resume the mirror topics + operationId: updateKafkaMirrorTopicsResume + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-start-mirror: + post: + summary: Reverse the local mirror topic and start the remote mirror topic + operationId: updateKafkaMirrorTopicsReverseAndStartMirror + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-pause-mirror: + post: + summary: Reverse the local mirror topic and Pause the remote mirror topic + operationId: updateKafkaMirrorTopicsReverseAndPauseMirror + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:truncate-and-restore: + post: + summary: >- + Truncates the local topic to the remote stopped mirror log end offsets + and restores mirroring to the local topic to mirror from the remote + topic + operationId: updateKafkaMirrorTopicsTruncateAndRestoreMirror + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/IncludePartitionLevelTruncationData' + - $ref: '#/components/parameters/ValidateOnly' + /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs: + get: + summary: List all configs of the group + operationId: listKafkaGroupConfigs + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + List all configurations for the specified group. This API supports + consumer groups, share groups, and streams groups. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListGroupConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name}: + get: + summary: Get group config + operationId: getKafkaGroupConfig + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Get the configuration with the specified name for the specified group. + This API supports consumer groups, share groups, and streams groups. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetGroupConfigResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + put: + summary: Update group config + operationId: updateKafkaGroupConfig + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Update the configuration with the specified name for the specified + group. This API supports consumer groups, share groups, and streams + groups. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/UpdateGroupConfigRequest' + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Delete group config + operationId: deleteKafkaGroupConfig + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Delete the dynamic configuration override with the specified name for + the specified group. After deletion, the default group configuration + will be applied. This API supports consumer groups, share groups, and + streams groups. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConfigName' + /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs:alter: + post: + summary: Batch Alter Group Configs + operationId: updateKafkaGroupConfigBatch + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Batch alter configurations for the specified group. This API supports + consumer groups, share groups, and streams groups. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/ValidateOnly' + requestBody: + $ref: '#/components/requestBodies/AlterGroupConfigBatchRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' +components: + schemas: + UpdatePartitionCountRequestData: + type: object + required: + - partitions_count + properties: + partitions_count: + type: integer + format: int32 + ClusterData: + type: object + required: + - kind + - metadata + - cluster_id + - acls + - brokers + - broker_configs + - consumer_groups + - topics + - partition_reassignments + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + controller: + $ref: '#/components/schemas/Relationship' + acls: + $ref: '#/components/schemas/Relationship' + brokers: + $ref: '#/components/schemas/Relationship' + broker_configs: + $ref: '#/components/schemas/Relationship' + consumer_groups: + $ref: '#/components/schemas/Relationship' + topics: + $ref: '#/components/schemas/Relationship' + partition_reassignments: + $ref: '#/components/schemas/Relationship' + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + CreateAclRequestDataList: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/CreateAclRequestData' + AclResourceType: + type: string + enum: + - UNKNOWN + - ANY + - TOPIC + - GROUP + - CLUSTER + - TRANSACTIONAL_ID + - DELEGATION_TOKEN + AclPatternType: + type: string + x-extensible-enum: + - UNKNOWN + - ANY + - MATCH + - LITERAL + - PREFIXED + AclOperation: + type: string + x-extensible-enum: + - UNKNOWN + - ANY + - ALL + - READ + - WRITE + - CREATE + - DELETE + - ALTER + - DESCRIBE + - CLUSTER_ACTION + - DESCRIBE_CONFIGS + - ALTER_CONFIGS + - IDEMPOTENT_WRITE + AclPermission: + type: string + x-extensible-enum: + - UNKNOWN + - ANY + - DENY + - ALLOW + AclDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/AclData' + CreateAclRequestData: + type: object + required: + - resource_type + - resource_name + - pattern_type + - principal + - host + - operation + - permission + properties: + resource_type: + $ref: '#/components/schemas/AclResourceType' + resource_name: + type: string + pattern_type: + $ref: '#/components/schemas/AclPatternType' + principal: + type: string + host: + type: string + operation: + $ref: '#/components/schemas/AclOperation' + permission: + $ref: '#/components/schemas/AclPermission' + AclData: + type: object + required: + - kind + - metadata + - cluster_id + - resource_type + - resource_name + - pattern_type + - principal + - host + - operation + - permission + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + resource_type: + $ref: '#/components/schemas/AclResourceType' + resource_name: + type: string + pattern_type: + $ref: '#/components/schemas/AclPatternType' + principal: + type: string + host: + type: string + operation: + $ref: '#/components/schemas/AclOperation' + permission: + $ref: '#/components/schemas/AclPermission' + ClusterConfigDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ClusterConfigData' + AlterConfigBatchRequestData: + type: object + required: + - data + properties: + data: + type: array + items: + type: object + required: + - name + properties: + name: + type: string + value: + type: string + nullable: true + operation: + type: string + x-extensible-enum: + - SET + - DELETE + nullable: true + validate_only: + type: boolean + ClusterConfigData: + type: object + required: + - kind + - metadata + - cluster_id + - name + - is_default + - is_read_only + - is_sensitive + - source + - synonyms + - config_type + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + name: + type: string + value: + type: string + nullable: true + is_default: + type: boolean + is_read_only: + type: boolean + is_sensitive: + type: boolean + source: + $ref: '#/components/schemas/ConfigSource' + synonyms: + type: array + items: + $ref: '#/components/schemas/ConfigSynonymData' + config_type: + $ref: '#/components/schemas/ClusterConfigType' + UpdateConfigRequestData: + type: object + properties: + value: + type: string + nullable: true + ConsumerGroupDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ConsumerGroupData' + ConsumerGroupData: + type: object + required: + - kind + - metadata + - cluster_id + - consumer_group_id + - is_simple + - partition_assignor + - state + - type + - is_mixed_consumer_group + - coordinator + - consumers + - lag_summary + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + consumer_group_id: + type: string + is_simple: + type: boolean + partition_assignor: + type: string + state: + $ref: '#/components/schemas/ConsumerGroupState' + type: + $ref: '#/components/schemas/ConsumerGroupType' + is_mixed_consumer_group: + type: boolean + coordinator: + $ref: '#/components/schemas/Relationship' + consumers: + $ref: '#/components/schemas/Relationship' + lag_summary: + $ref: '#/components/schemas/Relationship' + ConsumerDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ConsumerData' + ConsumerGroupLagSummaryData: + type: object + required: + - kind + - metadata + - cluster_id + - consumer_group_id + - max_lag_consumer_id + - max_lag_client_id + - max_lag_topic_name + - max_lag_partition_id + - max_lag + - total_lag + - max_lag_consumer + - max_lag_partition + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + consumer_group_id: + type: string + max_lag_consumer_id: + type: string + max_lag_instance_id: + type: string + nullable: true + max_lag_client_id: + type: string + max_lag_topic_name: + type: string + max_lag_partition_id: + type: integer + max_lag: + type: integer + format: int64 + total_lag: + type: integer + format: int64 + max_lag_consumer: + $ref: '#/components/schemas/Relationship' + max_lag_partition: + $ref: '#/components/schemas/Relationship' + ConsumerLagDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ConsumerLagData' + ConsumerLagData: + type: object + required: + - kind + - metadata + - cluster_id + - consumer_group_id + - topic_name + - partition_id + - current_offset + - log_end_offset + - lag + - consumer_id + - client_id + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + consumer_group_id: + type: string + topic_name: + type: string + partition_id: + type: integer + current_offset: + type: integer + format: int64 + log_end_offset: + type: integer + format: int64 + lag: + type: integer + format: int64 + consumer_id: + type: string + instance_id: + type: string + nullable: true + client_id: + type: string + ConsumerData: + type: object + required: + - kind + - metadata + - cluster_id + - consumer_group_id + - consumer_id + - client_id + - assignments + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + consumer_group_id: + type: string + consumer_id: + type: string + instance_id: + type: string + nullable: true + client_id: + type: string + assignments: + $ref: '#/components/schemas/Relationship' + TopicDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/TopicData' + CreateTopicRequestData: + type: object + required: + - topic_name + properties: + topic_name: + type: string + partitions_count: + type: integer + replication_factor: + type: integer + configs: + type: array + items: + type: object + required: + - name + properties: + name: + type: string + value: + type: string + nullable: true + validate_only: + type: boolean + TopicData: + type: object + required: + - kind + - metadata + - cluster_id + - topic_name + - is_internal + - replication_factor + - partitions_count + - partitions + - configs + - partition_reassignments + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + topic_name: + type: string + is_internal: + type: boolean + replication_factor: + type: integer + partitions_count: + type: integer + partitions: + $ref: '#/components/schemas/Relationship' + configs: + $ref: '#/components/schemas/Relationship' + partition_reassignments: + $ref: '#/components/schemas/Relationship' + authorized_operations: + $ref: '#/components/schemas/AuthorizedOperations' + TopicConfigDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/TopicConfigData' + TopicConfigData: + type: object + required: + - kind + - metadata + - cluster_id + - name + - is_default + - is_read_only + - is_sensitive + - source + - synonyms + - topic_name + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + name: + type: string + value: + type: string + nullable: true + is_default: + type: boolean + is_read_only: + type: boolean + is_sensitive: + type: boolean + source: + $ref: '#/components/schemas/ConfigSource' + synonyms: + type: array + items: + $ref: '#/components/schemas/ConfigSynonymData' + topic_name: + type: string + PartitionDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/PartitionData' + PartitionData: + type: object + required: + - kind + - metadata + - cluster_id + - topic_name + - partition_id + - replicas + - reassignment + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + topic_name: + type: string + partition_id: + type: integer + leader: + $ref: '#/components/schemas/Relationship' + replicas: + $ref: '#/components/schemas/Relationship' + reassignment: + $ref: '#/components/schemas/Relationship' + ProduceRequest: + type: object + properties: + partition_id: + type: integer + nullable: true + format: int32 + headers: + type: array + items: + $ref: '#/components/schemas/ProduceRequestHeader' + key: + $ref: '#/components/schemas/ProduceRequestData' + value: + $ref: '#/components/schemas/ProduceRequestData' + timestamp: + type: string + format: date-time + nullable: true + ProduceResponse: + type: object + required: + - error_code + properties: + error_code: + type: integer + format: int32 + message: + type: string + cluster_id: + type: string + topic_name: + type: string + partition_id: + type: integer + format: int32 + offset: + type: integer + format: int64 + timestamp: + type: string + format: date-time + nullable: true + key: + $ref: '#/components/schemas/ProduceResponseData' + value: + $ref: '#/components/schemas/ProduceResponseData' + ListLinksResponseDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ListLinksResponseData' + CreateLinkRequestData: + properties: + source_cluster_id: + type: string + destination_cluster_id: + type: string + remote_cluster_id: + description: The expected remote cluster ID. + type: string + cluster_link_id: + description: >- + The expected cluster link ID. Can be provided when creating the + second side of a bidirectional link for validating the link ID is as + expected. If it's not provided, it's inferred from the remote + cluster. + type: string + configs: + items: + $ref: '#/components/schemas/ConfigData' + type: array + type: object + ListLinksResponseData: + type: object + required: + - kind + - metadata + - link_name + - cluster_link_id + - topic_names + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + source_cluster_id: + type: string + nullable: true + destination_cluster_id: + type: string + nullable: true + remote_cluster_id: + type: string + nullable: true + link_name: + type: string + link_id: + type: string + deprecated: true + cluster_link_id: + type: string + topic_names: + type: array + items: + type: string + link_error: + $ref: '#/components/schemas/LinkError' + nullable: true + link_error_message: + type: string + nullable: true + link_state: + $ref: '#/components/schemas/LinkState' + nullable: true + tasks: + nullable: true + type: array + items: + $ref: '#/components/schemas/LinkTask' + category_counts: + nullable: true + type: array + items: + $ref: '#/components/schemas/LinkCategory' + ListLinkConfigsResponseDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ListLinkConfigsResponseData' + ListLinkConfigsResponseData: + type: object + required: + - kind + - metadata + - cluster_id + - name + - value + - is_default + - is_read_only + - is_sensitive + - source + - synonyms + - link_name + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + name: + type: string + value: + type: string + is_default: + type: boolean + is_read_only: + type: boolean + is_sensitive: + type: boolean + source: + type: string + x-extensible-enum: + - DYNAMIC_CLUSTER_LINK_CONFIG + synonyms: + type: array + items: + type: string + link_name: + type: string + UpdateLinkConfigRequestData: + properties: + value: + type: string + required: + - value + type: object + CreateMirrorTopicRequestData: + properties: + source_topic_name: + type: string + mirror_topic_name: + type: string + replication_factor: + type: integer + configs: + type: array + items: + $ref: '#/components/schemas/ConfigData' + required: + - source_topic_name + type: object + MirrorTopicStatus: + enum: + - ACTIVE + - FAILED + - LINK_FAILED + - LINK_PAUSED + - PAUSED + - PENDING_STOPPED + - SOURCE_UNAVAILABLE + - STOPPED + - PENDING_MIRROR + - PENDING_SYNCHRONIZE + - PENDING_SETUP_FOR_RESTORE + - PENDING_RESTORE + type: string + ListMirrorTopicsResponseDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ListMirrorTopicsResponseData' + ListMirrorTopicsResponseData: + type: object + required: + - kind + - metadata + - link_name + - mirror_topic_name + - source_topic_name + - num_partitions + - mirror_lags + - mirror_status + - state_time_ms + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + link_name: + type: string + mirror_topic_name: + type: string + source_topic_name: + type: string + num_partitions: + type: integer + mirror_lags: + $ref: '#/components/schemas/MirrorLags' + mirror_status: + $ref: '#/components/schemas/MirrorTopicStatus' + mirror_topic_error: + $ref: '#/components/schemas/MirrorTopicError' + state_time_ms: + type: integer + format: int64 + mirror_state_transition_errors: + type: array + items: + $ref: '#/components/schemas/LinkTaskError' + AlterMirrorsRequestData: + properties: + mirror_topic_names: + description: The mirror topics specified as a list of topic names. + type: array + items: + type: string + mirror_topic_name_pattern: + description: The mirror topics specified as a pattern. + type: string + type: object + AlterMirrorStatusResponseDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/AlterMirrorStatusResponseData' + GroupConfigDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/GroupConfigData' + GroupConfigData: + type: object + required: + - kind + - metadata + - cluster_id + - group_id + - name + - is_default + - is_read_only + - is_sensitive + - source + - synonyms + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + group_id: + type: string + name: + type: string + value: + type: string + nullable: true + is_default: + type: boolean + is_read_only: + type: boolean + is_sensitive: + type: boolean + source: + $ref: '#/components/schemas/ConfigSource' + synonyms: + type: array + items: + $ref: '#/components/schemas/ConfigSynonymData' + UpdateGroupConfigRequestData: + properties: + value: + type: string + required: + - value + type: object + Resource: + type: object + required: + - kind + - metadata + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + Relationship: + type: object + required: + - related + properties: + related: + type: string + ResourceCollection: + type: object + required: + - kind + - metadata + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + AbstractConfigData: + type: object + required: + - kind + - metadata + - cluster_id + - name + - is_default + - is_read_only + - is_sensitive + - source + - synonyms + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + name: + type: string + value: + type: string + nullable: true + is_default: + type: boolean + is_read_only: + type: boolean + is_sensitive: + type: boolean + source: + $ref: '#/components/schemas/ConfigSource' + synonyms: + type: array + items: + $ref: '#/components/schemas/ConfigSynonymData' + ClusterConfigType: + type: string + x-extensible-enum: + - BROKER + ConsumerGroupState: + type: string + x-extensible-enum: + - UNKNOWN + - PREPARING_REBALANCE + - COMPLETING_REBALANCE + - ASSIGNING + - RECONCILING + - STABLE + - DEAD + - EMPTY + ConsumerGroupType: + type: string + x-extensible-enum: + - UNKNOWN + - CLASSIC + - CONSUMER + - SHARE + AuthorizedOperations: + type: array + items: + type: string + x-extensible-enum: + - UNKNOWN + - ALL + - READ + - WRITE + - CREATE + - DELETE + - ALTER + - DESCRIBE + - CLUSTER_ACTION + - DESCRIBE_CONFIGS + - ALTER_CONFIGS + - IDEMPOTENT_WRITE + ProduceRequestHeader: + type: object + required: + - name + properties: + name: + type: string + value: + type: string + format: byte + nullable: true + ProduceRequestData: + type: object + properties: + type: + type: string + x-extensible-enum: + - BINARY + - JSON + - STRING + data: + $ref: '#/components/schemas/AnyValue' + nullable: true + ProduceResponseData: + type: object + required: + - size + - type + properties: + size: + type: integer + type: + type: string + x-extensible-enum: + - BINARY + - JSON + - STRING + nullable: true + ConfigData: + example: + name: name + value: value + properties: + name: + type: string + value: + nullable: true + type: string + required: + - name + - value + type: object + LinkError: + type: string + x-extensible-enum: + - UNKNOWN + - NO_ERROR + - AUTHENTICATION_ERROR + - UNRESOLVABLE_BOOTSTRAP_ERROR + - INVALID_BOOTSTRAP_INTERNAL_ENDPOINT_ERROR + - BOOTSTRAP_TCP_CONNECTION_FAILED_ERROR + - TIMEOUT_ERROR + LinkState: + type: string + x-extensible-enum: + - ACTIVE + - FAILED + - UNAVAILABLE + - PAUSED + - UNKNOWN + LinkTask: + type: object + required: + - task_name + - state + - errors + properties: + task_name: + type: string + state: + $ref: '#/components/schemas/LinkTaskState' + errors: + type: array + items: + $ref: '#/components/schemas/LinkTaskError' + LinkCategory: + type: object + required: + - state_category + - count + properties: + state_category: + $ref: '#/components/schemas/StateCategory' + count: + type: integer + format: int32 + example: 123 + MirrorLags: + type: array + items: + $ref: '#/components/schemas/MirrorLag' + MirrorTopicError: + type: string + x-extensible-enum: + - UNKNOWN + - NOT_SET + - NO_ERROR + - SOURCE_TOPIC_MAY_BE_DELETED + - SOURCE_TOPIC_ID_CHANGED + - SOURCE_PARTITIONS_DECREASED + - NON_MONOTONIC_LOG_APPEND_EPOCH + - UNEXPECTED_TRUNCATION + - UNSUPPORTED_MESSAGE_FORMAT + - NON_MONOTONIC_SOURCE_EPOCH + - ILLEGAL_STATE + - UNSUPPORTED_MIRROR_STATE + LinkTaskError: + type: object + required: + - error_code + - error_message + properties: + error_code: + type: string + error_message: + type: string + AlterMirrorStatusResponseData: + type: object + required: + - kind + - metadata + - mirror_topic_name + - error_message + - error_code + - mirror_lags + - messages_truncated + - partition_level_truncation_data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + mirror_topic_name: + type: string + error_message: + type: string + nullable: true + error_code: + type: integer + nullable: true + mirror_lags: + $ref: '#/components/schemas/MirrorLags' + messages_truncated: + type: integer + format: int64 + nullable: true + partition_level_truncation_data: + $ref: '#/components/schemas/PartitionLevelTruncationDataList' + nullable: true + ConfigSource: + type: string + x-extensible-enum: + - DYNAMIC_CLUSTER_LINK_CONFIG + - DYNAMIC_TOPIC_CONFIG + - DYNAMIC_BROKER_LOGGER_CONFIG + - DYNAMIC_BROKER_CONFIG + - DYNAMIC_DEFAULT_BROKER_CONFIG + - STATIC_BROKER_CONFIG + - DEFAULT_CONFIG + - UNKNOWN + ConfigSynonymData: + type: object + required: + - name + - source + properties: + name: + type: string + value: + type: string + nullable: true + source: + $ref: '#/components/schemas/ConfigSource' + ResourceMetadata: + type: object + required: + - self + properties: + self: + type: string + resource_name: + type: string + nullable: true + ResourceCollectionMetadata: + type: object + required: + - self + properties: + self: + type: string + next: + type: string + nullable: true + AnyValue: + nullable: true + LinkTaskState: + type: string + x-extensible-enum: + - UNKNOWN + - ACTIVE + - IN_ERROR + - NOT_CONFIGURED + - LINK_FAILED + - LINK_UNAVAILABLE + - LINK_PAUSED + StateCategory: + type: string + x-extensible-enum: + - PAUSED + - IN_ERROR + - PENDING + - ACTIVE + - NOT_APPLICABLE + MirrorLag: + type: object + required: + - partition + - lag + - last_source_fetch_offset + properties: + partition: + type: integer + lag: + type: integer + format: int64 + last_source_fetch_offset: + type: integer + format: int64 + PartitionLevelTruncationDataList: + type: array + items: + $ref: '#/components/schemas/PartitionLevelTruncationData' + PartitionLevelTruncationData: + type: object + required: + - partition_id + - offset_truncated_to + - messages_truncated + properties: + partition_id: + type: integer + offset_truncated_to: + type: integer + format: int64 + messages_truncated: + type: integer + format: int64 + responses: + GetClusterResponse: + description: The Kafka cluster. + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterData' + example: + kind: KafkaCluster + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1 + resource_name: crn:///kafka=cluster-1 + cluster_id: cluster-1 + controller: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + acls: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls + brokers: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers + broker_configs: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs + consumer_groups: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups + topics: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics + partition_reassignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/-/partitions/-/reassignment + BadRequestErrorResponse: + description: >- + Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + bad_request_cannot_deserialize: + description: >- + Thrown when trying to deserialize an integer from non-integer + data. + value: + error_code: 400 + message: >- + Cannot deserialize value of type `java.lang.Integer` from + String "A": not a valid `java.lang.Integer` value + unsupported_version_exception: + description: >- + Thrown when the version of this API is not supported in the + underlying Kafka cluster. + value: + error_code: 40035 + message: >- + The version of this API is not supported in the underlying + Kafka cluster. + UnauthorizedErrorResponse: + description: >- + Indicates a client authentication error. Kafka authentication failures + will contain error code 40101 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + kafka_authentication_failed: + description: >- + Thrown when using Basic authentication with wrong Kafka + credentials. + value: + error_code: 40101 + message: Authentication failed + ForbiddenErrorResponse: + description: >- + Indicates a client authorization error. Kafka authorization failures + will contain error code 40301 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + kafka_authorization_failed: + description: >- + Thrown when the caller is not authorized to perform the + underlying operation. + value: + error_code: 40301 + message: Request is not authorized + TooManyRequestsErrorResponse: + description: >- + Indicates that a rate limit threshold has been reached, and the client + should retry again later. + content: + text/html: + schema: + type: string + example: + description: A sample response from Jetty's DoSFilter. + value: >- + Error 429 Too Many + Requests

HTTP ERROR 429 Too Many + Requests

+ + +
URI:/v3/clusters/my-cluster
STATUS:429
MESSAGE: Too Many + Requests
SERVLET: default
+ ServerErrorResponse: + description: >- + A server-side problem that might not be addressable from the client + side. Retriable Kafka errors will contain error code 50003 in the + response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + generic_internal_server_error: + description: Thrown for generic HTTP 500 errors. + value: + error_code: 500 + message: Internal Server Error + BadRequestErrorResponse_CreateAcls: + description: >- + Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + create_acls_cluster_name_invalid: + description: >- + Thrown when creating an ACL for a CLUSTER resource specifying + the wrong resource name. + value: + error_code: 40002 + message: The only valid name for the CLUSTER resource is kafka-cluster" + SearchAclsResponse: + description: The list of ACLs. + content: + application/json: + schema: + $ref: '#/components/schemas/AclDataList' + example: + kind: KafkaAclList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?principal=User%3Aalice + data: + - kind: KafkaAcl + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=TOPIC&resource_name=topic-&pattern_type=PREFIXED&principal=User%3Aalice&host=*&operation=ALL&permission=ALLOW + cluster_id: cluster-1 + resource_type: TOPIC + resource_name: topic- + pattern_type: PREFIXED + principal: User:alice + host: '*' + operation: ALL + permission: ALLOW + - kind: KafkaAcl + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=CLUSTER&resource_name=kafka-cluster&pattern_type=LITERAL&principal=User%3Aalice&host=*&operation=DESCRIBE&permission=DENY + cluster_id: cluster-1 + resource_type: CLUSTER + resource_name: kafka-cluster + pattern_type: LITERAL + principal: User:alice + host: '*' + operation: DESCRIBE + permission: DENY + DeleteAclsResponse: + description: The list of deleted ACLs. + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/AclData' + example: + data: + - kind: KafkaAcl + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=TOPIC&resource_name=topic-&pattern_type=PREFIXED&principal=User%3Aalice&host=*&operation=ALL&permission=ALLOW + cluster_id: cluster-1 + resource_type: TOPIC + resource_name: topic- + pattern_type: PREFIXED + principal: User:alice + host: '*' + operation: ALL + permission: ALLOW + - kind: KafkaAcl + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=CLUSTER&resource_name=kafka-cluster&pattern_type=LITERAL&principal=User%3Aalice&host=*&operation=DESCRIBE&permission=DENY + cluster_id: cluster-1 + resource_type: CLUSTER + resource_name: kafka-cluster + pattern_type: LITERAL + principal: User:alice + host: '*' + operation: DESCRIBE + permission: DENY + BadRequestErrorResponse_DeleteAcls: + description: >- + Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + delete_acls_unspecified_resource_type: + description: >- + Thrown when trying to delete ACLs without specifying a valid + resource type. + value: + error_code: 400 + message: resource_type cannot be unspecified or UNKNOWN + ListClusterConfigsResponse: + description: The list of cluster configs. + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterConfigDataList' + example: + kind: KafkaClusterConfigList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs + next: null + data: + - kind: KafkaClusterConfig + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/max.connections + resource_name: crn:///kafka=cluster-1/broker-config=max.connections + cluster_id: cluster-1 + config_type: BROKER + name: max.connections + value: '1000' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_DEFAULT_BROKER_CONFIG + synonyms: + - name: max.connections + value: '1000' + source: DYNAMIC_DEFAULT_BROKER_CONFIG + - name: max.connections + value: '2147483647' + source: DEFAULT_CONFIG + - kind: KafkaClusterConfig + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type + resource_name: crn:///kafka=cluster-1/broker-config=compression.type + cluster_id: cluster-1 + config_type: BROKER + name: compression.type + value: gzip + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_DEFAULT_BROKER_CONFIG + synonyms: + - name: compression.type + value: gzip + source: DYNAMIC_DEFAULT_BROKER_CONFIG + - name: compression.type + value: producer + source: DEFAULT_CONFIG + GetClusterConfigResponse: + description: The cluster configuration parameter. + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterConfigData' + example: + kind: KafkaClusterConfig + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type + resource_name: crn:///kafka=cluster-1/broker-config=compression.type + cluster_id: cluster-1 + config_type: BROKER + name: compression.type + value: gzip + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_DEFAULT_BROKER_CONFIG + synonyms: + - name: compression.type + value: gzip + source: DYNAMIC_DEFAULT_BROKER_CONFIG + - name: compression.type + value: producer + source: DEFAULT_CONFIG + ListConsumerGroupsResponse: + description: The list of consumer groups. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerGroupDataList' + example: + kind: KafkaConsumerGroupList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups + next: null + data: + - kind: KafkaConsumerGroup + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + is_simple: false + partition_assignor: org.apache.kafka.clients.consumer.RoundRobinAssignor + state: STABLE + type: CLASSIC + is_mixed_consumer_group: false + coordinator: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + consumers: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers + lag_summary: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary + - kind: KafkaConsumerGroup + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-2 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-2 + cluster_id: cluster-1 + consumer_group_id: consumer-group-2 + is_simple: false + partition_assignor: org.apache.kafka.clients.consumer.StickyAssignor + state: PREPARING_REBALANCE + type: CLASSIC + is_mixed_consumer_group: false + coordinator: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 + consumers: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-2/consumers + lag_summary: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-2/lag-summary + - kind: KafkaConsumerGroup + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-3 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-3 + cluster_id: cluster-1 + consumer_group_id: consumer-group-3 + is_simple: false + partition_assignor: org.apache.kafka.clients.consumer.RangeAssignor + state: DEAD + type: CLASSIC + is_mixed_consumer_group: false + coordinator: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/3 + consumers: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-3/consumers + lag_summary: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-3/lag-summary + GetConsumerGroupResponse: + description: The consumer group. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerGroupData' + example: + kind: KafkaConsumerGroup + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + is_simple: false + partition_assignor: org.apache.kafka.clients.consumer.RoundRobinAssignor + state: STABLE + type: CLASSIC + is_mixed_consumer_group: false + coordinator: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + consumers: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers + lag_summary: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary + ListConsumersResponse: + description: The list of consumers. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerDataList' + example: + kind: KafkaConsumerList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers + next: null + data: + - kind: KafkaConsumer + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1 + resource_name: >- + crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-1 + instance_id: consumer-instance-1 + client_id: client-1 + assignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1/assignments + - kind: KafkaConsumer + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2 + resource_name: >- + crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-2 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-2 + instance_id: consumer-instance-2 + client_id: client-2 + assignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2/assignments + - kind: KafkaConsumer + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2 + resource_name: >- + crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-2 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-2 + instance_id: consumer-instance-2 + client_id: client-2 + assignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2/assignments + GetConsumerGroupLagSummaryResponse: + description: The max and total consumer lag in a consumer group. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerGroupLagSummaryData' + example: + kind: KafkaConsumerGroupLagSummary + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary + resource_name: >- + crn:///kafka=cluster-1/consumer-groups=consumer-group-1/lag-summary + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + max_lag_consumer_id: consumer-1 + max_lag_instance_id: consumer-instance-1 + max_lag_client_id: client-1 + max_lag_topic_name: topic-1 + max_lag_partition_id: 1 + max_lag: 100 + total_lag: 110 + max_lag_consumer: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1 + max_lag_partition: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + ListConsumerLagsResponse: + description: The list of consumer lags. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerLagDataList' + example: + kind: KafkaConsumerLagList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags + next: null + data: + - kind: KafkaConsumerLag + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/1 + resource_name: >- + crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + topic_name: topic-1 + partition_id: 1 + consumer_id: consumer-1 + instance_id: consumer-instance-1 + client_id: client-1 + current_offset: 1 + log_end_offset: 101 + lag: 100 + - kind: KafkaConsumerLag + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/2 + resource_name: >- + crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=2 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + topic_name: topic-1 + partition_id: 2 + consumer_id: consumer-2 + instance_id: consumer-instance-2 + client_id: client-2 + current_offset: 1 + log_end_offset: 11 + lag: 10 + - kind: KafkaConsumerLag + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/3 + resource_name: >- + crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=3 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + topic_name: topic-1 + partition_id: 3 + consumer_id: consumer-3 + instance_id: consumer-instance-3 + client_id: client-3 + current_offset: 1 + log_end_offset: 1 + lag: 0 + GetConsumerLagResponse: + description: The consumer lag. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerLagData' + example: + kind: KafkaConsumerLag + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/1 + resource_name: >- + crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + topic_name: topic-1 + partition_id: 1 + consumer_id: consumer-1 + instance_id: consumer-instance-1 + client_id: client-1 + current_offset: 1 + log_end_offset: 101 + lag: 100 + GetConsumerResponse: + description: The consumer. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerData' + example: + kind: KafkaConsumer + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1 + resource_name: >- + crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-1 + instance_id: consumer-instance-1 + client_id: client-1 + assignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1/assignments + ListTopicsResponse: + description: The list of topics. + content: + application/json: + schema: + $ref: '#/components/schemas/TopicDataList' + example: + kind: KafkaTopicList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics + next: null + data: + - kind: KafkaTopic + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1 + resource_name: crn:///kafka=cluster-1/topic=topic-1 + cluster_id: cluster-1 + topic_name: topic-1 + is_internal: false + replication_factor: 3 + partitions_count: 1 + partitions: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions + configs: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs + partition_reassignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/-/reassignments + - kind: KafkaTopic + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2 + resource_name: crn:///kafka=cluster-1/topic=topic-2 + cluster_id: cluster-1 + topic_name: topic-2 + is_internal: true + replication_factor: 4 + partitions_count: 1 + partitions: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions + configs: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/configs + partition_reassignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions/-/reassignments + - kind: KafkaTopic + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3 + resource_name: crn:///kafka=cluster-1/topic=topic-3 + cluster_id: cluster-1 + topic_name: topic-3 + is_internal: false + replication_factor: 5 + partitions_count: 1 + partitions: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions + configs: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/configs + partition_reassignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions/-/reassignments + CreateTopicResponse: + description: The created topic. + content: + application/json: + schema: + $ref: '#/components/schemas/TopicData' + example: + kind: KafkaTopic + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X + resource_name: crn:///kafka=cluster-1/topic=topic-X + cluster_id: cluster-1 + topic_name: topic-X + is_internal: false + replication_factor: 3 + partitions_count: 1 + partitions: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X/partitions + configs: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X/configs + partition_reassignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X/partitions/-/reassignments + BadRequestErrorResponse_CreateTopic: + description: >- + Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + create_topic_already_exists: + description: >- + Thrown when trying to create a topic with a name already used by + an existing topic. + value: + error_code: 40002 + message: Topic 'my-topic' already exists. + create_topic_replication_factor_too_large: + description: >- + Thrown when trying to create a topic with a replication factor + larger than the number of brokers. + value: + error_code: 40002 + message: 'Replication factor: 2 larger than available brokers: 1.' + GetTopicResponse: + description: The topic. + content: + application/json: + schema: + $ref: '#/components/schemas/TopicData' + example: + kind: KafkaTopic + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1 + resource_name: crn:///kafka=cluster-1/topic=topic-1 + cluster_id: cluster-1 + topic_name: topic-1 + is_internal: false + replication_factor: 3 + partitions_count: 1 + partitions: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions + configs: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs + partition_reassignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/-/reassignments + NotFoundErrorResponse: + description: >- + Indicates attempted access to an unreachable or non-existing resource + like e.g. an unknown topic or partition. GET requests to endpoints not + allowed in the accesslists will also result in this response. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + endpoint_not_found: + description: Thrown for generic HTTP 404 errors. + value: + error_code: 404 + message: HTTP 404 Not Found + cluster_not_found: + description: Thrown when using a non-existing cluster ID. + value: + error_code: 404 + message: Cluster my-cluster cannot be found. + unknown_topic_or_partition: + description: Thrown when using a non-existing topic name or partition ID. + value: + error_code: 40403 + message: This server does not host this topic-partition. + BadRequestErrorResponse_UpdatePartitionCountTopic: + description: >- + Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + topic_update_partitions_invalid: + description: >- + Thrown when trying to update the number of partitions + incorrectly. + value: + error_code: 40002 + message: Topic already has 1 partitions. + ListTopicConfigsResponse: + description: The list of cluster configs. + content: + application/json: + schema: + $ref: '#/components/schemas/TopicConfigDataList' + example: + kind: KafkaTopicConfigList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs + next: null + data: + - kind: KafkaTopicConfig + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/cleanup.policy + resource_name: crn:///kafka=cluster-1/topic=topic-1/config=cleanup.policy + cluster_id: cluster-1 + topic_name: topic-1 + name: cleanup.policy + value: compact + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_TOPIC_CONFIG + synonyms: + - name: cleanup.policy + value: compact + source: DYNAMIC_TOPIC_CONFIG + - name: cleanup.policy + value: delete + source: DEFAULT_CONFIG + - kind: KafkaTopicConfig + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type + resource_name: crn:///kafka=cluster-1/topic=topic-1/config=compression.type + cluster_id: cluster-1 + topic_name: topic-1 + name: compression.type + value: gzip + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_TOPIC_CONFIG + synonyms: + - name: compression.type + value: gzip + source: DYNAMIC_TOPIC_CONFIG + - name: compression.type + value: producer + source: DEFAULT_CONFIG + GetTopicConfigResponse: + description: The topic configuration parameter. + content: + application/json: + schema: + $ref: '#/components/schemas/TopicConfigData' + example: + kind: KafkaTopicConfig + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/compression.type + resource_name: crn:///kafka=cluster-1/topic=topic-1/config=compression.type + cluster_id: cluster-1 + topic_name: topic-1 + name: compression.type + value: gzip + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_TOPIC_CONFIG + synonyms: + - name: compression.type + value: gzip + source: DYNAMIC_TOPIC_CONFIG + - name: compression.type + value: producer + source: DEFAULT_CONFIG + ListPartitionsResponse: + description: The list of partitions. + content: + application/json: + schema: + $ref: '#/components/schemas/PartitionDataList' + example: + kind: KafkaPartitionList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions + next: null + data: + - kind: KafkaPartition + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=1 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + leader: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas/1 + replicas: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas + reassignment: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/reassignment + - kind: KafkaPartition + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=2 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 2 + leader: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/replicas/2 + replicas: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/replicas + reassignment: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/reassignment + - kind: KafkaPartition + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=3 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 3 + leader: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/replicas/3 + replicas: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/replicas + reassignment: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/reassignment + GetPartitionResponse: + description: The partition + content: + application/json: + schema: + $ref: '#/components/schemas/PartitionData' + example: + kind: KafkaPartition + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=1 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + leader: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas/1 + replicas: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas + reassignment: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/reassignment + ProduceResponse: + description: >- + The response containing a delivery report for a record produced to a + topic. In streaming mode, + + for each record sent, a separate delivery report will be returned, in + the same order, + + each with its own error_code. + content: + application/json: + schema: + $ref: '#/components/schemas/ProduceResponse' + examples: + produce_record_success: + description: The record was successfully produced to the topic. + value: + error_code: 200 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + offset: 0 + timestamp: '2021-02-05T19:14:42Z' + key: + type: BINARY + size: 7 + value: + type: JSON + size: 15 + produce_record_bad_binary_data: + description: >- + Thrown when sending a BINARY value which is not a base64-encoded + string. + value: + error_code: 400 + message: 'Bad Request: data=1 is not a base64 string.' + BadRequestErrorResponse_ProduceRecords: + description: >- + Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + header_not_base64_encoded: + description: >- + Thrown when headers in the produce-record are not base64 + encoded. + value: + error_code: 400 + message: >- + Cannot deserialize value of type `byte[]` from String "": + Unexpected end of base64-encoded String: base64 variant + 'MIME-NO-LINEFEEDS' expects padding (one or more '=' + characters) at the end. This Base64Variant might have been + incorrectly configured + RequestEntityTooLargeErrorResponse: + description: >- + This implies the client is sending a request payload that is larger than + the maximum message size the server can accept. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + produce_records_expects_json: + description: >- + Thrown by /records API if payload size exceeds the message max + size + value: + error_code: 413 + message: >- + The request included a message larger than the maximum message + size the server can accept. + UnsupportedMediaTypeErrorResponse: + description: >- + This implies the client is sending the request payload format in an + unsupported format. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + produce_records_expects_json: + description: >- + Thrown by /records API if payload format content-type doesn't + match expected application/json + value: + error_code: 415 + message: HTTP 415 Unsupported Media Type + UnprocessableEntity_ProduceRecord: + description: >- + Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + produce_record_empty_request_body: + description: Thrown when the request body is empty. + value: + error_code: 422 + message: Payload error. Request body is empty. Data is required. + ListLinksResponse: + description: A list of link names and properties + content: + application/json: + schema: + $ref: '#/components/schemas/ListLinksResponseDataList' + example: + kind: KafkaLinkDataList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links + next: null + data: + - kind: KafkaLinkData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/CIL-69l7S1CwoVNAhoQLug/links/my-new-link-1 + resource_name: null + source_cluster_id: src-cluster-id + link_name: my-new-link-1 + link_id: 7840644d-f7d8-4844-a577-a10ef3df31df + cluster_link_id: eEBkTffYSESld6EO898x3w + topic_names: + - topic-sb-1 + - topic-sb-2 + link_state: ACTIVE + - kind: KafkaLinkData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/CIL-69l7S1CwoVNAhoQLug/links/my-new-link-2 + resource_name: null + remote_cluster_id: src-cluster-id + link_name: my-new-link-2 + link_id: f749116e-f847-4bd2-b1f6-5c4e518a0678 + cluster_link_id: 90kRbvhHS9Kx9lxOUYoGeA + topic_names: + - topic-db-1 + - topic-db-2 + link_state: UNAVAILABLE + link_error: AUTHENTICATION_ERROR + link_error_message: Please check your api key and secret + - kind: KafkaLinkData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/CIL-69l7S1CwoVNAhoQLug/links/my-new-link-3 + resource_name: null + destination_cluster_id: dest-cluster-id + link_name: my-new-link-3 + link_id: 9cd1711e-a4ef-4390-a35e-dfd758d97a82 + cluster_link_id: nNFxHqTvQ5CjXt_XWNl6gg + topic_names: [] + link_state: ACTIVE + NoContentResponse: + description: Operation succeeded, no content in the response + GetLinkResponse: + description: Single link name and properties + content: + application/json: + schema: + $ref: '#/components/schemas/ListLinksResponseData' + examples: + link_at_destination_cluster: + description: Link at destination cluster + value: + kind: KafkaLinkData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/my-new-link-1 + resource_name: null + source_cluster_id: src-cluster-id + link_name: my-new-link-1 + link_id: 7840644d-f7d8-4844-a577-a10ef3df31df + cluster_link_id: eEBkTffYSESld6EO898x3w + topic_names: + - topic-db-1 + - topic-db-2 + link_at_source_cluster: + description: Link at source cluster + value: + kind: KafkaLinkData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/my-new-link-1 + resource_name: null + destination_cluster_id: dst-cluster-id + link_name: my-new-link-1 + link_id: 7840644d-f7d8-4844-a577-a10ef3df31df + cluster_link_id: eEBkTffYSESld6EO898x3w + topic_names: [] + ListLinkConfigsResponse: + description: Config name and value + content: + application/json: + schema: + $ref: '#/components/schemas/ListLinkConfigsResponseDataList' + example: + kind: KafkaLinkConfigDataList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/v-0Ce-CkTyKQol9v46LaCQ/links/link-nb-1/configs + next: null + data: + - kind: KafkaLinkConfigData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/links/my-new-link-1 + resource_name: null + cluster_id: 1Rh_4htxSuen7RYGvGmgNw + name: consumer.offset.sync.ms + value: '3825940' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_CLUSTER_LINK_CONFIG + synonyms: + - cosm + link_name: link-db-1 + - kind: KafkaLinkConfigData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/links/my-new-link-1 + resource_name: null + cluster_id: 1Rh_4htxSuen7RYGvGmgNw + name: acl.sync.ms + value: '5000' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_CLUSTER_LINK_CONFIG + synonyms: + - asm + link_name: link-db-1 + GetLinkConfigsResponse: + description: Config name and value + content: + application/json: + schema: + $ref: '#/components/schemas/ListLinkConfigsResponseData' + example: + kind: KafkaLinkConfigData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/links/my-new-link-1 + resource_name: null + cluster_id: 1Rh_4htxSuen7RYGvGmgNw + name: consumer.offset.sync.ms + value: '3825940' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_CLUSTER_LINK_CONFIG + synonyms: + - cosm + link_name: link-db-1 + ListMirrorTopicsResponse: + description: Metadata of mirror topics + content: + application/json: + schema: + $ref: '#/components/schemas/ListMirrorTopicsResponseDataList' + example: + kind: KafkaMirrorDataList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/link/link-1/mirrors + resource_name: crn:///kafka=cluster-1 + next: null + data: + - kind: KafkaMirrorData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/link-1/mirrors/topic-1 + resource_name: crn:///kafka=cluster-1 + link_name: link-sb-1 + resource_name: crn:///kafka=cluster-1 + mirror_topic_name: topic-1 + source_topic_name: topic-1 + num_partitions: 3 + mirror_lags: + - partition: 0 + lag: 0 + last_source_fetch_offset: 0 + - partition: 1 + lag: 10000 + last_source_fetch_offset: 1000 + - partition: 2 + lag: 40000 + last_source_fetch_offset: 12030 + mirror_status: ACTIVE + state_time_ms: 1612550939300 + - kind: KafkaMirrorData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/link-1/mirrors/topic-2 + resource_name: crn:///kafka=cluster-1 + link_name: link-sb-2 + resource_name: crn:///kafka=cluster-1 + mirror_topic_name: topic-2 + source_topic_name: topic-2 + num_partitions: 3 + mirror_lags: + - partition: 0 + lag: 0 + last_source_fetch_offset: 0 + - partition: 1 + lag: 10000 + last_source_fetch_offset: 1000 + - partition: 2 + lag: 40000 + last_source_fetch_offset: 12030 + mirror_status: STOPPED + state_time_ms: 1612551353640 + DescribeMirrorTopicResponse: + description: Metadata of the mirror topic + content: + application/json: + schema: + $ref: '#/components/schemas/ListMirrorTopicsResponseData' + example: + kind: KafkaMirrorData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/link/link-1/mirrors/topic-1 + resource_name: crn:///kafka=cluster-1 + link_name: link-sb-1 + mirror_topic_name: topic-1 + source_topic_name: topic-1 + num_partitions: 3 + mirror_lags: + - partition: 0 + lag: 0 + last_source_fetch_offset: 0 + - partition: 1 + lag: 10000 + last_source_fetch_offset: 1000 + - partition: 2 + lag: 40000 + last_source_fetch_offset: 12030 + mirror_status: ACTIVE + state_time_ms: 1612550939300 + AlterMirrorStatusResponse: + description: Mirror status alternation result + content: + application/json: + schema: + $ref: '#/components/schemas/AlterMirrorStatusResponseDataList' + example: + kind: KafkaPromoteMirror + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-1/mirrors + resource_name: crn:///kafka=cluster-1 + data: + - kind: AlterMirrorsData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/my-new-link-1/mirrors/topic-1 + resource: crn:///kafka=cluster-1 + mirror_topic_name: topic-sb + error_code: null + error_message: null + mirror_lags: + - partition: 0 + lag: 0 + last_source_fetch_offset: 0 + - partition: 1 + lag: 10000 + last_source_fetch_offset: 1000 + - partition: 2 + lag: 40000 + last_source_fetch_offset: 12030 + messages_truncated: null + partition_level_truncation_data: + - partition_id: 0 + offset_truncated_to: 10000 + messages_truncated: 10000 + - partition_id: 1 + offset_truncated_to: 40000 + messages_truncated: 12030 + - partition_id: 2 + offset_truncated_to: 20000 + messages_truncated: 20000 + - kind: AlterMirrorsData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/my-new-link-1/mirrors/topic-2 + resource: crn:///kafka=cluster-1 + mirror_topic_name: topic-2 + error_code: 400 + error_message: >- + Topic 'topic-2' has already stopped its mirror from + 'my-new-link-1' + mirror_lags: + - partition: 0 + lag: 0 + last_source_fetch_offset: 0 + - partition: 1 + lag: 10000 + last_source_fetch_offset: 1000 + - partition: 2 + lag: 40000 + last_source_fetch_offset: 12030 + messages_truncated: null + partition_level_truncation_data: + - partition_id: 0 + offset_truncated_to: 10000 + messages_truncated: 10000 + - partition_id: 1 + offset_truncated_to: 40000 + messages_truncated: 12030 + - partition_id: 2 + offset_truncated_to: 20000 + messages_truncated: 20000 + ListGroupConfigsResponse: + description: Config name and value for group configurations. + content: + application/json: + schema: + $ref: '#/components/schemas/GroupConfigDataList' + example: + kind: KafkaGroupConfigDataList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs + next: null + data: + - kind: KafkaGroupConfigData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs/share.session.timeout.ms + resource_name: >- + crn:///kafka=cluster-1/group=group-1/config=share.session.timeout.ms + cluster_id: cluster-1 + group_id: group-1 + name: share.session.timeout.ms + value: '45000' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_GROUP_CONFIG + synonyms: + - name: share.session.timeout.ms + value: '45000' + source: DYNAMIC_GROUP_CONFIG + - name: share.session.timeout.ms + value: '30000' + source: DEFAULT_CONFIG + - kind: KafkaGroupConfigData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs/share.heartbeat.interval.ms + resource_name: >- + crn:///kafka=cluster-1/group=group-1/config=share.heartbeat.interval.ms + cluster_id: cluster-1 + group_id: group-1 + name: share.heartbeat.interval.ms + value: null + is_default: true + is_read_only: false + is_sensitive: false + source: DEFAULT_CONFIG + synonyms: + - name: share.heartbeat.interval.ms + value: '3000' + source: DEFAULT_CONFIG + GetGroupConfigResponse: + description: Config name and value for group configuration. + content: + application/json: + schema: + $ref: '#/components/schemas/GroupConfigData' + example: + kind: KafkaGroupConfigData + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs/share.session.timeout.ms + resource_name: >- + crn:///kafka=cluster-1/group=group-1/config=share.session.timeout.ms + cluster_id: cluster-1 + group_id: group-1 + name: share.session.timeout.ms + value: '45000' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_GROUP_CONFIG + synonyms: + - name: share.session.timeout.ms + value: '45000' + source: DYNAMIC_GROUP_CONFIG + - name: share.session.timeout.ms + value: '30000' + source: DEFAULT_CONFIG + parameters: + ClusterId: + name: cluster_id + description: The Kafka cluster ID. + in: path + required: true + schema: + type: string + example: cluster-1 + AclResourceType: + name: resource_type + description: The ACL resource type. + in: query + required: false + schema: + $ref: '#/components/schemas/AclResourceType' + AclResourceName: + name: resource_name + description: The ACL resource name. + in: query + required: false + schema: + type: string + AclPatternType: + name: pattern_type + description: The ACL pattern type. + in: query + required: false + schema: + $ref: '#/components/schemas/AclPatternType' + AclPrincipal: + name: principal + description: |- + The ACL principal. This is the Service Account name or user name. + Supports both legacy `User:` format (numeric IDs) and new `UserV2:` + format (sa-xxx format) for service accounts. Use `UserV2:*` to + retrieve service accounts in the new format. + in: query + required: false + schema: + type: string + AclHost: + name: host + description: The ACL host. + in: query + required: false + schema: + type: string + AclOperation: + name: operation + description: The ACL operation. + in: query + required: false + schema: + $ref: '#/components/schemas/AclOperation' + AclPermission: + name: permission + description: The ACL permission. + in: query + required: false + schema: + $ref: '#/components/schemas/AclPermission' + AclResourceTypeRequired: + name: resource_type + description: The ACL resource type. + in: query + required: true + schema: + $ref: '#/components/schemas/AclResourceType' + AclPatternTypeRequired: + name: pattern_type + description: The ACL pattern type. + in: query + required: true + schema: + $ref: '#/components/schemas/AclPatternType' + AclOperationRequired: + name: operation + description: The ACL operation. + in: query + required: true + schema: + $ref: '#/components/schemas/AclOperation' + AclPermissionRequired: + name: permission + description: The ACL permission. + in: query + required: true + schema: + $ref: '#/components/schemas/AclPermission' + ConfigName: + name: name + description: The configuration parameter name. + in: path + required: true + schema: + type: string + example: compression.type + ConsumerGroupId: + name: consumer_group_id + description: The consumer group ID. + in: path + required: true + schema: + type: string + example: consumer-group-1 + TopicName: + name: topic_name + description: The topic name. + in: path + required: true + schema: + type: string + example: topic-1 + PartitionId: + name: partition_id + description: The partition ID. + in: path + required: true + schema: + type: integer + example: 0 + ConsumerId: + name: consumer_id + description: The consumer ID. + in: path + required: true + schema: + type: string + example: consumer-1 + IncludeAuthorizedOperations: + name: include_authorized_operations + description: Specify if authorized operations should be included in the response. + in: query + required: false + schema: + type: boolean + QueryParamLinkName: + name: link_name + description: The link name + in: query + required: true + schema: + type: string + example: link-sb1 + ValidateOnly: + name: validate_only + description: >- + To validate the action can be performed successfully or not. Default: + false + in: query + required: false + schema: + type: boolean + example: false + ValidateLink: + name: validate_link + description: >- + To synchronously validate that the source cluster ID is expected and the + dest cluster has the permission to read topics in the source cluster. + Default: true + in: query + required: false + schema: + type: boolean + example: false + LinkName: + name: link_name + description: The link name + in: path + required: true + schema: + type: string + example: link-sb1 + IncludeTasks: + name: include_tasks + description: 'Whether to include cluster linking tasks in the response. Default: false' + in: query + required: false + schema: + type: boolean + example: false + Force: + name: force + description: 'Force the action. Default: false' + in: query + required: false + schema: + type: boolean + example: false + LinkConfigName: + name: config_name + description: The link config name + in: path + required: true + schema: + type: string + example: consumer.offset.sync.enable + MirrorTopicStatus: + name: mirror_status + description: >- + The status of the mirror topic. If not specified, all mirror topics will + be returned. + in: query + required: false + schema: + $ref: '#/components/schemas/MirrorTopicStatus' + example: ACTIVE + MirrorTopicName: + name: mirror_topic_name + description: Cluster Linking mirror topic name + in: path + required: true + schema: + type: string + example: topic-1 + IncludeStateTransitionErrors: + name: include_state_transition_errors + description: >- + Whether to include mirror state transition errors in the response. + Default: false + in: query + required: false + schema: + type: boolean + example: false + IncludePartitionLevelTruncationData: + name: include_partition_level_truncation_data + description: >- + Whether to include partition level truncation information when + truncating and restoring a topic in the response. Default: false + in: query + required: false + schema: + type: boolean + example: false + GroupId: + name: group_id + description: The group ID. + in: path + required: true + schema: + type: string + example: group-1 + requestBodies: + BatchCreateAclRequest: + description: The batch ACL creation request. + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAclRequestDataList' + example: + data: + - resource_type: CLUSTER + resource_name: kafka-cluster + pattern_type: LITERAL + principal: principalType:principalName + host: '*' + operation: DESCRIBE + permission: DENY + - resource_type: TOPIC + resource_name: kafka-cluster + pattern_type: LITERAL + principal: principalType:principalName + host: '*' + operation: READ + permission: ALLOW + CreateAclRequest: + description: The ACL creation request. + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAclRequestData' + example: + resource_type: CLUSTER + resource_name: kafka-cluster + pattern_type: LITERAL + principal: principalType:principalName + host: '*' + operation: DESCRIBE + permission: DENY + AlterClusterConfigBatchRequest: + description: The alter cluster configuration parameter batch request. + content: + application/json: + schema: + $ref: '#/components/schemas/AlterConfigBatchRequestData' + example: + data: + - name: max.connections + operation: DELETE + - name: compression.type + value: gzip + UpdateClusterConfigRequest: + description: The cluster configuration parameter update request. + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateConfigRequestData' + example: + value: gzip + CreateTopicRequest: + description: >- + The topic creation request. Note that Confluent Cloud allows only + specific replication factor values. Because of that the replication + factor field should either be omitted or it should use one of the + allowed values (see + https://docs.confluent.io/cloud/current/client-apps/optimizing/durability.html). + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTopicRequestData' + examples: + uniform_replication: + value: + topic_name: topic-X + partitions_count: 64 + replication_factor: 3 + configs: + - name: cleanup.policy + value: compact + - name: compression.type + value: gzip + dry_run_create_topic: + value: + topic_name: topic-X + partitions_count: 64 + replication_factor: 3 + validate_only: true + AlterTopicConfigBatchRequest: + description: The alter topic configuration parameter batch request. + content: + application/json: + schema: + $ref: '#/components/schemas/AlterConfigBatchRequestData' + examples: + batch_alter_topic_configs: + value: + data: + - name: cleanup.policy + operation: DELETE + - name: compression.type + value: gzip + validate_only_batch_alter_topic_configs: + value: + data: + - name: cleanup.policy + operation: DELETE + - name: compression.type + value: gzip + validate_only: true + UpdateTopicConfigRequest: + description: The topic configuration parameter update request. + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateConfigRequestData' + example: + value: gzip + ProduceRequest: + description: >- + A single record to be produced to Kafka. To produce multiple records in + the same request, simply concatenate the records. The delivery reports + are concatenated in the same order as the records are sent. + content: + application/json: + schema: + $ref: '#/components/schemas/ProduceRequest' + examples: + binary_and_json: + description: If using type, one of "BINARY", "JSON" or "STRING" is required. + value: + partition_id: 1 + headers: + - name: Header-1 + value: SGVhZGVyLTE= + - name: Header-2 + value: SGVhZGVyLTI= + key: + type: BINARY + data: Zm9vYmFy + value: + type: JSON + data: + foo: bar + timestamp: '2021-02-05T19:14:42Z' + string: + description: If using type, one of "BINARY", "JSON" or "STRING" is required. + value: + value: + type: STRING + data: My message + empty_value: + description: key or value can be omitted entirely. + value: + key: + data: 1000 + CreateLinkRequest: + description: Create a cluster link + content: + application/json: + schema: + $ref: '#/components/schemas/CreateLinkRequestData' + examples: + destination_initiated_link: + description: Create a destination initiated cluster link + value: + source_cluster_id: cluster-1 + configs: + - name: bootstrap.servers + value: cluster-1-bootstrap-server + - name: acl.sync.enable + value: 'false' + - name: consumer.offset.sync.ms + value: '30000' + - name: sasl.mechanism + value: PLAIN + - name: security.protocol + value: SASL_SSL + - name: sasl.jaas.config + value: >- + sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule + required username='' password=''; + source_initiated_link_at_source_cluster: + description: Create a source initiated cluster link at source cluster + value: + destination_cluster_id: cluster-2 + configs: + - name: bootstrap.servers + value: cluster-2-bootstrap-server + - name: link.mode + value: SOURCE + - name: sasl.mechanism + value: PLAIN + - name: security.protocol + value: SASL_SSL + - name: sasl.jaas.config + value: >- + sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule + required username='' + password=''; + - name: local.sasl.mechanism + value: PLAIN + - name: local.security.protocol + value: SASL_SSL + - name: local.sasl.jaas.config + value: >- + sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule + required username='' password=''; + source_initiated_link_at_destination_cluster: + description: Create a source initiated cluster link at destination cluster + value: + destination_cluster_id: cluster-1 + configs: + - name: link.mode + value: DESTINATION + - name: connection.mode + value: INBOUND + - name: acl.sync.enable + value: 'false' + bidirectional_link_east: + description: Create a bidirectional cluster link in east + value: + remote_cluster_id: cluster-west + configs: + - name: bootstrap.servers + value: cluster-west-bootstrap-server + - name: link.mode + value: BIDIRECTIONAL + - name: cluster.link.prefix + value: west. + - name: sasl.mechanism + value: PLAIN + - name: security.protocol + value: SASL_SSL + - name: sasl.jaas.config + value: >- + sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule + required username='' password=''; + bidirectional_link_west: + description: Create a bidirectional cluster link in west + value: + remote_cluster_id: cluster-east + cluster_link_id: eEBkTffYSESld6EO898x3w + configs: + - name: bootstrap.servers + value: cluster-east-bootstrap-server + - name: link.mode + value: BIDIRECTIONAL + - name: cluster.link.prefix + value: east. + - name: sasl.mechanism + value: PLAIN + - name: security.protocol + value: SASL_SSL + - name: sasl.jaas.config + value: >- + sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule + required username='' password=''; + UpdateLinkConfigRequest: + content: + application/json: + example: + value: '300000' + schema: + $ref: '#/components/schemas/UpdateLinkConfigRequestData' + description: Link config value to update + AlterLinkConfigBatchRequest: + content: + application/json: + example: + data: + - name: cleanup.policy + operation: DELETE + - name: compression.type + value: gzip + schema: + $ref: '#/components/schemas/AlterConfigBatchRequestData' + CreateMirrorTopicRequest: + description: >- + Name and configs of the topics mirroring from and mirroring to. Note + that Confluent Cloud allows only specific replication factor values. + Because of that the replication factor field should either be omitted or + it should use one of the allowed values (see + https://docs.confluent.io/cloud/current/client-apps/optimizing/durability.html). + content: + application/json: + schema: + $ref: '#/components/schemas/CreateMirrorTopicRequestData' + examples: + generic_example: + description: Generic example of creating a mirror topic + value: + source_topic_name: topic-1 + configs: + - name: unclean.leader.election.enable + value: 'true' + replication_factor: 1 + example_with_mirror_topic_name: + description: Example using optional mirror_topic_name flag + value: + source_topic_name: topic-1 + mirror_topic_name: link1_topic-1 + configs: + - name: unclean.leader.election.enable + value: 'true' + replication_factor: 3 + AlterMirrorsRequest: + description: Mirror topics to be altered. + content: + application/json: + schema: + $ref: '#/components/schemas/AlterMirrorsRequestData' + examples: + mirror_topic_names: + description: Example using mirror topic names + value: + mirror_topic_names: + - topic-1 + - topic-2 + mirror_topic_name_pattern: + description: Example using mirror topic name pattern + value: + mirror_topic_name_pattern: .* + UpdateGroupConfigRequest: + content: + application/json: + example: + value: '45000' + schema: + $ref: '#/components/schemas/UpdateGroupConfigRequestData' + description: Group config value to update + AlterGroupConfigBatchRequest: + content: + application/json: + example: + data: + - name: share.session.timeout.ms + operation: DELETE + - name: share.heartbeat.interval.ms + value: '5000' + schema: + $ref: '#/components/schemas/AlterConfigBatchRequestData' + x-stackQL-resources: + clusters: + id: confluent.kafka.clusters + name: clusters + title: Clusters + methods: + get_kafka_cluster: + operation: + $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/get_kafka_cluster + insert: [] + update: [] + delete: [] + replace: [] + acls: + id: confluent.kafka.acls + name: acls + title: Acls + methods: + batch_create_kafka_acls: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1acls:batch/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_kafka_acls: + operation: + $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1acls/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_kafka_acls: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1acls/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete_kafka_acls: + operation: + $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1acls/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/acls/methods/get_kafka_acls' + insert: + - $ref: '#/components/x-stackQL-resources/acls/methods/create_kafka_acls' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/acls/methods/delete_kafka_acls' + replace: [] + cluster_configs: + id: confluent.kafka.cluster_configs + name: cluster_configs + title: Cluster Configs + methods: + list_kafka_cluster_configs: + operation: + $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1broker-configs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + update_kafka_cluster_configs: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1broker-configs:alter/post + response: + mediaType: application/json + openAPIDocKey: '204' + get_kafka_cluster_config: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1broker-configs~1{name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_kafka_cluster_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1broker-configs~1{name}/put + response: + mediaType: application/json + openAPIDocKey: '204' + delete_kafka_cluster_config: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1broker-configs~1{name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/cluster_configs/methods/get_kafka_cluster_config + - $ref: >- + #/components/x-stackQL-resources/cluster_configs/methods/list_kafka_cluster_configs + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/cluster_configs/methods/delete_kafka_cluster_config + replace: + - $ref: >- + #/components/x-stackQL-resources/cluster_configs/methods/update_kafka_cluster_config + - $ref: >- + #/components/x-stackQL-resources/cluster_configs/methods/update_kafka_cluster_configs + consumer_groups: + id: confluent.kafka.consumer_groups + name: consumer_groups + title: Consumer Groups + methods: + list_kafka_consumer_groups: + operation: + $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_kafka_consumer_group: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/consumer_groups/methods/get_kafka_consumer_group + - $ref: >- + #/components/x-stackQL-resources/consumer_groups/methods/list_kafka_consumer_groups + insert: [] + update: [] + delete: [] + replace: [] + consumers: + id: confluent.kafka.consumers + name: consumers + title: Consumers + methods: + list_kafka_consumers: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}~1consumers/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_kafka_consumer: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}~1consumers~1{consumer_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/consumers/methods/get_kafka_consumer + - $ref: >- + #/components/x-stackQL-resources/consumers/methods/list_kafka_consumers + insert: [] + update: [] + delete: [] + replace: [] + consumers_lag_summary: + id: confluent.kafka.consumers_lag_summary + name: consumers_lag_summary + title: Consumers Lag Summary + methods: + get_kafka_consumer_group_lag_summary: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}~1lag-summary/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/consumers_lag_summary/methods/get_kafka_consumer_group_lag_summary + insert: [] + update: [] + delete: [] + replace: [] + consumers_lags: + id: confluent.kafka.consumers_lags + name: consumers_lags + title: Consumers Lags + methods: + list_kafka_consumer_lags: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}~1lags/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_kafka_consumer_lag: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}~1lags~1{topic_name}~1partitions~1{partition_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/consumers_lags/methods/get_kafka_consumer_lag + - $ref: >- + #/components/x-stackQL-resources/consumers_lags/methods/list_kafka_consumer_lags + insert: [] + update: [] + delete: [] + replace: [] + topics: + id: confluent.kafka.topics + name: topics + title: Topics + methods: + list_kafka_topics: + operation: + $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_kafka_topic: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_kafka_topic: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_partition_count_kafka_topic: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_kafka_topic: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/topics/methods/get_kafka_topic' + - $ref: '#/components/x-stackQL-resources/topics/methods/list_kafka_topics' + insert: + - $ref: '#/components/x-stackQL-resources/topics/methods/create_kafka_topic' + update: + - $ref: >- + #/components/x-stackQL-resources/topics/methods/update_partition_count_kafka_topic + delete: + - $ref: '#/components/x-stackQL-resources/topics/methods/delete_kafka_topic' + replace: [] + topic_configs: + id: confluent.kafka.topic_configs + name: topic_configs + title: Topic Configs + methods: + list_kafka_topic_configs: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1configs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + update_kafka_topic_config_batch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1configs:alter/post + response: + mediaType: application/json + openAPIDocKey: '204' + get_kafka_topic_config: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1configs~1{name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_kafka_topic_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1configs~1{name}/put + response: + mediaType: application/json + openAPIDocKey: '204' + delete_kafka_topic_config: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1configs~1{name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + list_kafka_all_topic_configs: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1-~1configs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/topic_configs/methods/get_kafka_topic_config + - $ref: >- + #/components/x-stackQL-resources/topic_configs/methods/list_kafka_topic_configs + - $ref: >- + #/components/x-stackQL-resources/topic_configs/methods/list_kafka_all_topic_configs + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/topic_configs/methods/delete_kafka_topic_config + replace: + - $ref: >- + #/components/x-stackQL-resources/topic_configs/methods/update_kafka_topic_config + - $ref: >- + #/components/x-stackQL-resources/topic_configs/methods/update_kafka_topic_config_batch + topic_partitions: + id: confluent.kafka.topic_partitions + name: topic_partitions + title: Topic Partitions + methods: + list_kafka_partitions: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1partitions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_kafka_partition: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1partitions~1{partition_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/topic_partitions/methods/get_kafka_partition + - $ref: >- + #/components/x-stackQL-resources/topic_partitions/methods/list_kafka_partitions + insert: [] + update: [] + delete: [] + replace: [] + records: + id: confluent.kafka.records + name: records + title: Records + methods: + produce_record: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1records/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/records/methods/produce_record' + update: [] + delete: [] + replace: [] + cluster_links: + id: confluent.kafka.cluster_links + name: cluster_links + title: Cluster Links + methods: + list_kafka_links: + operation: + $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_kafka_link: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links/post' + response: + mediaType: application/json + openAPIDocKey: '204' + get_kafka_link: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_kafka_link: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/cluster_links/methods/get_kafka_link + - $ref: >- + #/components/x-stackQL-resources/cluster_links/methods/list_kafka_links + insert: + - $ref: >- + #/components/x-stackQL-resources/cluster_links/methods/create_kafka_link + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/cluster_links/methods/delete_kafka_link + replace: [] + default_topic_configs: + id: confluent.kafka.default_topic_configs + name: default_topic_configs + title: Default Topic Configs + methods: + list_kafka_default_topic_configs: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1default-configs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/default_topic_configs/methods/list_kafka_default_topic_configs + insert: [] + update: [] + delete: [] + replace: [] + cluster_link_configs: + id: confluent.kafka.cluster_link_configs + name: cluster_link_configs + title: Cluster Link Configs + methods: + list_kafka_link_configs: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1configs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_kafka_link_configs: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1configs~1{config_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_kafka_link_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1configs~1{config_name}/put + response: + mediaType: application/json + openAPIDocKey: '204' + delete_kafka_link_config: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1configs~1{config_name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + update_kafka_link_config_batch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1configs:alter/put + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/cluster_link_configs/methods/get_kafka_link_configs + - $ref: >- + #/components/x-stackQL-resources/cluster_link_configs/methods/list_kafka_link_configs + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/cluster_link_configs/methods/delete_kafka_link_config + replace: + - $ref: >- + #/components/x-stackQL-resources/cluster_link_configs/methods/update_kafka_link_config + - $ref: >- + #/components/x-stackQL-resources/cluster_link_configs/methods/update_kafka_link_config_batch + mirror_topics: + id: confluent.kafka.mirror_topics + name: mirror_topics + title: Mirror Topics + methods: + create_kafka_mirror_topic: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors/post + response: + mediaType: application/json + openAPIDocKey: '204' + list_kafka_mirror_topics_under_link: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + list_kafka_mirror_topics: + operation: + $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1-~1mirrors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + read_kafka_mirror_topic: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors~1{mirror_topic_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_kafka_mirror_topics_promote: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:promote/post + response: + mediaType: application/json + openAPIDocKey: '200' + update_kafka_mirror_topics_failover: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:failover/post + response: + mediaType: application/json + openAPIDocKey: '200' + update_kafka_mirror_topics_pause: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:pause/post + response: + mediaType: application/json + openAPIDocKey: '200' + update_kafka_mirror_topics_resume: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:resume/post + response: + mediaType: application/json + openAPIDocKey: '200' + update_kafka_mirror_topics_reverse_and_start_mirror: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:reverse-and-start-mirror/post + response: + mediaType: application/json + openAPIDocKey: '200' + update_kafka_mirror_topics_reverse_and_pause_mirror: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:reverse-and-pause-mirror/post + response: + mediaType: application/json + openAPIDocKey: '200' + update_kafka_mirror_topics_truncate_and_restore_mirror: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:truncate-and-restore/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/mirror_topics/methods/read_kafka_mirror_topic + - $ref: >- + #/components/x-stackQL-resources/mirror_topics/methods/list_kafka_mirror_topics_under_link + - $ref: >- + #/components/x-stackQL-resources/mirror_topics/methods/list_kafka_mirror_topics + insert: + - $ref: >- + #/components/x-stackQL-resources/mirror_topics/methods/create_kafka_mirror_topic + update: [] + delete: [] + replace: [] + group_configs: + id: confluent.kafka.group_configs + name: group_configs + title: Group Configs + methods: + list_kafka_group_configs: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1groups~1{group_id}~1configs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_kafka_group_config: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1groups~1{group_id}~1configs~1{name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_kafka_group_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1groups~1{group_id}~1configs~1{name}/put + response: + mediaType: application/json + openAPIDocKey: '204' + delete_kafka_group_config: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1groups~1{group_id}~1configs~1{name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + update_kafka_group_config_batch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1groups~1{group_id}~1configs:alter/post + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/group_configs/methods/get_kafka_group_config + - $ref: >- + #/components/x-stackQL-resources/group_configs/methods/list_kafka_group_configs + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/group_configs/methods/delete_kafka_group_config + replace: + - $ref: >- + #/components/x-stackQL-resources/group_configs/methods/update_kafka_group_config +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/ksqldb_clusters.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/ksqldb_clusters.yaml new file mode 100644 index 0000000..4991461 --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/ksqldb_clusters.yaml @@ -0,0 +1,2300 @@ +openapi: 3.0.0 +info: + title: ksqldb_clusters API + description: confluent ksqldb_clusters API + version: 1.0.0 +paths: + /ksqldbcm/v2/clusters: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listKsqldbcmV2Clusters + summary: List of Clusters + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Clusters (ksqldbcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: >- + `Cluster` represents a ksqlDB runtime that you can issue + queries to using its API endpoint. + + It executes SQL statements and queries which under the hood + get built into corresponding + + Kafka Streams topologies. The API allows you to list, create, + read, and delete your ksqlDB clusters. + + + + Related guide: [ksqlDB in Confluent + Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the following quotas: + + + | Quota | Description | + + | --- | --- | + + | `ksql.limits.max_apps_per_cluster` | Clusters in one + Confluent Cloud Kafka Cluster. | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Cluster` represents a ksqlDB runtime that you can issue + queries to using its API endpoint. + + It executes SQL statements and queries which under the + hood get built into corresponding + + Kafka Streams topologies. The API allows you to list, + create, read, and delete your ksqlDB clusters. + + + + Related guide: [ksqlDB in Confluent + Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the following quotas: + + + | Quota | Description | + + | --- | --- | + + | `ksql.limits.max_apps_per_cluster` | Clusters in one + Confluent Cloud Kafka Cluster. | + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createKsqldbcmV2Cluster + summary: Create a Cluster + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a cluster. + tags: + - Clusters (ksqldbcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Cluster` represents a ksqlDB runtime that you can issue queries + to using its API endpoint. + + It executes SQL statements and queries which under the hood get + built into corresponding + + Kafka Streams topologies. The API allows you to list, create, + read, and delete your ksqlDB clusters. + + + + Related guide: [ksqlDB in Confluent + Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the following quotas: + + + | Quota | Description | + + | --- | --- | + + | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent + Cloud Kafka Cluster. | + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterStatus' + required: + - spec + responses: + '202': + description: A Cluster is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/ksqldbcm/v2/clusters/{id} + description: Cluster resource uri + content: + application/json: + schema: + type: object + description: >- + `Cluster` represents a ksqlDB runtime that you can issue + queries to using its API endpoint. + + It executes SQL statements and queries which under the hood + get built into corresponding + + Kafka Streams topologies. The API allows you to list, create, + read, and delete your ksqlDB clusters. + + + + Related guide: [ksqlDB in Confluent + Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the following quotas: + + + | Quota | Description | + + | --- | --- | + + | `ksql.limits.max_apps_per_cluster` | Clusters in one + Confluent Cloud Kafka Cluster. | + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /ksqldbcm/v2/clusters/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getKsqldbcmV2Cluster + summary: Read a Cluster + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (ksqldbcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: >- + `Cluster` represents a ksqlDB runtime that you can issue + queries to using its API endpoint. + + It executes SQL statements and queries which under the hood + get built into corresponding + + Kafka Streams topologies. The API allows you to list, create, + read, and delete your ksqlDB clusters. + + + + Related guide: [ksqlDB in Confluent + Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the following quotas: + + + | Quota | Description | + + | --- | --- | + + | `ksql.limits.max_apps_per_cluster` | Clusters in one + Confluent Cloud Kafka Cluster. | + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteKsqldbcmV2Cluster + summary: Delete a Cluster + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (ksqldbcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Cluster is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + ksqldbcm.v2.ClusterList: + type: object + description: >- + `Cluster` represents a ksqlDB runtime that you can issue queries to + using its API endpoint. + + It executes SQL statements and queries which under the hood get built + into corresponding + + Kafka Streams topologies. The API allows you to list, create, read, and + delete your ksqlDB clusters. + + + + Related guide: [ksqlDB in Confluent + Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the following quotas: + + + | Quota | Description | + + | --- | --- | + + | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent Cloud + Kafka Cluster. | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Cluster` represents a ksqlDB runtime that you can issue queries + to using its API endpoint. + + It executes SQL statements and queries which under the hood get + built into corresponding + + Kafka Streams topologies. The API allows you to list, create, + read, and delete your ksqlDB clusters. + + + + Related guide: [ksqlDB in Confluent + Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the following quotas: + + + | Quota | Description | + + | --- | --- | + + | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent + Cloud Kafka Cluster. | + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + ksqldbcm.v2.Cluster: + type: object + description: >- + `Cluster` represents a ksqlDB runtime that you can issue queries to + using its API endpoint. + + It executes SQL statements and queries which under the hood get built + into corresponding + + Kafka Streams topologies. The API allows you to list, create, read, and + delete your ksqlDB clusters. + + + + Related guide: [ksqlDB in Confluent + Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the following quotas: + + + | Quota | Description | + + | --- | --- | + + | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent Cloud + Kafka Cluster. | + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterStatus' + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + ksqldbcm.v2.ClusterSpec: + type: object + description: The desired state of the Cluster + properties: + display_name: + type: string + example: ksqlDB_cluster_0 + description: The name of the ksqlDB cluster. + pattern: ^(?:[0-9A-Za-z\-])[\w-]{0,63}$ + x-immutable: true + use_detailed_processing_log: + type: boolean + default: true + description: > + This flag controls whether you want to include the row data in the + processing log topic. Turn it off if you + + don't want to emit sensitive information to the processing log + x-immutable: true + csu: + type: integer + format: int32 + example: 4 + x-extensible-enum: + - 1 + - 2 + - 4 + - 8 + - 12 + description: The number of CSUs (Confluent Streaming Units) in a ksqlDB cluster. + x-immutable: false + kafka_cluster: + description: The kafka_cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + credential_identity: + description: >- + The credential_identity to which this belongs. The + credential_identity can be one of iam.v2.User, + iam.v2.ServiceAccount. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + ksqldbcm.v2.ClusterStatus: + type: object + required: + - phase + - is_paused + - storage + description: The status of the Cluster + properties: + http_endpoint: + type: string + description: The dataplane endpoint of the ksqlDB cluster. + example: https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud + readOnly: true + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PROVISIONED + - FAILED + description: Status of the ksqlDB cluster. + example: PROVISIONING + readOnly: true + is_paused: + type: boolean + description: Tells you if the cluster has been paused + readOnly: true + storage: + type: integer + format: int32 + example: 125 + description: Amount of storage (in GB) provisioned to this cluster + readOnly: true + topic_prefix: + type: string + description: >- + Topic name prefix used by this ksqlDB cluster. Used to assign ACLs + for this ksqlDB cluster to use. + example: pksqlc-00000 + readOnly: true + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + EnvScopedObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + TypedGlobalObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + GlobalObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + OverQuotaError: + x-summary: Over Quota + description: The request would exceed one or more quotas. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '402' + code: quota_exceeded + title: Kafka Clusters Per Org Quota Exceeded + detail: >- + The request would exceed the quota: + kafka_clusters_per_environment + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + x-stackQL-resources: + clusters: + id: confluent.ksqldb_clusters.clusters + name: clusters + title: Clusters + methods: + list_ksqldbcm_v2_clusters: + operation: + $ref: '#/paths/~1ksqldbcm~1v2~1clusters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_ksqldbcm_v2_cluster: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ksqldbcm~1v2~1clusters/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_ksqldbcm_v2_cluster: + operation: + $ref: '#/paths/~1ksqldbcm~1v2~1clusters~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_ksqldbcm_v2_cluster: + operation: + $ref: '#/paths/~1ksqldbcm~1v2~1clusters~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/get_ksqldbcm_v2_cluster + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/list_ksqldbcm_v2_clusters + insert: + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/create_ksqldbcm_v2_cluster + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/delete_ksqldbcm_v2_cluster + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/managed_kafka_clusters.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/managed_kafka_clusters.yaml new file mode 100644 index 0000000..8dd67ab --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/managed_kafka_clusters.yaml @@ -0,0 +1,2982 @@ +openapi: 3.0.0 +info: + title: managed_kafka_clusters API + description: confluent managed_kafka_clusters API + version: 1.0.0 +paths: + /cmk/v2/clusters: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCmkV2Clusters + summary: List of Clusters + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - n-00000 + - n-00001 + description: >- + Filter the results by exact match for spec.network. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Clusters (cmk/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: >- + `Clusters` objects represent Apache Kafka Clusters on + Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your Kafka clusters. + + + + Related guide: [Confluent Cloud Cluster Management for Apache + Kafka + APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `kafka_clusters_per_environment` | Number of clusters in one + Confluent Cloud environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cmk/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Clusters` objects represent Apache Kafka Clusters on + Confluent Cloud. + + + The API allows you to list, create, read, update, and + delete your Kafka clusters. + + + + Related guide: [Confluent Cloud Cluster Management for + Apache Kafka + APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `kafka_clusters_per_environment` | Number of clusters + in one Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createCmkV2Cluster + summary: Create a Cluster + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a cluster. + tags: + - Clusters (cmk/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Clusters` objects represent Apache Kafka Clusters on Confluent + Cloud. + + + The API allows you to list, create, read, update, and delete + your Kafka clusters. + + + + Related guide: [Confluent Cloud Cluster Management for Apache + Kafka + APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `kafka_clusters_per_environment` | Number of clusters in one + Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + required: + - spec + responses: + '202': + description: A Cluster is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/cmk/v2/clusters/{id} + description: Cluster resource uri + content: + application/json: + schema: + type: object + description: >- + `Clusters` objects represent Apache Kafka Clusters on + Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your Kafka clusters. + + + + Related guide: [Confluent Cloud Cluster Management for Apache + Kafka + APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `kafka_clusters_per_environment` | Number of clusters in one + Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cmk/v2/clusters/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCmkV2Cluster + summary: Read a Cluster + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (cmk/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: >- + `Clusters` objects represent Apache Kafka Clusters on + Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your Kafka clusters. + + + + Related guide: [Confluent Cloud Cluster Management for Apache + Kafka + APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `kafka_clusters_per_environment` | Number of clusters in one + Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateCmkV2Cluster + summary: Update a Cluster + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a cluster. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (cmk/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Clusters` objects represent Apache Kafka Clusters on Confluent + Cloud. + + + The API allows you to list, create, read, update, and delete + your Kafka clusters. + + + + Related guide: [Confluent Cloud Cluster Management for Apache + Kafka + APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `kafka_clusters_per_environment` | Number of clusters in one + Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + required: + - spec + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: >- + `Clusters` objects represent Apache Kafka Clusters on + Confluent Cloud. + + + The API allows you to list, create, read, update, and delete + your Kafka clusters. + + + + Related guide: [Confluent Cloud Cluster Management for Apache + Kafka + APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `kafka_clusters_per_environment` | Number of clusters in one + Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteCmkV2Cluster + summary: Delete a Cluster + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (cmk/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Cluster is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + MultipleSearchFilter: + description: Filter a collection by a string search for one or more values + type: array + items: + type: string + cmk.v2.ClusterList: + type: object + description: >- + `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. + + + The API allows you to list, create, read, update, and delete your Kafka + clusters. + + + + Related guide: [Confluent Cloud Cluster Management for Apache Kafka + APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `kafka_clusters_per_environment` | Number of clusters in one Confluent + Cloud environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cmk/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Clusters` objects represent Apache Kafka Clusters on Confluent + Cloud. + + + The API allows you to list, create, read, update, and delete your + Kafka clusters. + + + + Related guide: [Confluent Cloud Cluster Management for Apache + Kafka + APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `kafka_clusters_per_environment` | Number of clusters in one + Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + cmk.v2.Cluster: + type: object + description: >- + `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. + + + The API allows you to list, create, read, update, and delete your Kafka + clusters. + + + + Related guide: [Confluent Cloud Cluster Management for Apache Kafka + APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + + ## The Clusters Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `kafka_clusters_per_environment` | Number of clusters in one Confluent + Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cmk.v2.ClusterSpec: + type: object + description: The desired state of the Cluster + properties: + display_name: + type: string + description: The name of the cluster. + example: ProdKafkaCluster + availability: + type: string + description: | + The availability zone configuration of the cluster + x-extensible-enum: + - MULTI_ZONE + - SINGLE_ZONE + - HIGH + - LOW + example: SINGLE_ZONE + cloud: + type: string + description: The cloud service provider in which the cluster is running. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: GCP + x-immutable: true + region: + type: string + description: The cloud service provider region where the cluster is running. + example: us-east4 + x-immutable: true + config: + description: > + The configuration of the Kafka cluster. + + + Note: Clusters can be upgraded from Basic to Standard, but cannot be + downgraded from Standard to Basic. + default: + kind: Basic + example: + kind: Basic + discriminator: + propertyName: kind + mapping: + Basic: '#/components/schemas/cmk.v2.Basic' + Standard: '#/components/schemas/cmk.v2.Standard' + Dedicated: '#/components/schemas/cmk.v2.Dedicated' + Enterprise: '#/components/schemas/cmk.v2.Enterprise' + Freight: '#/components/schemas/cmk.v2.Freight' + type: object + properties: + kind: + description: | + Basic cluster type. + type: string + enum: + - Basic + max_ecku: + description: > + The maximum number of Elastic Confluent Kafka Units (eCKUs) that + Kafka clusters should auto-scale to. + + For more details, see [Maximum eCKU + requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements). + type: integer + format: int32 + minimum: 1 + example: 2 + cku: + description: > + The number of Confluent Kafka Units (CKUs) for Dedicated cluster + types. + + MULTI_ZONE dedicated clusters must have at least two CKUs. + type: integer + format: int32 + minimum: 1 + example: 2 + encryption_key: + type: string + description: > + The id of the encryption key that is used to encrypt the data in + the Kafka cluster. + + (e.g. for Amazon Web Services, the Amazon Resource Name of the + key). + example: >- + arn:aws:kms:us-west-2:000000000000:key/0000xxxx-00xx-00xx-00xx-0000000000xx + deprecated: true + x-immutable: true + zones: + type: array + items: + type: string + uniqueItems: true + minItems: 1 + maxItems: 3 + description: > + The list of zones the cluster is in. + + + On AWS, zones are AWS [AZ + IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) + (e.g. use1-az3) + + On GCP, zones are GCP + [zones](https://cloud.google.com/compute/docs/regions-zones) + (e.g. us-central1-c). + readOnly: false + example: + - us-central1-a + - us-central1-b + - us-central1-c + x-immutable: true + required: + - kind + - cku + kafka_bootstrap_endpoint: + type: string + description: > + The bootstrap endpoint used by Kafka clients to connect to the + cluster. + + + DEPRECATED - Please use the `endpoints` attribute instead. + example: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092 + deprecated: true + x-immutable: true + readOnly: true + http_endpoint: + type: string + description: | + The cluster HTTP request URL. + + DEPRECATED - Please use the `endpoints` attribute instead. + format: uri + example: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud + deprecated: true + x-immutable: true + readOnly: true + api_endpoint: + type: string + description: > + The Kafka API cluster endpoint used by Kafka clients to connect to + the cluster. + + + DEPRECATED - Please use the `endpoints` attribute instead. + example: https://pkac-00000.us-west-2.aws.confluent.cloud + deprecated: true + x-immutable: true + readOnly: true + endpoints: + description: > + A map of endpoints for connecting to the Kafka cluster, + + keyed by access_point_id. Access Point ID 'PUBLIC' and + 'PRIVATE_LINK' are reserved. + + These can be used for different network access methods or regions. + example: + ap1pni123: + kafka_bootstrap_endpoint: lkc-s1232-00000.us-central1.gcp.private.confluent.cloud:9092 + http_endpoint: https://lkc-s1232.us-central1.gcp.private.confluent.cloud:443 + connection_type: PRIVATENETWORKINTERFACE + ap2platt67890: + kafka_bootstrap_endpoint: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092 + http_endpoint: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud + connection_type: PRIVATELINK + readOnly: true + type: object + additionalProperties: + $ref: '#/components/schemas/cmk.v2.Endpoints' + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + description: The network associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + byok: + description: > + Note: For Pre-BYOK v1 clusters, API responses might show both + + `encryption_key` and `byok`. + + To manage Pre-BYOK v1 keys, refer to: + + https://docs.confluent.io/cloud/current/security/encrypt/byok/legacy-byok.html + + #manage-pre-byok-api-v1-self-managed-encryption-keys + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + cmk.v2.ClusterStatus: + type: object + required: + - phase + description: The status of the Cluster + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PROVISIONED + - FAILED + description: | + The lifecyle phase of the cluster: + PROVISIONED: cluster is provisioned; + PROVISIONING: cluster provisioning is in progress; + FAILED: provisioning failed + readOnly: true + example: PROVISIONED + cku: + description: > + The number of Confluent Kafka Units (CKUs) the Dedicated cluster + currently has. + readOnly: true + type: integer + format: int32 + minimum: 1 + example: 2 + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + cmk.v2.Basic: + type: object + description: | + The basic cluster type. + properties: + kind: + description: | + Basic cluster type. + type: string + enum: + - Basic + max_ecku: + description: > + The maximum number of Elastic Confluent Kafka Units (eCKUs) that + Kafka clusters should auto-scale to. + + For more details, see [Maximum eCKU + requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements). + type: integer + format: int32 + minimum: 1 + example: 2 + required: + - kind + cmk.v2.Standard: + type: object + description: | + The standard cluster type. + properties: + kind: + description: | + Standard cluster type. + type: string + enum: + - Standard + max_ecku: + description: > + The maximum number of Elastic Confluent Kafka Units (eCKUs) that + Kafka clusters should auto-scale to. + + Kafka clusters with `HIGH` availability must have at least two + eCKUs. + + For more details, see [Maximum eCKU + requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements). + type: integer + format: int32 + minimum: 1 + example: 2 + required: + - kind + cmk.v2.Dedicated: + type: object + description: | + A dedicated cluster with its parameters. + properties: + kind: + type: string + enum: + - Dedicated + description: | + Dedicated cluster type. + cku: + description: > + The number of Confluent Kafka Units (CKUs) for Dedicated cluster + types. + + MULTI_ZONE dedicated clusters must have at least two CKUs. + type: integer + format: int32 + minimum: 1 + example: 2 + encryption_key: + type: string + description: > + The id of the encryption key that is used to encrypt the data in the + Kafka cluster. + + (e.g. for Amazon Web Services, the Amazon Resource Name of the key). + example: >- + arn:aws:kms:us-west-2:000000000000:key/0000xxxx-00xx-00xx-00xx-0000000000xx + deprecated: true + x-immutable: true + zones: + type: array + items: + type: string + uniqueItems: true + minItems: 1 + maxItems: 3 + description: > + The list of zones the cluster is in. + + + On AWS, zones are AWS [AZ + IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) + (e.g. use1-az3) + + On GCP, zones are GCP + [zones](https://cloud.google.com/compute/docs/regions-zones) + (e.g. us-central1-c). + readOnly: false + example: + - us-central1-a + - us-central1-b + - us-central1-c + x-immutable: true + required: + - kind + - cku + cmk.v2.Enterprise: + type: object + description: | + The enterprise cluster type. + properties: + kind: + description: | + Enterprise cluster type. + type: string + enum: + - Enterprise + max_ecku: + description: > + The maximum number of Elastic Confluent Kafka Units (eCKUs) that + Kafka clusters should auto-scale to. + + Kafka clusters with `HIGH` availability must have at least two + eCKUs. + + For more details, see [Maximum eCKU + requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements). + type: integer + format: int32 + minimum: 1 + example: 2 + required: + - kind + cmk.v2.Freight: + type: object + description: | + A freight cluster with its parameters. + properties: + kind: + type: string + enum: + - Freight + description: | + Freight cluster type. + max_ecku: + description: > + The maximum number of Elastic Confluent Kafka Units (eCKUs) that + Kafka clusters should auto-scale to. + + Kafka clusters with `HIGH` availability must have at least two + eCKUs. + + For more details, see [Maximum eCKU + requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements). + type: integer + format: int32 + minimum: 1 + example: 2 + zones: + type: array + items: + type: string + uniqueItems: true + minItems: 1 + maxItems: 3 + description: > + The list of zones the cluster is in. + + + On AWS, zones are AWS [AZ + IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) + (e.g. use1-az3) + + On GCP, zones are GCP + [zones](https://cloud.google.com/compute/docs/regions-zones) + (e.g. us-central1-c). + readOnly: true + example: + - us-central1-a + - us-central1-b + - us-central1-c + x-immutable: true + required: + - kind + cmk.v2.EndpointsMap: + type: object + description: | + Map of endpoints for a Kafka cluster, keyed by access point ID. + additionalProperties: + $ref: '#/components/schemas/cmk.v2.Endpoints' + readOnly: true + example: + ap1pni123: + kafka_bootstrap_endpoint: lkc-s1232-00000.us-central1.gcp.private.confluent.cloud:9092 + http_endpoint: https://lkc-s1232.us-central1.gcp.private.confluent.cloud:443 + connection_type: PRIVATE_NETWORK_INTERFACE + ap2platt67890: + kafka_bootstrap_endpoint: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092 + http_endpoint: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud + connection_type: PRIVATE_LINK + EnvScopedObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + GlobalObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cmk.v2.Endpoints: + type: object + description: | + Given a gateway type, endpoints to connect to the Kafka cluster. + properties: + kafka_bootstrap_endpoint: + type: string + description: > + The bootstrap endpoint used by Kafka clients to connect to the + cluster. + example: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092 + http_endpoint: + type: string + description: | + The REST endpoint for the Kafka cluster. + format: uri + example: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:443 + connection_type: + type: string + description: | + The type of connection used for the endpoint. + x-extensible-enum: + - PUBLIC + - PRIVATE_LINK + - PRIVATE_NETWORK_INTERFACE + example: PRIVATE_NETWORK_INTERFACE + required: + - kafka_bootstrap_endpoint + - http_endpoint + - connection_type + readOnly: true + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + OverQuotaError: + x-summary: Over Quota + description: The request would exceed one or more quotas. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '402' + code: quota_exceeded + title: Kafka Clusters Per Org Quota Exceeded + detail: >- + The request would exceed the quota: + kafka_clusters_per_environment + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + x-stackQL-resources: + clusters: + id: confluent.managed_kafka_clusters.clusters + name: clusters + title: Clusters + methods: + list_cmk_v2_clusters: + operation: + $ref: '#/paths/~1cmk~1v2~1clusters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_cmk_v2_cluster: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cmk~1v2~1clusters/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_cmk_v2_cluster: + operation: + $ref: '#/paths/~1cmk~1v2~1clusters~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_cmk_v2_cluster: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cmk~1v2~1clusters~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_cmk_v2_cluster: + operation: + $ref: '#/paths/~1cmk~1v2~1clusters~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/get_cmk_v2_cluster + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/list_cmk_v2_clusters + insert: + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/create_cmk_v2_cluster + update: + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/update_cmk_v2_cluster + delete: + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/delete_cmk_v2_cluster + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/networking.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/networking.yaml new file mode 100644 index 0000000..92d58c3 --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/networking.yaml @@ -0,0 +1,26668 @@ +openapi: 3.0.0 +info: + title: networking API + description: confluent networking API + version: 1.0.0 +paths: + /networking/v1/networks: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1Networks + summary: List of Networks + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all networks. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-gcp-us-central1 + - prod-aws-us-east1 + description: >- + Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.cloud + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - GCP + - AWS + description: >- + Filter the results by exact match for spec.cloud. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: spec.region + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - us-central1 + - us-east-1 + description: >- + Filter the results by exact match for spec.region. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: spec.connection_types + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - peering + - privatelink + description: >- + Filter the results by exact match for spec.connection_types. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.cidr + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - 10.200.0.0/16 + description: >- + Filter the results by exact match for spec.cidr. Pass multiple times + to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - PROVISIONING + - READY + description: >- + Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Networks (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network. + content: + application/json: + schema: + type: object + description: >- + `Network` represents a network (VPC) in Confluent Cloud. All + Networks exist within Confluent-managed cloud + + provider accounts. Dedicated networks support more networking + options but can only contain Dedicated clusters. + + Shared networks can contain any cluster type. + + + The API allows you to list, create, read, update, and delete + your networks. + + + + Related guide: [APIs to manage networks in Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Networks Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `dedicated_networks_per_environment` | Number of dedicated + networks per Confluent Cloud environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Network` represents a network (VPC) in Confluent Cloud. + All Networks exist within Confluent-managed cloud + + provider accounts. Dedicated networks support more + networking options but can only contain Dedicated + clusters. + + Shared networks can contain any cluster type. + + + The API allows you to list, create, read, update, and + delete your networks. + + + + Related guide: [APIs to manage networks in Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Networks Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `dedicated_networks_per_environment` | Number of + dedicated networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Network + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1Network + summary: Create a Network + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a network. + tags: + - Networks (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Network` represents a network (VPC) in Confluent Cloud. All + Networks exist within Confluent-managed cloud + + provider accounts. Dedicated networks support more networking + options but can only contain Dedicated clusters. + + Shared networks can contain any cluster type. + + + The API allows you to list, create, read, update, and delete + your networks. + + + + Related guide: [APIs to manage networks in Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Networks Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `dedicated_networks_per_environment` | Number of dedicated + networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + required: + - spec + responses: + '202': + description: A Network is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/networks/{id} + description: Network resource uri + content: + application/json: + schema: + type: object + description: >- + `Network` represents a network (VPC) in Confluent Cloud. All + Networks exist within Confluent-managed cloud + + provider accounts. Dedicated networks support more networking + options but can only contain Dedicated clusters. + + Shared networks can contain any cluster type. + + + The API allows you to list, create, read, update, and delete + your networks. + + + + Related guide: [APIs to manage networks in Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Networks Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `dedicated_networks_per_environment` | Number of dedicated + networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/networks/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1Network + summary: Read a Network + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a network. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network. + tags: + - Networks (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network. + content: + application/json: + schema: + type: object + description: >- + `Network` represents a network (VPC) in Confluent Cloud. All + Networks exist within Confluent-managed cloud + + provider accounts. Dedicated networks support more networking + options but can only contain Dedicated clusters. + + Shared networks can contain any cluster type. + + + The API allows you to list, create, read, update, and delete + your networks. + + + + Related guide: [APIs to manage networks in Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Networks Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `dedicated_networks_per_environment` | Number of dedicated + networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1Network + summary: Update a Network + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a network. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network. + tags: + - Networks (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Network` represents a network (VPC) in Confluent Cloud. All + Networks exist within Confluent-managed cloud + + provider accounts. Dedicated networks support more networking + options but can only contain Dedicated clusters. + + Shared networks can contain any cluster type. + + + The API allows you to list, create, read, update, and delete + your networks. + + + + Related guide: [APIs to manage networks in Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Networks Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `dedicated_networks_per_environment` | Number of dedicated + networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + required: + - spec + responses: + '200': + description: Network. + content: + application/json: + schema: + type: object + description: >- + `Network` represents a network (VPC) in Confluent Cloud. All + Networks exist within Confluent-managed cloud + + provider accounts. Dedicated networks support more networking + options but can only contain Dedicated clusters. + + Shared networks can contain any cluster type. + + + The API allows you to list, create, read, update, and delete + your networks. + + + + Related guide: [APIs to manage networks in Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Networks Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `dedicated_networks_per_environment` | Number of dedicated + networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1Network + summary: Delete a Network + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a network. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network. + tags: + - Networks (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Network is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/peerings: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1Peerings + summary: List of Peerings + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all peerings. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-peering-uscentral1 + - prod-peering-use1 + description: >- + Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - PROVISIONING + - READY + description: >- + Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - n-00000 + - n-00001 + description: >- + Filter the results by exact match for spec.network. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Peerings (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Peering. + content: + application/json: + schema: + type: object + description: >- + Add or remove VPC/VNet peering connections between your + VPC/VNet and Confluent Cloud. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + * [Use VPC peering connections with Confluent Cloud on Google + Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + + ## The Peerings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `peerings_per_network` | Number of peerings per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PeeringList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + Add or remove VPC/VNet peering connections between your + VPC/VNet and Confluent Cloud. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + * [Use VPC peering connections with Confluent Cloud on + Google + Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + + ## The Peerings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `peerings_per_network` | Number of peerings per + network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Peering + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1Peering + summary: Create a Peering + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a peering. + tags: + - Peerings (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + Add or remove VPC/VNet peering connections between your VPC/VNet + and Confluent Cloud. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + * [Use VPC peering connections with Confluent Cloud on Google + Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + + ## The Peerings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + required: + - spec + responses: + '202': + description: A Peering is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/peerings/{id} + description: Peering resource uri + content: + application/json: + schema: + type: object + description: >- + Add or remove VPC/VNet peering connections between your + VPC/VNet and Confluent Cloud. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + * [Use VPC peering connections with Confluent Cloud on Google + Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + + ## The Peerings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/peerings/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1Peering + summary: Read a Peering + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a peering. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the peering. + tags: + - Peerings (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Peering. + content: + application/json: + schema: + type: object + description: >- + Add or remove VPC/VNet peering connections between your + VPC/VNet and Confluent Cloud. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + * [Use VPC peering connections with Confluent Cloud on Google + Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + + ## The Peerings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1Peering + summary: Update a Peering + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a peering. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the peering. + tags: + - Peerings (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + Add or remove VPC/VNet peering connections between your VPC/VNet + and Confluent Cloud. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + * [Use VPC peering connections with Confluent Cloud on Google + Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + + ## The Peerings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + required: + - spec + responses: + '200': + description: Peering. + content: + application/json: + schema: + type: object + description: >- + Add or remove VPC/VNet peering connections between your + VPC/VNet and Confluent Cloud. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + * [Use VPC peering connections with Confluent Cloud on Google + Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + + ## The Peerings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1Peering + summary: Delete a Peering + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a peering. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the peering. + tags: + - Peerings (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Peering is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/transit-gateway-attachments: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1TransitGatewayAttachments + summary: List of Transit Gateway Attachments + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all transit gateway + attachments. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-tgw-use1 + - prod-tgw-usw2 + description: >- + Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - PROVISIONING + - READY + description: >- + Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - n-00000 + - n-00001 + description: >- + Filter the results by exact match for spec.network. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Transit Gateway Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Transit Gateway Attachment. + content: + application/json: + schema: + type: object + description: >- + AWS Transit Gateway Attachments + + + Related guide: [APIs to manage AWS Transit Gateway + Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + + ## The Transit Gateway Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `tgw_attachments_per_network` | Number of TGW attachments + per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachmentList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + AWS Transit Gateway Attachments + + + Related guide: [APIs to manage AWS Transit Gateway + Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + + ## The Transit Gateway Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `tgw_attachments_per_network` | Number of TGW + attachments per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.TransitGatewayAttachmentSpec + status: + $ref: >- + #/components/schemas/networking.v1.TransitGatewayAttachmentStatus + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1TransitGatewayAttachment + summary: Create a Transit Gateway Attachment + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a transit gateway attachment. + tags: + - Transit Gateway Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + AWS Transit Gateway Attachments + + + Related guide: [APIs to manage AWS Transit Gateway + Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + + ## The Transit Gateway Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `tgw_attachments_per_network` | Number of TGW attachments per + network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.TransitGatewayAttachmentSpec + status: + $ref: >- + #/components/schemas/networking.v1.TransitGatewayAttachmentStatus + required: + - spec + responses: + '202': + description: A Transit Gateway Attachment is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: >- + https://api.confluent.cloud/networking/v1/transit-gateway-attachments/{id} + description: TransitGatewayAttachment resource uri + content: + application/json: + schema: + type: object + description: >- + AWS Transit Gateway Attachments + + + Related guide: [APIs to manage AWS Transit Gateway + Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + + ## The Transit Gateway Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `tgw_attachments_per_network` | Number of TGW attachments + per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.TransitGatewayAttachmentSpec + status: + $ref: >- + #/components/schemas/networking.v1.TransitGatewayAttachmentStatus + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/transit-gateway-attachments/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1TransitGatewayAttachment + summary: Read a Transit Gateway Attachment + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a transit gateway attachment. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the transit gateway attachment. + tags: + - Transit Gateway Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Transit Gateway Attachment. + content: + application/json: + schema: + type: object + description: >- + AWS Transit Gateway Attachments + + + Related guide: [APIs to manage AWS Transit Gateway + Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + + ## The Transit Gateway Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `tgw_attachments_per_network` | Number of TGW attachments + per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.TransitGatewayAttachmentSpec + status: + $ref: >- + #/components/schemas/networking.v1.TransitGatewayAttachmentStatus + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1TransitGatewayAttachment + summary: Update a Transit Gateway Attachment + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a transit gateway attachment. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the transit gateway attachment. + tags: + - Transit Gateway Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + AWS Transit Gateway Attachments + + + Related guide: [APIs to manage AWS Transit Gateway + Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + + ## The Transit Gateway Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `tgw_attachments_per_network` | Number of TGW attachments per + network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.TransitGatewayAttachmentSpec + status: + $ref: >- + #/components/schemas/networking.v1.TransitGatewayAttachmentStatus + required: + - spec + responses: + '200': + description: Transit Gateway Attachment. + content: + application/json: + schema: + type: object + description: >- + AWS Transit Gateway Attachments + + + Related guide: [APIs to manage AWS Transit Gateway + Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + + ## The Transit Gateway Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `tgw_attachments_per_network` | Number of TGW attachments + per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.TransitGatewayAttachmentSpec + status: + $ref: >- + #/components/schemas/networking.v1.TransitGatewayAttachmentStatus + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1TransitGatewayAttachment + summary: Delete a Transit Gateway Attachment + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a transit gateway attachment. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the transit gateway attachment. + tags: + - Transit Gateway Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Transit Gateway Attachment is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/private-link-accesses: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1PrivateLinkAccesses + summary: List of Private Link Accesses + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all private link + accesses. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-pl-use1 + - prod-pl-usw2 + description: >- + Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - PROVISIONING + - READY + description: >- + Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - n-00000 + - n-00001 + description: >- + Filter the results by exact match for spec.network. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Private Link Accesses (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Access. + content: + application/json: + schema: + type: object + description: >- + Add or remove access to PrivateLink endpoints by AWS account, + Azure subscription and GCP project ID. + + + Related guides: + + * [Use Google Cloud Private Service Connect with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + + * [Use Azure Private Link with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + + * [Use AWS PrivateLink with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + + ## The Private Link Accesses Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_accounts_per_network` | Number of AWS accounts + per network | + + | `private_link_subscriptions_per_network` | Number of Azure + subscriptions per network | + + | `private_service_connect_projects_per_network` | Number of + GCP projects per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccessList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + Add or remove access to PrivateLink endpoints by AWS + account, Azure subscription and GCP project ID. + + + Related guides: + + * [Use Google Cloud Private Service Connect with + Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + + * [Use Azure Private Link with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + + * [Use AWS PrivateLink with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + + ## The Private Link Accesses Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_accounts_per_network` | Number of AWS + accounts per network | + + | `private_link_subscriptions_per_network` | Number of + Azure subscriptions per network | + + | `private_service_connect_projects_per_network` | + Number of GCP projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAccessSpec + status: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAccessStatus + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1PrivateLinkAccess + summary: Create a Private Link Access + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a private link access. + tags: + - Private Link Accesses (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + Add or remove access to PrivateLink endpoints by AWS account, + Azure subscription and GCP project ID. + + + Related guides: + + * [Use Google Cloud Private Service Connect with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + + * [Use Azure Private Link with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + + * [Use AWS PrivateLink with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + + ## The Private Link Accesses Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_accounts_per_network` | Number of AWS accounts + per network | + + | `private_link_subscriptions_per_network` | Number of Azure + subscriptions per network | + + | `private_service_connect_projects_per_network` | Number of GCP + projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + required: + - spec + responses: + '202': + description: A Private Link Access is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: >- + https://api.confluent.cloud/networking/v1/private-link-accesses/{id} + description: PrivateLinkAccess resource uri + content: + application/json: + schema: + type: object + description: >- + Add or remove access to PrivateLink endpoints by AWS account, + Azure subscription and GCP project ID. + + + Related guides: + + * [Use Google Cloud Private Service Connect with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + + * [Use Azure Private Link with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + + * [Use AWS PrivateLink with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + + ## The Private Link Accesses Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_accounts_per_network` | Number of AWS accounts + per network | + + | `private_link_subscriptions_per_network` | Number of Azure + subscriptions per network | + + | `private_service_connect_projects_per_network` | Number of + GCP projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/private-link-accesses/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1PrivateLinkAccess + summary: Read a Private Link Access + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a private link access. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link access. + tags: + - Private Link Accesses (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Access. + content: + application/json: + schema: + type: object + description: >- + Add or remove access to PrivateLink endpoints by AWS account, + Azure subscription and GCP project ID. + + + Related guides: + + * [Use Google Cloud Private Service Connect with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + + * [Use Azure Private Link with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + + * [Use AWS PrivateLink with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + + ## The Private Link Accesses Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_accounts_per_network` | Number of AWS accounts + per network | + + | `private_link_subscriptions_per_network` | Number of Azure + subscriptions per network | + + | `private_service_connect_projects_per_network` | Number of + GCP projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1PrivateLinkAccess + summary: Update a Private Link Access + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a private link access. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link access. + tags: + - Private Link Accesses (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + Add or remove access to PrivateLink endpoints by AWS account, + Azure subscription and GCP project ID. + + + Related guides: + + * [Use Google Cloud Private Service Connect with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + + * [Use Azure Private Link with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + + * [Use AWS PrivateLink with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + + ## The Private Link Accesses Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_accounts_per_network` | Number of AWS accounts + per network | + + | `private_link_subscriptions_per_network` | Number of Azure + subscriptions per network | + + | `private_service_connect_projects_per_network` | Number of GCP + projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + required: + - spec + responses: + '200': + description: Private Link Access. + content: + application/json: + schema: + type: object + description: >- + Add or remove access to PrivateLink endpoints by AWS account, + Azure subscription and GCP project ID. + + + Related guides: + + * [Use Google Cloud Private Service Connect with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + + * [Use Azure Private Link with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + + * [Use AWS PrivateLink with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + + ## The Private Link Accesses Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_accounts_per_network` | Number of AWS accounts + per network | + + | `private_link_subscriptions_per_network` | Number of Azure + subscriptions per network | + + | `private_service_connect_projects_per_network` | Number of + GCP projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1PrivateLinkAccess + summary: Delete a Private Link Access + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a private link access. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link access. + tags: + - Private Link Accesses (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Private Link Access is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/network-link-services: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1NetworkLinkServices + summary: List of Network Link Services + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all network link + services. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-net-1-nls + - dev-net-1-nls + description: >- + Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - READY + description: >- + Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - n-00000 + - n-00001 + description: >- + Filter the results by exact match for spec.network. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Network Link Services (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Service. + content: + application/json: + schema: + type: object + description: >- + Network Link Service is associated with a Private Link + Confluent Cloud Network. + + It enables connectivity from other Private Link Confluent + Cloud Networks based on + + the configured accept policies. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Services Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_service_per_network` | Number of network link + services per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + Network Link Service is associated with a Private Link + Confluent Cloud Network. + + It enables connectivity from other Private Link + Confluent Cloud Networks based on + + the configured accept policies. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Services Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_service_per_network` | Number of network + link services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkServiceSpec + status: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkServiceStatus + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1NetworkLinkService + summary: Create a Network Link Service + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a network link service. + tags: + - Network Link Services (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + Network Link Service is associated with a Private Link Confluent + Cloud Network. + + It enables connectivity from other Private Link Confluent Cloud + Networks based on + + the configured accept policies. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Services Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_service_per_network` | Number of network link + services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceStatus' + required: + - spec + responses: + '202': + description: A Network Link Service is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: >- + https://api.confluent.cloud/networking/v1/network-link-services/{id} + description: NetworkLinkService resource uri + content: + application/json: + schema: + type: object + description: >- + Network Link Service is associated with a Private Link + Confluent Cloud Network. + + It enables connectivity from other Private Link Confluent + Cloud Networks based on + + the configured accept policies. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Services Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_service_per_network` | Number of network link + services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkServiceStatus + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/network-link-services/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1NetworkLinkService + summary: Read a Network Link Service + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a network link service. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link service. + tags: + - Network Link Services (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Service. + content: + application/json: + schema: + type: object + description: >- + Network Link Service is associated with a Private Link + Confluent Cloud Network. + + It enables connectivity from other Private Link Confluent + Cloud Networks based on + + the configured accept policies. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Services Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_service_per_network` | Number of network link + services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkServiceStatus + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1NetworkLinkService + summary: Update a Network Link Service + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a network link service. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link service. + tags: + - Network Link Services (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + Network Link Service is associated with a Private Link Confluent + Cloud Network. + + It enables connectivity from other Private Link Confluent Cloud + Networks based on + + the configured accept policies. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Services Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_service_per_network` | Number of network link + services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceStatus' + required: + - spec + responses: + '200': + description: Network Link Service. + content: + application/json: + schema: + type: object + description: >- + Network Link Service is associated with a Private Link + Confluent Cloud Network. + + It enables connectivity from other Private Link Confluent + Cloud Networks based on + + the configured accept policies. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Services Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_service_per_network` | Number of network link + services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkServiceStatus + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1NetworkLinkService + summary: Delete a Network Link Service + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a network link service. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link service. + tags: + - Network Link Services (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Network Link Service is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/network-link-endpoints: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1NetworkLinkEndpoints + summary: List of Network Link Endpoints + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all network link + endpoints. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-net-1-nle + - dev-net-1-nle + description: >- + Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - READY + - PENDING_ACCEPT + description: >- + Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - n-00000 + - n-00001 + description: >- + Filter the results by exact match for spec.network. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: spec.network_link_service + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - nls-abcde + - nls-00000 + description: >- + Filter the results by exact match for spec.network_link_service. + Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Network Link Endpoints (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Endpoint. + content: + application/json: + schema: + type: object + description: >- + A Network Link Enpoint is associated with a Private Link + Confluent Cloud Network at the origin and a + + Network Link Service (associated with another Private Link + Confluent Cloud Network) at the target. + + It enables connectivity between the origin network and the + target network. + + It can only be associated with a Private Link network. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Endpoints Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_endpoints_per_network` | Number of network + link endpoints per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpointList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + A Network Link Enpoint is associated with a Private Link + Confluent Cloud Network at the origin and a + + Network Link Service (associated with another Private + Link Confluent Cloud Network) at the target. + + It enables connectivity between the origin network and + the target network. + + It can only be associated with a Private Link network. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Endpoints Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_endpoints_per_network` | Number of + network link endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkEndpointSpec + status: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkEndpointStatus + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1NetworkLinkEndpoint + summary: Create a Network Link Endpoint + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a network link endpoint. + tags: + - Network Link Endpoints (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + A Network Link Enpoint is associated with a Private Link + Confluent Cloud Network at the origin and a + + Network Link Service (associated with another Private Link + Confluent Cloud Network) at the target. + + It enables connectivity between the origin network and the + target network. + + It can only be associated with a Private Link network. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Endpoints Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_endpoints_per_network` | Number of network link + endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointStatus' + required: + - spec + responses: + '202': + description: A Network Link Endpoint is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: >- + https://api.confluent.cloud/networking/v1/network-link-endpoints/{id} + description: NetworkLinkEndpoint resource uri + content: + application/json: + schema: + type: object + description: >- + A Network Link Enpoint is associated with a Private Link + Confluent Cloud Network at the origin and a + + Network Link Service (associated with another Private Link + Confluent Cloud Network) at the target. + + It enables connectivity between the origin network and the + target network. + + It can only be associated with a Private Link network. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Endpoints Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_endpoints_per_network` | Number of network + link endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkEndpointStatus + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/network-link-endpoints/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1NetworkLinkEndpoint + summary: Read a Network Link Endpoint + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a network link endpoint. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link endpoint. + tags: + - Network Link Endpoints (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Endpoint. + content: + application/json: + schema: + type: object + description: >- + A Network Link Enpoint is associated with a Private Link + Confluent Cloud Network at the origin and a + + Network Link Service (associated with another Private Link + Confluent Cloud Network) at the target. + + It enables connectivity between the origin network and the + target network. + + It can only be associated with a Private Link network. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Endpoints Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_endpoints_per_network` | Number of network + link endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkEndpointStatus + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1NetworkLinkEndpoint + summary: Update a Network Link Endpoint + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a network link endpoint. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link endpoint. + tags: + - Network Link Endpoints (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + A Network Link Enpoint is associated with a Private Link + Confluent Cloud Network at the origin and a + + Network Link Service (associated with another Private Link + Confluent Cloud Network) at the target. + + It enables connectivity between the origin network and the + target network. + + It can only be associated with a Private Link network. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Endpoints Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_endpoints_per_network` | Number of network link + endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointStatus' + required: + - spec + responses: + '200': + description: Network Link Endpoint. + content: + application/json: + schema: + type: object + description: >- + A Network Link Enpoint is associated with a Private Link + Confluent Cloud Network at the origin and a + + Network Link Service (associated with another Private Link + Confluent Cloud Network) at the target. + + It enables connectivity between the origin network and the + target network. + + It can only be associated with a Private Link network. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Endpoints Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_endpoints_per_network` | Number of network + link endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkEndpointStatus + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1NetworkLinkEndpoint + summary: Delete a Network Link Endpoint + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a network link endpoint. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link endpoint. + tags: + - Network Link Endpoints (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Network Link Endpoint is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/network-link-service-associations: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1NetworkLinkServiceAssociations + summary: List of Network Link Service Associations + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all network link service + associations. + parameters: + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - READY + - PENDING_ACCEPT + description: >- + Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: spec.network_link_service + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: nls-abcde + description: Filter the results by exact match for spec.network_link_service. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Network Link Service Associations (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Service Association. + content: + application/json: + schema: + type: object + description: >- + List of incoming Network Link Enpoints associated with the + Network Link Service. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Service Associations Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceAssociationList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + List of incoming Network Link Enpoints associated with + the Network Link Service. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Service Associations Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - NetworkLinkServiceAssociation + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkServiceAssociationSpec + status: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkServiceAssociationStatus + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/network-link-service-associations/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1NetworkLinkServiceAssociation + summary: Read a Network Link Service Association + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a network link service association. + parameters: + - name: spec.network_link_service + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: nls-abcde + description: Scope the operation to the given spec.network_link_service. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link service association. + tags: + - Network Link Service Associations (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Service Association. + content: + application/json: + schema: + type: object + description: >- + List of incoming Network Link Enpoints associated with the + Network Link Service. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Service Associations Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceAssociation + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkServiceAssociationSpec + status: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkServiceAssociationStatus + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/ip-addresses: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1IpAddresses + summary: List of IP Addresses + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Related guide: [Use Public Egress IP addresses on Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + + Retrieve a sorted, filtered, paginated list of all IP Addresses. + parameters: + - name: cloud + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - GCP + - AWS + description: >- + Filter the results by exact match for cloud. Pass multiple times to + see results matching any of the values. + style: form + explode: true + - name: region + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - us-central1 + - us-east-1 + description: >- + Filter the results by exact match for region. Pass multiple times to + see results matching any of the values. + style: form + explode: true + - name: services + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - KAFKA + - CONNECT + description: >- + Filter the results by exact match for services. Pass multiple times + to see results matching any of the values. + style: form + explode: true + - name: address_type + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - INGRESS + - EGRESS + description: >- + Filter the results by exact match for address_type. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - IP Addresses (networking/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: IP Address. + content: + application/json: + schema: + type: object + description: >- + IP Addresses + + + Related guide: [Use Public Egress IP Addresses on Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + + ## The IP Addresses Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpAddressList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + IP Addresses + + + Related guide: [Use Public Egress IP addresses on + Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + + ## The IP Addresses Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - IpAddress + ip_prefix: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+/\d+$ + description: The IP Address range. + example: 10.200.0.0/28 + cloud: + type: string + description: >- + The cloud service provider in which the address + exists. + x-extensible-enum: + - AWS + - GCP + - AZURE + - ANY + example: AWS + region: + type: string + description: The region/location where the IP Address is in use. + example: us-east-1 + services: + type: array + description: The service types that will use the address. + items: + type: string + description: Address service type. + x-extensible-enum: + - KAFKA + - CONNECT + - EXTERNAL_OAUTH + example: CONNECT + uniqueItems: true + minItems: 1 + address_type: + type: string + description: Whether the address is used for egress or ingress. + x-extensible-enum: + - INGRESS + - EGRESS + example: EGRESS + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/private-link-attachments: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1PrivateLinkAttachments + summary: List of Private Link Attachments + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all private link + attachments. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-gcp-us-central1 + - prod-aws-useast1 + description: >- + Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.cloud + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - GCP + - AWS + description: >- + Filter the results by exact match for spec.cloud. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: spec.region + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - us-central1 + - us-east-1 + description: >- + Filter the results by exact match for spec.region. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - PROVISIONING + - READY + description: >- + Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Private Link Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Attachment. + content: + application/json: + schema: + type: object + description: >- + PrivateLink attachment objects represent reservations to + establish PrivateLink connections + + to a cloud region in order to access resources that belong to + a Confluent Cloud Environment. + + The API allows you to list, create, read update and delete + your PrivateLink attachments. + + + + ## The Private Link Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_attachments_per_environment` | Number of + PrivateLink Attachments per environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + PrivateLink attachment objects represent reservations to + establish PrivateLink connections + + to a cloud region in order to access resources that + belong to a Confluent Cloud Environment. + + The API allows you to list, create, read update and + delete your PrivateLink attachments. + + + + ## The Private Link Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_attachments_per_environment` | Number of + PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentSpec + status: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentStatus + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1PrivateLinkAttachment + summary: Create a Private Link Attachment + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a private link attachment. + tags: + - Private Link Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + PrivateLink attachment objects represent reservations to + establish PrivateLink connections + + to a cloud region in order to access resources that belong to a + Confluent Cloud Environment. + + The API allows you to list, create, read update and delete your + PrivateLink attachments. + + + + ## The Private Link Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_attachments_per_environment` | Number of + PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentSpec' + status: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentStatus + required: + - spec + responses: + '202': + description: A Private Link Attachment is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: >- + https://api.confluent.cloud/networking/v1/private-link-attachments/{id} + description: PrivateLinkAttachment resource uri + content: + application/json: + schema: + type: object + description: >- + PrivateLink attachment objects represent reservations to + establish PrivateLink connections + + to a cloud region in order to access resources that belong to + a Confluent Cloud Environment. + + The API allows you to list, create, read update and delete + your PrivateLink attachments. + + + + ## The Private Link Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_attachments_per_environment` | Number of + PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentSpec + status: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentStatus + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/private-link-attachments/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1PrivateLinkAttachment + summary: Read a Private Link Attachment + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a private link attachment. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment. + tags: + - Private Link Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Attachment. + content: + application/json: + schema: + type: object + description: >- + PrivateLink attachment objects represent reservations to + establish PrivateLink connections + + to a cloud region in order to access resources that belong to + a Confluent Cloud Environment. + + The API allows you to list, create, read update and delete + your PrivateLink attachments. + + + + ## The Private Link Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_attachments_per_environment` | Number of + PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentSpec + status: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentStatus + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1PrivateLinkAttachment + summary: Update a Private Link Attachment + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a private link attachment. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment. + tags: + - Private Link Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + PrivateLink attachment objects represent reservations to + establish PrivateLink connections + + to a cloud region in order to access resources that belong to a + Confluent Cloud Environment. + + The API allows you to list, create, read update and delete your + PrivateLink attachments. + + + + ## The Private Link Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_attachments_per_environment` | Number of + PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentSpec' + status: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentStatus + required: + - spec + responses: + '200': + description: Private Link Attachment. + content: + application/json: + schema: + type: object + description: >- + PrivateLink attachment objects represent reservations to + establish PrivateLink connections + + to a cloud region in order to access resources that belong to + a Confluent Cloud Environment. + + The API allows you to list, create, read update and delete + your PrivateLink attachments. + + + + ## The Private Link Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_attachments_per_environment` | Number of + PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentSpec + status: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentStatus + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1PrivateLinkAttachment + summary: Delete a Private Link Attachment + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a private link attachment. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment. + tags: + - Private Link Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Private Link Attachment is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/private-link-attachment-connections: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1PrivateLinkAttachmentConnections + summary: List of Private Link Attachment Connections + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all private link + attachment connections. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.private_link_attachment + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: platt-00000 + description: Filter the results by exact match for spec.private_link_attachment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Private Link Attachment Connections (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Attachment Connection. + content: + application/json: + schema: + type: object + description: >- + PrivateLink attachment connection objects represent + connections established to a cloud region + + in order to access resources that belong to a Confluent Cloud + Environment. + + The API allows you to list, create, read update and delete + your PrivateLink attachment connections. + + + + ## The Private Link Attachment Connections Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnectionList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + PrivateLink attachment connection objects represent + connections established to a cloud region + + in order to access resources that belong to a Confluent + Cloud Environment. + + The API allows you to list, create, read update and + delete your PrivateLink attachment connections. + + + + ## The Private Link Attachment Connections Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec + status: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1PrivateLinkAttachmentConnection + summary: Create a Private Link Attachment Connection + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a private link attachment connection. + tags: + - Private Link Attachment Connections (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + PrivateLink attachment connection objects represent connections + established to a cloud region + + in order to access resources that belong to a Confluent Cloud + Environment. + + The API allows you to list, create, read update and delete your + PrivateLink attachment connections. + + + + ## The Private Link Attachment Connections Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec + status: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus + required: + - spec + responses: + '202': + description: A Private Link Attachment Connection is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: >- + https://api.confluent.cloud/networking/v1/private-link-attachment-connections/{id} + description: PrivateLinkAttachmentConnection resource uri + content: + application/json: + schema: + type: object + description: >- + PrivateLink attachment connection objects represent + connections established to a cloud region + + in order to access resources that belong to a Confluent Cloud + Environment. + + The API allows you to list, create, read update and delete + your PrivateLink attachment connections. + + + + ## The Private Link Attachment Connections Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec + status: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/private-link-attachment-connections/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1PrivateLinkAttachmentConnection + summary: Read a Private Link Attachment Connection + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a private link attachment connection. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment connection. + tags: + - Private Link Attachment Connections (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Attachment Connection. + content: + application/json: + schema: + type: object + description: >- + PrivateLink attachment connection objects represent + connections established to a cloud region + + in order to access resources that belong to a Confluent Cloud + Environment. + + The API allows you to list, create, read update and delete + your PrivateLink attachment connections. + + + + ## The Private Link Attachment Connections Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec + status: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1PrivateLinkAttachmentConnection + summary: Update a Private Link Attachment Connection + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a private link attachment connection. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment connection. + tags: + - Private Link Attachment Connections (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + PrivateLink attachment connection objects represent connections + established to a cloud region + + in order to access resources that belong to a Confluent Cloud + Environment. + + The API allows you to list, create, read update and delete your + PrivateLink attachment connections. + + + + ## The Private Link Attachment Connections Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec + status: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus + required: + - spec + responses: + '200': + description: Private Link Attachment Connection. + content: + application/json: + schema: + type: object + description: >- + PrivateLink attachment connection objects represent + connections established to a cloud region + + in order to access resources that belong to a Confluent Cloud + Environment. + + The API allows you to list, create, read update and delete + your PrivateLink attachment connections. + + + + ## The Private Link Attachment Connections Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec + status: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1PrivateLinkAttachmentConnection + summary: Delete a Private Link Attachment Connection + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a private link attachment connection. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment connection. + tags: + - Private Link Attachment Connections (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Private Link Attachment Connection is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/dns-forwarders: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1DnsForwarders + summary: List of DNS Forwarders + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all DNS forwarders. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - DNS Forwarders (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: DNS Forwarder. + content: + application/json: + schema: + type: object + description: >- + Add, remove, and update DNS forwarder for your gateway. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + + ## The DNS Forwarders Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarderList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + Add, remove, and update DNS forwarder for your gateway. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + + ## The DNS Forwarders Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - DnsForwarder + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: >- + #/components/schemas/networking.v1.DnsForwarderStatus + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1DnsForwarder + summary: Create a DNS Forwarder + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a DNS forwarder. + tags: + - DNS Forwarders (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + Add, remove, and update DNS forwarder for your gateway. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + + ## The DNS Forwarders Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + required: + - spec + responses: + '202': + description: A DNS Forwarder is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/dns-forwarders/{id} + description: DnsForwarder resource uri + content: + application/json: + schema: + type: object + description: >- + Add, remove, and update DNS forwarder for your gateway. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + + ## The DNS Forwarders Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/dns-forwarders/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1DnsForwarder + summary: Read a DNS Forwarder + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a DNS forwarder. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS forwarder. + tags: + - DNS Forwarders (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: DNS Forwarder. + content: + application/json: + schema: + type: object + description: >- + Add, remove, and update DNS forwarder for your gateway. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + + ## The DNS Forwarders Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1DnsForwarder + summary: Update a DNS Forwarder + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a DNS forwarder. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS forwarder. + tags: + - DNS Forwarders (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + Add, remove, and update DNS forwarder for your gateway. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + + ## The DNS Forwarders Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + required: + - spec + responses: + '200': + description: DNS Forwarder. + content: + application/json: + schema: + type: object + description: >- + Add, remove, and update DNS forwarder for your gateway. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + + ## The DNS Forwarders Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1DnsForwarder + summary: Delete a DNS Forwarder + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a DNS forwarder. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS forwarder. + tags: + - DNS Forwarders (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A DNS Forwarder is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/access-points: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1AccessPoints + summary: List of Access Points + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all access points. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-ap-egress-use1 + - prod-ap-egress-usw2 + description: >- + Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.gateway + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - gw-00000 + - gw-00001 + description: >- + Filter the results by exact match for spec.gateway. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: id + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - ap-1 + - ap-2 + description: >- + Filter the results by exact match for id. Pass multiple times to see + results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Access Points (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Access Point. + content: + application/json: + schema: + type: object + description: >- + AccessPoint objects represent network connections in and out + of Gateways. + + This API allows you to list, create, read, update, and delete + your access points. + + + + ## The Access Points Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPointList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + AccessPoint objects represent network connections in and + out of Gateways. + + This API allows you to list, create, read, update, and + delete your access points. + + + + ## The Access Points Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - AccessPoint + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1AccessPoint + summary: Create an Access Point + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create an access point. + tags: + - Access Points (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + AccessPoint objects represent network connections in and out of + Gateways. + + This API allows you to list, create, read, update, and delete + your access points. + + + + ## The Access Points Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + required: + - spec + responses: + '202': + description: An Access Point is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/access-points/{id} + description: AccessPoint resource uri + content: + application/json: + schema: + type: object + description: >- + AccessPoint objects represent network connections in and out + of Gateways. + + This API allows you to list, create, read, update, and delete + your access points. + + + + ## The Access Points Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/access-points/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1AccessPoint + summary: Read an Access Point + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read an access point. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the access point. + tags: + - Access Points (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Access Point. + content: + application/json: + schema: + type: object + description: >- + AccessPoint objects represent network connections in and out + of Gateways. + + This API allows you to list, create, read, update, and delete + your access points. + + + + ## The Access Points Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1AccessPoint + summary: Update an Access Point + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update an access point. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the access point. + tags: + - Access Points (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + AccessPoint objects represent network connections in and out of + Gateways. + + This API allows you to list, create, read, update, and delete + your access points. + + + + ## The Access Points Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + required: + - spec + responses: + '200': + description: Access Point. + content: + application/json: + schema: + type: object + description: >- + AccessPoint objects represent network connections in and out + of Gateways. + + This API allows you to list, create, read, update, and delete + your access points. + + + + ## The Access Points Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1AccessPoint + summary: Delete an Access Point + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete an access point. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the access point. + tags: + - Access Points (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Access Point is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/dns-records: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1DnsRecords + summary: List of DNS Records + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all DNS records. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-dnsrec-1 + - prod-dnsrec-2 + description: >- + Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.domain + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - example.com + - example2.com + description: >- + Filter the results by exact match for spec.domain. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.gateway + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - gw-00000 + - gw-00001 + description: >- + Filter the results by exact match for spec.gateway. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: resource + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - ap-11111 + - ap-22222 + description: >- + Filter the results by exact match for resource. Pass multiple times + to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - DNS Records (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: DNS Record. + content: + application/json: + schema: + type: object + description: >- + DNS record objects are associated with Confluent Cloud + networking resources. This API allows you to list, create, + read, update, and delete your DNS records. + + + ## The DNS Records Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecordList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + DNS record objects are associated with Confluent Cloud + networking resources. This API allows you to list, + create, read, update, and delete your DNS records. + + + ## The DNS Records Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - DnsRecord + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1DnsRecord + summary: Create a DNS Record + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a DNS record. + tags: + - DNS Records (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + DNS record objects are associated with Confluent Cloud + networking resources. This API allows you to list, create, read, + update, and delete your DNS records. + + + ## The DNS Records Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + required: + - spec + responses: + '202': + description: A DNS Record is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/dns-records/{id} + description: DnsRecord resource uri + content: + application/json: + schema: + type: object + description: >- + DNS record objects are associated with Confluent Cloud + networking resources. This API allows you to list, create, + read, update, and delete your DNS records. + + + ## The DNS Records Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/dns-records/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1DnsRecord + summary: Read a DNS Record + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a DNS record. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS record. + tags: + - DNS Records (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: DNS Record. + content: + application/json: + schema: + type: object + description: >- + DNS record objects are associated with Confluent Cloud + networking resources. This API allows you to list, create, + read, update, and delete your DNS records. + + + ## The DNS Records Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1DnsRecord + summary: Update a DNS Record + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a DNS record. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS record. + tags: + - DNS Records (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + DNS record objects are associated with Confluent Cloud + networking resources. This API allows you to list, create, read, + update, and delete your DNS records. + + + ## The DNS Records Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + required: + - spec + responses: + '200': + description: DNS Record. + content: + application/json: + schema: + type: object + description: >- + DNS record objects are associated with Confluent Cloud + networking resources. This API allows you to list, create, + read, update, and delete your DNS records. + + + ## The DNS Records Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1DnsRecord + summary: Delete a DNS Record + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a DNS record. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS record. + tags: + - DNS Records (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A DNS Record is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/gateways: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1Gateways + summary: List of Gateways + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all gateways. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: gateway_type + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - AwsEgressPrivateLink + - AzureEgressPrivateLink + description: >- + Filter the results by exact match for gateway_type. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: id + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - gw-1 + - gw-2 + description: >- + Filter the results by exact match for id. Pass multiple times to see + results matching any of the values. + style: form + explode: true + - name: spec.config.region + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - us-east-1 + - us-west-2 + description: >- + Filter the results by exact match for spec.config.region. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-gateway-ingress-use1 + - prod-gateway-ingress-use2 + description: >- + Filter the results by exact match for spec.display_name. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - PROVISIONING + - READY + description: >- + Filter the results by exact match for status.phase. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Gateways (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Gateway. + content: + application/json: + schema: + type: object + description: >- + A Gateway represents a slice of traffic capacity in a region + that is reserved for a customer. + + + + ## The Gateways Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `gateways_per_region_per_environment` | Number of Gateways + per region per environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GatewayList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + A Gateway represents a slice of traffic capacity in a + region that is reserved for a customer. + + + + ## The Gateways Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `gateways_per_region_per_environment` | Number of + Gateways per region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Gateway + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1Gateway + summary: Create a Gateway + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a gateway. + tags: + - Gateways (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + A Gateway represents a slice of traffic capacity in a region + that is reserved for a customer. + + + + ## The Gateways Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `gateways_per_region_per_environment` | Number of Gateways per + region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + required: + - spec + responses: + '202': + description: A Gateway is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/gateways/{id} + description: Gateway resource uri + content: + application/json: + schema: + type: object + description: >- + A Gateway represents a slice of traffic capacity in a region + that is reserved for a customer. + + + + ## The Gateways Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `gateways_per_region_per_environment` | Number of Gateways + per region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/gateways/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1Gateway + summary: Read a Gateway + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a gateway. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the gateway. + tags: + - Gateways (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Gateway. + content: + application/json: + schema: + type: object + description: >- + A Gateway represents a slice of traffic capacity in a region + that is reserved for a customer. + + + + ## The Gateways Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `gateways_per_region_per_environment` | Number of Gateways + per region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1Gateway + summary: Update a Gateway + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a gateway. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the gateway. + tags: + - Gateways (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + A Gateway represents a slice of traffic capacity in a region + that is reserved for a customer. + + + + ## The Gateways Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `gateways_per_region_per_environment` | Number of Gateways per + region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + required: + - spec + responses: + '200': + description: Gateway. + content: + application/json: + schema: + type: object + description: >- + A Gateway represents a slice of traffic capacity in a region + that is reserved for a customer. + + + + ## The Gateways Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `gateways_per_region_per_environment` | Number of Gateways + per region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1Gateway + summary: Delete a Gateway + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a gateway. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the gateway. + tags: + - Gateways (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Gateway is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + MultipleSearchFilter: + description: Filter a collection by a string search for one or more values + type: array + items: + type: string + SearchFilter: + description: Filter a collection by a string search + type: string + networking.v1.NetworkList: + type: object + description: >- + `Network` represents a network (VPC) in Confluent Cloud. All Networks + exist within Confluent-managed cloud + + provider accounts. Dedicated networks support more networking options + but can only contain Dedicated clusters. + + Shared networks can contain any cluster type. + + + The API allows you to list, create, read, update, and delete your + networks. + + + + Related guide: [APIs to manage networks in Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Networks Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `dedicated_networks_per_environment` | Number of dedicated networks + per Confluent Cloud environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Network` represents a network (VPC) in Confluent Cloud. All + Networks exist within Confluent-managed cloud + + provider accounts. Dedicated networks support more networking + options but can only contain Dedicated clusters. + + Shared networks can contain any cluster type. + + + The API allows you to list, create, read, update, and delete your + networks. + + + + Related guide: [APIs to manage networks in Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Networks Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `dedicated_networks_per_environment` | Number of dedicated + networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.Network: + type: object + description: >- + `Network` represents a network (VPC) in Confluent Cloud. All Networks + exist within Confluent-managed cloud + + provider accounts. Dedicated networks support more networking options + but can only contain Dedicated clusters. + + Shared networks can contain any cluster type. + + + The API allows you to list, create, read, update, and delete your + networks. + + + + Related guide: [APIs to manage networks in Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Networks Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `dedicated_networks_per_environment` | Number of dedicated networks + per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + networking.v1.PeeringList: + type: object + description: >- + Add or remove VPC/VNet peering connections between your VPC/VNet and + Confluent Cloud. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + * [Use VPC peering connections with Confluent Cloud on Google + Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + + ## The Peerings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `peerings_per_network` | Number of peerings per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PeeringList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + Add or remove VPC/VNet peering connections between your VPC/VNet + and Confluent Cloud. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + * [Use VPC peering connections with Confluent Cloud on Google + Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + + ## The Peerings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.Peering: + type: object + description: >- + Add or remove VPC/VNet peering connections between your VPC/VNet and + Confluent Cloud. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + * [Use VPC peering connections with Confluent Cloud on Google + Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + + ## The Peerings Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + networking.v1.TransitGatewayAttachmentList: + type: object + description: >- + AWS Transit Gateway Attachments + + + Related guide: [APIs to manage AWS Transit Gateway + Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + + ## The Transit Gateway Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `tgw_attachments_per_network` | Number of TGW attachments per network + | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachmentList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + AWS Transit Gateway Attachments + + + Related guide: [APIs to manage AWS Transit Gateway + Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + + ## The Transit Gateway Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `tgw_attachments_per_network` | Number of TGW attachments per + network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.TransitGatewayAttachmentSpec + status: + $ref: >- + #/components/schemas/networking.v1.TransitGatewayAttachmentStatus + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.TransitGatewayAttachment: + type: object + description: >- + AWS Transit Gateway Attachments + + + Related guide: [APIs to manage AWS Transit Gateway + Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + + ## The Transit Gateway Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `tgw_attachments_per_network` | Number of TGW attachments per network + | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentStatus' + networking.v1.PrivateLinkAccessList: + type: object + description: >- + Add or remove access to PrivateLink endpoints by AWS account, Azure + subscription and GCP project ID. + + + Related guides: + + * [Use Google Cloud Private Service Connect with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + + * [Use Azure Private Link with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + + * [Use AWS PrivateLink with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + + ## The Private Link Accesses Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_accounts_per_network` | Number of AWS accounts per + network | + + | `private_link_subscriptions_per_network` | Number of Azure + subscriptions per network | + + | `private_service_connect_projects_per_network` | Number of GCP + projects per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccessList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + Add or remove access to PrivateLink endpoints by AWS account, + Azure subscription and GCP project ID. + + + Related guides: + + * [Use Google Cloud Private Service Connect with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + + * [Use Azure Private Link with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + + * [Use AWS PrivateLink with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + + ## The Private Link Accesses Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_accounts_per_network` | Number of AWS accounts per + network | + + | `private_link_subscriptions_per_network` | Number of Azure + subscriptions per network | + + | `private_service_connect_projects_per_network` | Number of GCP + projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.PrivateLinkAccess: + type: object + description: >- + Add or remove access to PrivateLink endpoints by AWS account, Azure + subscription and GCP project ID. + + + Related guides: + + * [Use Google Cloud Private Service Connect with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + + * [Use Azure Private Link with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + + * [Use AWS PrivateLink with Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + + ## The Private Link Accesses Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_accounts_per_network` | Number of AWS accounts per + network | + + | `private_link_subscriptions_per_network` | Number of Azure + subscriptions per network | + + | `private_service_connect_projects_per_network` | Number of GCP + projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + networking.v1.NetworkLinkServiceList: + type: object + description: >- + Network Link Service is associated with a Private Link Confluent Cloud + Network. + + It enables connectivity from other Private Link Confluent Cloud Networks + based on + + the configured accept policies. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Services Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_service_per_network` | Number of network link services + per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + Network Link Service is associated with a Private Link Confluent + Cloud Network. + + It enables connectivity from other Private Link Confluent Cloud + Networks based on + + the configured accept policies. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Services Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_service_per_network` | Number of network link + services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.NetworkLinkService: + type: object + description: >- + Network Link Service is associated with a Private Link Confluent Cloud + Network. + + It enables connectivity from other Private Link Confluent Cloud Networks + based on + + the configured accept policies. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Services Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_service_per_network` | Number of network link services + per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceStatus' + networking.v1.NetworkLinkEndpointList: + type: object + description: >- + A Network Link Enpoint is associated with a Private Link Confluent Cloud + Network at the origin and a + + Network Link Service (associated with another Private Link Confluent + Cloud Network) at the target. + + It enables connectivity between the origin network and the target + network. + + It can only be associated with a Private Link network. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Endpoints Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_endpoints_per_network` | Number of network link + endpoints per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpointList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + A Network Link Enpoint is associated with a Private Link Confluent + Cloud Network at the origin and a + + Network Link Service (associated with another Private Link + Confluent Cloud Network) at the target. + + It enables connectivity between the origin network and the target + network. + + It can only be associated with a Private Link network. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Endpoints Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_endpoints_per_network` | Number of network link + endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.NetworkLinkEndpoint: + type: object + description: >- + A Network Link Enpoint is associated with a Private Link Confluent Cloud + Network at the origin and a + + Network Link Service (associated with another Private Link Confluent + Cloud Network) at the target. + + It enables connectivity between the origin network and the target + network. + + It can only be associated with a Private Link network. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Endpoints Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `network_link_endpoints_per_network` | Number of network link + endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointStatus' + networking.v1.NetworkLinkServiceAssociationList: + type: object + description: >- + List of incoming Network Link Enpoints associated with the Network Link + Service. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Service Associations Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceAssociationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + List of incoming Network Link Enpoints associated with the Network + Link Service. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Service Associations Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceAssociation + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkServiceAssociationSpec + status: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkServiceAssociationStatus + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.NetworkLinkServiceAssociation: + type: object + description: >- + List of incoming Network Link Enpoints associated with the Network Link + Service. + + + + Related guide: [Network Linking + Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + + ## The Network Link Service Associations Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceAssociation + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceAssociationSpec' + status: + $ref: >- + #/components/schemas/networking.v1.NetworkLinkServiceAssociationStatus + networking.v1.IpAddressList: + type: object + description: >- + IP Addresses + + + Related guide: [Use Public Egress IP Addresses on Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + + ## The IP Addresses Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpAddressList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + IP Addresses + + + Related guide: [Use Public Egress IP addresses on Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + + ## The IP Addresses Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpAddress + ip_prefix: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+/\d+$ + description: The IP Address range. + example: 10.200.0.0/28 + cloud: + type: string + description: The cloud service provider in which the address exists. + x-extensible-enum: + - AWS + - GCP + - AZURE + - ANY + example: AWS + region: + type: string + description: The region/location where the IP Address is in use. + example: us-east-1 + services: + type: array + description: The service types that will use the address. + items: + type: string + description: Address service type. + x-extensible-enum: + - KAFKA + - CONNECT + - EXTERNAL_OAUTH + example: CONNECT + uniqueItems: true + minItems: 1 + address_type: + type: string + description: Whether the address is used for egress or ingress. + x-extensible-enum: + - INGRESS + - EGRESS + example: EGRESS + uniqueItems: true + networking.v1.PrivateLinkAttachmentList: + type: object + description: >- + PrivateLink attachment objects represent reservations to establish + PrivateLink connections + + to a cloud region in order to access resources that belong to a + Confluent Cloud Environment. + + The API allows you to list, create, read update and delete your + PrivateLink attachments. + + + + ## The Private Link Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_attachments_per_environment` | Number of PrivateLink + Attachments per environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + PrivateLink attachment objects represent reservations to establish + PrivateLink connections + + to a cloud region in order to access resources that belong to a + Confluent Cloud Environment. + + The API allows you to list, create, read update and delete your + PrivateLink attachments. + + + + ## The Private Link Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_attachments_per_environment` | Number of + PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.PrivateLinkAttachment: + type: object + description: >- + PrivateLink attachment objects represent reservations to establish + PrivateLink connections + + to a cloud region in order to access resources that belong to a + Confluent Cloud Environment. + + The API allows you to list, create, read update and delete your + PrivateLink attachments. + + + + ## The Private Link Attachments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `private_link_attachments_per_environment` | Number of PrivateLink + Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentStatus' + networking.v1.PrivateLinkAttachmentConnectionList: + type: object + description: >- + PrivateLink attachment connection objects represent connections + established to a cloud region + + in order to access resources that belong to a Confluent Cloud + Environment. + + The API allows you to list, create, read update and delete your + PrivateLink attachment connections. + + + + ## The Private Link Attachment Connections Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnectionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + PrivateLink attachment connection objects represent connections + established to a cloud region + + in order to access resources that belong to a Confluent Cloud + Environment. + + The API allows you to list, create, read update and delete your + PrivateLink attachment connections. + + + + ## The Private Link Attachment Connections Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec + status: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.PrivateLinkAttachmentConnection: + type: object + description: >- + PrivateLink attachment connection objects represent connections + established to a cloud region + + in order to access resources that belong to a Confluent Cloud + Environment. + + The API allows you to list, create, read update and delete your + PrivateLink attachment connections. + + + + ## The Private Link Attachment Connections Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec + status: + $ref: >- + #/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus + networking.v1.DnsForwarderList: + type: object + description: >- + Add, remove, and update DNS forwarder for your gateway. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + + ## The DNS Forwarders Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarderList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + Add, remove, and update DNS forwarder for your gateway. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + + ## The DNS Forwarders Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.DnsForwarder: + type: object + description: >- + Add, remove, and update DNS forwarder for your gateway. + + + Related guides: + + * [Use VPC peering connections with Confluent Cloud on + AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + + * [Use VNet peering connections with Confluent Cloud on + Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + + ## The DNS Forwarders Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + networking.v1.AccessPointList: + type: object + description: >- + AccessPoint objects represent network connections in and out of + Gateways. + + This API allows you to list, create, read, update, and delete your + access points. + + + + ## The Access Points Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPointList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + AccessPoint objects represent network connections in and out of + Gateways. + + This API allows you to list, create, read, update, and delete your + access points. + + + + ## The Access Points Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.AccessPoint: + type: object + description: >- + AccessPoint objects represent network connections in and out of + Gateways. + + This API allows you to list, create, read, update, and delete your + access points. + + + + ## The Access Points Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + networking.v1.DnsRecordList: + type: object + description: >- + DNS record objects are associated with Confluent Cloud networking + resources. This API allows you to list, create, read, update, and delete + your DNS records. + + + ## The DNS Records Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecordList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + DNS record objects are associated with Confluent Cloud networking + resources. This API allows you to list, create, read, update, and + delete your DNS records. + + + ## The DNS Records Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.DnsRecord: + type: object + description: >- + DNS record objects are associated with Confluent Cloud networking + resources. This API allows you to list, create, read, update, and delete + your DNS records. + + + ## The DNS Records Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + networking.v1.GatewayList: + type: object + description: >- + A Gateway represents a slice of traffic capacity in a region that is + reserved for a customer. + + + + ## The Gateways Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `gateways_per_region_per_environment` | Number of Gateways per region + per environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GatewayList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + A Gateway represents a slice of traffic capacity in a region that + is reserved for a customer. + + + + ## The Gateways Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `gateways_per_region_per_environment` | Number of Gateways per + region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.Gateway: + type: object + description: >- + A Gateway represents a slice of traffic capacity in a region that is + reserved for a customer. + + + + ## The Gateways Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `gateways_per_region_per_environment` | Number of Gateways per region + per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + networking.v1.NetworkSpec: + type: object + description: The desired state of the Network + properties: + display_name: + type: string + description: The name of the network + example: prod-aws-us-east1 + cloud: + type: string + description: The cloud service provider in which the network exists. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: The cloud service provider region in which the network exists. + example: us-east-1 + x-immutable: true + connection_types: + type: array + description: The connection types requested for use with the network. + items: + $ref: '#/components/schemas/networking.v1.ConnectionType' + uniqueItems: true + minItems: 1 + x-immutable: true + cidr: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+/\d+$ + description: > + The IPv4 [CIDR + block](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + to used for this network. + + Must be `/16`. Required for VPC peering and AWS TransitGateway. + example: 10.200.0.0/16 + x-immutable: true + zones: + type: array + items: + type: string + uniqueItems: true + minItems: 3 + maxItems: 3 + description: > + The 3 availability zones for this network. They can optionally be + specified for AWS networks + + used with PrivateLink, for GCP networks used with Private Service + Connect, and for AWS and GCP + + networks used with Peering. + + Otherwise, they are automatically chosen by Confluent Cloud. + + + On AWS, zones are AWS [AZ + IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) + (e.g. use1-az3) + + On GCP, zones are GCP + [zones](https://cloud.google.com/compute/docs/regions-zones) + (e.g. us-central1-c). + + On Azure, zones are Confluent-chosen names (e.g. 1, 2, 3) since + Azure does not + have universal zone identifiers. + example: + - use1-az1 + - use1-az2 + - use1-az3 + x-immutable: true + zones_info: + type: array + minItems: 3 + maxItems: 3 + uniqueItems: true + items: + $ref: '#/components/schemas/networking.v1.ZoneInfo' + description: > + Each item represents information related to a single zone. + + + Note - The attribute is in a [Limited Availability lifecycle + stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + x-immutable: true + dns_config: + description: > + DNS config only applies to PrivateLink network connection type. + + + When resolution is CHASED_PRIVATE, clusters in this network require + both public and private DNS + to resolve cluster endpoints. + + When resolution is PRIVATE, clusters in this network only require + private DNS + to resolve cluster endpoints. + x-immutable: true + type: object + required: + - resolution + properties: + resolution: + type: string + description: Network DNS resolution type. + x-extensible-enum: + - CHASED_PRIVATE + - PRIVATE + reserved_cidr: + type: string + description: > + The reserved CIDR config is used only by AWS networks with + connection_types = Vpc_Peering or Transit_Gateway + + + An IPv4 + [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + reserved for Confluent Cloud Network. Must be \24. + If not specified, Confluent Cloud Network uses 172.20.255.0/24 + + Note - The attribute is in a [Limited Availability lifecycle + stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: 172.20.255.0/24 + x-immutable: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + gateway: + nullable: true + description: >- + The gateway associated with this object. The gateway can be one of + networking.v1.Gateway. May be `null` or omitted if not associated + with a gateway. + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.NetworkStatus: + type: object + required: + - phase + - supported_connection_types + - active_connection_types + description: The status of the Network + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - READY + - FAILED + - DEPROVISIONING + description: | + The lifecyle phase of the network: + + PROVISIONING: network provisioning is in progress; + + READY: network is ready; + + FAILED: provisioning failed; + + DEPROVISIONING: network deprovisioning is in progress; + readOnly: true + example: READY + supported_connection_types: + type: array + description: The connection types this network supports. + items: + $ref: '#/components/schemas/networking.v1.ConnectionType' + uniqueItems: true + minItems: 1 + readOnly: true + active_connection_types: + type: array + description: The connection types requested for use with the network. + items: + $ref: '#/components/schemas/networking.v1.ConnectionType' + uniqueItems: true + minItems: 1 + readOnly: true + error_code: + type: string + description: >- + Error code if network is in a failed state. May be used for + programmatic error checking. + readOnly: true + example: insufficient_capacity + error_message: + type: string + description: Displayable error message if network is in a failed state + readOnly: true + example: Could not provision cloud resources + dns_domain: + type: string + description: >- + The root DNS domain for the network if applicable. Present on + networks that support PrivateLink. + example: 00000.us-east-1.aws.glb.confluent.cloud + readOnly: true + endpoint_suffix: + type: string + description: > + The endpoint suffix for the network, if applicable. Full service + endpoints can be constructed by appending + + the service identifier to the beginning of the endpoint suffix. For + example, the Flink REST endpoint can be + + constructed by adding "flink" - 'https://flink' + 'endpoint_suffix'. + example: .00000.us-east-1.aws.glb.confluent.cloud + readOnly: true + zonal_subdomains: + type: object + additionalProperties: + type: string + description: > + The DNS subdomain for each zone. Present on networks that support + PrivateLink. Keys are zones and + + values are DNS domains. + example: + use1-az1: use1-az1.00000.us-east-1.aws.confluent.cloud + use1-az4: use1-az4.00000.us-east-1.aws.confluent.cloud + use1-az5: use1-az5.00000.us-east-1.aws.confluent.cloud + readOnly: true + cloud: + type: object + description: >- + The cloud-specific network details. These will be populated when the + network reaches the READY state. + discriminator: + propertyName: kind + mapping: + AwsNetwork: '#/components/schemas/networking.v1.AwsNetwork' + GcpNetwork: '#/components/schemas/networking.v1.GcpNetwork' + AzureNetwork: '#/components/schemas/networking.v1.AzureNetwork' + readOnly: true + required: + - kind + - vpc + - account + - project + - vpc_network + - vnet + - subscription + properties: + kind: + description: Network kind type. + type: string + enum: + - AwsNetwork + vpc: + type: string + description: The Confluent Cloud VPC ID. + example: vpc-00000000000000000 + readOnly: true + account: + type: string + description: The AWS account ID associated with the Confluent Cloud VPC. + example: '000000000000' + readOnly: true + private_link_endpoint_service: + type: string + description: >- + The endpoint service of the Confluent Cloud VPC. (used for + PrivateLink) if available. + example: com.amazonaws.vpce.eu-west-3.vpce-00000000000000000 + readOnly: true + project: + type: string + description: The GCP Project ID associated with the Confluent Cloud VPC. + example: cc-prod-3 + readOnly: true + vpc_network: + type: string + description: The network name of the Confluent Cloud VPC. + example: prod-network + readOnly: true + private_service_connect_service_attachments: + type: object + description: > + The mapping of zones to Private Service Connect Service + + Attachments if available. Keys are zones and values are + + [GCP Private Service Connect Service + + Attachment](https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#api_7) + additionalProperties: + type: string + example: + us-central1-a: >- + projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-a + us-central1-b: >- + projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-b + us-central1-c: >- + projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-c + readOnly: true + vnet: + type: string + description: The resource ID of the Confluent Cloud VNet. + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/prod-group/providers/Microsoft.Network/virtualNetworks/prod-network + readOnly: true + subscription: + type: string + description: >- + The Azure Subscription ID associated with the Confluent Cloud + VPC. + example: 00000000-0000-0000-0000-000000000000 + readOnly: true + private_link_service_aliases: + type: object + description: > + The mapping of zones to Private Link Service Aliases if + available. Keys are zones + + and values are [Azure Private Link Service + + Aliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service). + additionalProperties: + type: string + example: + '1': >- + 0-00000-privatelink-1.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '2': >- + 0-00000-privatelink-2.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '3': >- + 0-00000-privatelink-3.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + readOnly: true + private_link_service_resource_ids: + type: object + description: > + The mapping of zones to Private Link Service Resource IDs if + available. Keys are zones + + and values are [Azure Private Link Service Resource + + IDs](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service). + additionalProperties: + type: string + example: + '1': >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-1 + '2': >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-2 + '3': >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-3 + readOnly: true + idle_since: + type: string + format: date-time + example: '2024-01-01T00:00:00.000Z' + description: The date and time when the network becomes idle + readOnly: true + readOnly: true + networking.v1.PeeringSpec: + type: object + description: The desired state of the Peering + properties: + display_name: + type: string + description: The name of the peering + example: prod-peering-use1 + cloud: + type: object + discriminator: + propertyName: kind + mapping: + AwsPeering: '#/components/schemas/networking.v1.AwsPeering' + GcpPeering: '#/components/schemas/networking.v1.GcpPeering' + AzurePeering: '#/components/schemas/networking.v1.AzurePeering' + description: The cloud-specific peering details. + x-immutable: true + title: AWS + required: + - kind + - account + - vpc + - routes + - customer_region + - project + - vpc_network + - tenant + - vnet + properties: + kind: + description: Peering kind type. + type: string + enum: + - AwsPeering + account: + type: string + pattern: ^\d{12}$ + example: '000000000000' + description: >- + The AWS account ID associated with the VPC you are peering with + Confluent Cloud network. + vpc: + type: string + minLength: 1 + description: The VPC ID you are peering with Confluent Cloud network. + example: vpc-00000000000000000 + routes: + type: array + items: + $ref: '#/components/schemas/networking.v1.Cidr' + description: > + The [CIDR + blocks](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + of the VPC you are peering + + with Confluent Cloud network. This is used by Confluent Cloud + network to route traffic back to your network. + + The CIDR block must be a private range and cannot overlap with + the Confluent Cloud CIDR block. + example: + - 10.108.16.0/21 + customer_region: + type: string + description: >- + The region of the VPC you are peering with Confluent Cloud + network. + example: us-east-1 + project: + type: string + minLength: 1 + description: > + The Google Cloud project ID associated with the VPC that you are + peering with Confluent Cloud network. + example: my-gcp-project + vpc_network: + type: string + minLength: 1 + description: >- + The name of the VPC that you are peering with Confluent Cloud + network. + example: my-gcp-network + import_custom_routes: + type: boolean + description: > + Enable customer route import. For more information, see + + [Importing custom + routes](https://cloud.google.com/vpc/docs/vpc-peering#importing-exporting-routes). + example: true + default: false + tenant: + type: string + minLength: 1 + description: > + The Azure Tenant ID in which your Azure Subscription exists. + + Represents an organization in Azure Active Directory. You can + find your Azure Tenant ID in the Azure Portal + + under + + [Azure Active + Directory](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview). + + Must be a valid **32 character UUID string**. + vnet: + type: string + minLength: 1 + description: >- + The resource ID of the VNet that you are peering with Confluent + Cloud. You can find the name of your Azure VNet in the [Azure + Portal on the Overview tab of your Azure Virtual + Network](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Network%2FvirtualNetworks). + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + network: + description: The network to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.PeeringStatus: + type: object + required: + - phase + description: The status of the Peering + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PENDING_ACCEPT + - READY + - FAILED + - DEPROVISIONING + - DISCONNECTED + description: | + The lifecycle phase of the peering: + + PROVISIONING: peering provisioning is in progress; + + PENDING_ACCEPT: peering connection request is pending acceptance by the customer; + + READY: peering is ready; + + FAILED: peering is in a failed state; + + DEPROVISIONING: peering deprovisioning is in progress; + + DISCONNECTED: peering has been disconnected in the cloud provider by the customer; + readOnly: true + example: READY + error_code: + type: string + description: >- + Error code if peering is in a failed state. May be used for + programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if peering is in a failed state + readOnly: true + readOnly: true + networking.v1.TransitGatewayAttachmentSpec: + type: object + description: The desired state of the Transit Gateway Attachment + properties: + display_name: + type: string + description: The name of the TGW attachment + example: prod-tgw-use1 + cloud: + type: object + discriminator: + propertyName: kind + mapping: + AwsTransitGatewayAttachment: '#/components/schemas/networking.v1.AwsTransitGatewayAttachment' + description: The cloud-specific Transit Gateway details. + x-immutable: true + title: AWS + required: + - kind + - ram_share_arn + - transit_gateway_id + - routes + properties: + kind: + description: AWS Transit Gateway Attachment kind type. + type: string + enum: + - AwsTransitGatewayAttachment + ram_share_arn: + description: >- + The full AWS Resource Name (ARN) for the AWS Resource Access + Manager (RAM) Share of the Transit Gateways that you want + Confluent Cloud to be attached to. + type: string + example: >- + arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx + transit_gateway_id: + description: >- + The ID of the AWS Transit Gateway that you want Confluent CLoud + to be attached to. + type: string + example: tgw-xxxxxxxxxxxxxxxxx + routes: + type: array + items: + $ref: '#/components/schemas/networking.v1.Cidr' + description: List of destination routes. + example: + - 100.64.0.0/10 + - 10.0.0.0/8 + - 192.168.0.0/16 + - 172.16.0.0/12 + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + network: + description: The network to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.TransitGatewayAttachmentStatus: + type: object + required: + - phase + description: The status of the Transit Gateway Attachment + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - READY + - PENDING_ACCEPT + - FAILED + - DEPROVISIONING + - DISCONNECTED + - ERROR + description: | + The lifecycle phase of the TGW attachment: + + PROVISIONING: attachment provisioning is in progress; + + PENDING_ACCEPT: attachment request is pending acceptance by the customer; + + READY: attachment is ready; + + FAILED: attachment is in a failed state; + + DEPROVISIONING: attachment deprovisioning is in progress; + + DISCONNECTED: attachment was manually deleted directly in the cloud provider by the customer; + + ERROR: invalid customer input during attachment creation. + readOnly: true + example: READY + error_code: + type: string + description: >- + Error code if TGW attachment is in a failed state. May be used for + programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if TGW attachment is in a failed state + readOnly: true + cloud: + type: object + description: The cloud-specific TGW attachment details. + discriminator: + propertyName: kind + mapping: + AwsTransitGatewayAttachmentStatus: >- + #/components/schemas/networking.v1.AwsTransitGatewayAttachmentStatus + readOnly: true + title: AWS + required: + - transit_gateway_attachment_id + properties: + kind: + description: AWS Transit Gateway Attachment Status kind type. + type: string + enum: + - AwsTransitGatewayAttachmentStatus + transit_gateway_attachment_id: + description: >- + The ID of the AWS Transit Gateway VPC Attachment that attaches + Confluent VPC to Transit Gateway. + type: string + example: tgw-attach-xxxxx + readOnly: true + readOnly: true + networking.v1.PrivateLinkAccessSpec: + type: object + description: The desired state of the Private Link Access + properties: + display_name: + type: string + description: The name of the PrivateLink access + example: prod-pl-use1 + cloud: + type: object + discriminator: + propertyName: kind + mapping: + AwsPrivateLinkAccess: '#/components/schemas/networking.v1.AwsPrivateLinkAccess' + AzurePrivateLinkAccess: '#/components/schemas/networking.v1.AzurePrivateLinkAccess' + GcpPrivateServiceConnectAccess: >- + #/components/schemas/networking.v1.GcpPrivateServiceConnectAccess + description: The cloud-specific PrivateLink details. + x-immutable: true + title: AWS + required: + - kind + - account + - subscription + - project + properties: + kind: + description: PrivateLink kind type. + type: string + enum: + - AwsPrivateLinkAccess + account: + type: string + pattern: ^\d{12}$ + example: '000000000000' + description: > + The AWS account ID for the account containing the VPCs you want + to connect from using AWS PrivateLink. + + You can find your AWS account ID + [here](https://console.aws.amazon.com/billing/home?#/account) + + under **My Account** in your AWS Management Console. Must be a + **12 character string**. + subscription: + type: string + minLength: 1 + description: > + The Azure subscription ID for the account containing the VNets + you want to connect from using + + Azure Private Link. You can find your Azure subscription ID in + the subscription section of your + + [Microsoft Azure + Portal](https://portal.azure.com/#blade/Microsoft_Azure_Billing/SubscriptionsBlade). + + Must be a valid **32 character UUID string**. + project: + type: string + minLength: 1 + description: > + The GCP project ID for the account containing the VPCs that you + want to connect from + + using Private Service Connect. You can find your Google Cloud + Project ID under **Project ID** section of + + your [Google Cloud Console + dashboard](https://console.cloud.google.com/home/dashboard). + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + network: + description: The network to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.PrivateLinkAccessStatus: + type: object + required: + - phase + description: The status of the Private Link Access + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - READY + - FAILED + - DEPROVISIONING + description: | + The lifecycle phase of the PrivateLink access configuration: + + PROVISIONING: PrivateLink access provisioning is in progress; + + READY: PrivateLink access is ready; + + FAILED: PrivateLink access is in a failed state; + + DEPROVISIONING: PrivateLink access deprovisioning is in progress; + readOnly: true + example: READY + error_code: + type: string + description: >- + Error code if PrivateLink access is in a failed state. May be used + for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if PrivateLink access is in a failed state + readOnly: true + readOnly: true + networking.v1.NetworkLinkServiceSpec: + type: object + description: The desired state of the Network Link Service + properties: + display_name: + type: string + description: The name of the network link service + example: prod-net-1-nls + description: + type: string + description: The description of the network link service + example: Allow connections from analytics hub + accept: + description: Network Link Service Accept policy + type: object + title: Network Link Service + properties: + environments: + description: | + List of environments from which connections can be accepted. + All networks win the list of environment will be allowed. + type: array + items: + type: string + uniqueItems: true + networks: + description: | + List of networks from which connections can be accepted. + type: array + items: + type: string + uniqueItems: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + description: The network to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.NetworkLinkServiceStatus: + type: object + required: + - phase + description: The status of the Network Link Service + properties: + phase: + type: string + x-extensible-enum: + - READY + description: | + The lifecycle phase of the network link service: + + READY: network link service is ready; + readOnly: true + example: READY + error_code: + type: string + description: | + Error code if network link service is in a failed state. + May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: >- + Displayable error message if network link service is in a failed + state + readOnly: true + readOnly: true + networking.v1.NetworkLinkEndpointSpec: + type: object + description: The desired state of the Network Link Endpoint + properties: + display_name: + type: string + description: The name of the network link endpoint + example: prod-net-1-nle + description: + type: string + description: The description of the network link endpoint + example: Connect to Network - analytics hub + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + description: The network to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network_link_service: + description: The network_link_service to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.NetworkLinkEndpointStatus: + type: object + required: + - phase + description: The status of the Network Link Endpoint + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PENDING_ACCEPT + - READY + - FAILED + - DEPROVISIONING + - EXPIRED + - DISCONNECTED + - DISCONNECTING + - INACTIVE + description: | + The lifecycle phase of the network link endpoint: + + PROVISIONING: network link endpoint provisioning is in progress; + + PENDING_ACCEPT: network link endpoint request is pending acceptance by the the owner of the target; + + READY: network link endpoint is ready; + + FAILED: network link endpoint is in a failed state; + + DEPROVISIONING: network link endpoint deprovisioning is in progress; + + EXPIRED: network link endpoint request is expired, can only be deleted; + + DISCONNECTED: network link endpoint is in a disconnected state, target owner has removed the permissions; + + DISCONNECTING: network link endpoint disconnection is in progress; + + INACTIVE: network link endpoint is created, but not active since there are no clusters in the network; + readOnly: true + example: READY + error_code: + type: string + description: >- + Error code if network link is in a failed state. May be used for + programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if network link is in a failed state + readOnly: true + expires_at: + type: string + format: date-time + example: '2024-01-01T00:00:00.000Z' + description: >- + The date and time when the request expires if it is not accepted by + the target network admin. + readOnly: true + readOnly: true + networking.v1.NetworkLinkServiceAssociationSpec: + type: object + description: The desired state of the Network Link Service Association + properties: + display_name: + type: string + description: The name of the network link endpoint + readOnly: true + example: prod-net-1-nle + description: + type: string + description: The description of the network link endpoint + readOnly: true + example: Connect to Network - analytics hub + network_link_endpoint: + type: string + description: ID of the Network link endpoint. + readOnly: true + example: prod-net-1-nle + network_link_service: + description: The network_link_service to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.NetworkLinkServiceAssociationStatus: + type: object + required: + - phase + description: The status of the Network Link Service Association + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PENDING_ACCEPT + - READY + - FAILED + - DEPROVISIONING + - EXPIRED + - DISCONNECTED + - DISCONNECTING + - INACTIVE + description: | + The lifecycle phase of the network link endpoint: + + PROVISIONING: network link endpoint provisioning is in progress; + + PENDING_ACCEPT: network link endpoint request is pending acceptance by the the owner of the target; + + READY: network link endpoint is ready; + + FAILED: network link endpoint is in a failed state; + + DEPROVISIONING: network link endpoint deprovisioning is in progress; + + EXPIRED: network link endpoint request is expired, can only be deleted; + + DISCONNECTED: network link endpoint is in a disconnected state, target owner has removed the permissions; + + DISCONNECTING: network link endpoint disconnection is in progress; + + INACTIVE: network link endpoint is created, but not active since there are no clusters in the network; + example: READY + readOnly: true + error_code: + type: string + description: >- + Error code if network link is in a failed state. May be used for + programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if network link is in a failed state + readOnly: true + expires_at: + type: string + format: date-time + example: '2024-01-01T00:00:00.000Z' + description: >- + The date and time when the request expires if it is not accepted by + the target network admin. + readOnly: true + readOnly: true + networking.v1.IpAddress: + type: object + description: >- + IP Addresses + + + Related guide: [Use Public Egress IP addresses on Confluent + Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + + ## The IP Addresses Model + + + properties: + api_version: + type: string + enum: + - networking/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpAddress + ip_prefix: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+/\d+$ + description: The IP Address range. + example: 10.200.0.0/28 + cloud: + type: string + description: The cloud service provider in which the address exists. + x-extensible-enum: + - AWS + - GCP + - AZURE + - ANY + example: AWS + region: + type: string + description: The region/location where the IP Address is in use. + example: us-east-1 + services: + type: array + description: The service types that will use the address. + items: + type: string + description: Address service type. + x-extensible-enum: + - KAFKA + - CONNECT + - EXTERNAL_OAUTH + example: CONNECT + uniqueItems: true + minItems: 1 + address_type: + type: string + description: Whether the address is used for egress or ingress. + x-extensible-enum: + - INGRESS + - EGRESS + example: EGRESS + networking.v1.PrivateLinkAttachmentSpec: + type: object + description: The desired state of the Private Link Attachment + properties: + display_name: + type: string + description: The name of the PrivateLink attachment. + example: prod-aws-us-east1 + cloud: + type: string + description: > + The cloud service provider that hosts the resources to access with + the PrivateLink attachment. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: | + The cloud service provider region where the resources to be accessed + using the PrivateLink attachment are located. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.PrivateLinkAttachmentStatus: + type: object + required: + - phase + description: The status of the Private Link Attachment + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - WAITING_FOR_CONNECTIONS + - READY + - FAILED + - EXPIRED + - DEPROVISIONING + description: | + The lifecycle phase of the PrivateLink attachment: + + PROVISIONING: PrivateLink attachment provisioning is in progress; + + WAITING_FOR_CONNECTIONS: PrivateLink attachment is waiting for connections; + + READY: PrivateLink attachment is ready; + + FAILED: PrivateLink attachment is in a failed state; + + EXPIRED: PrivateLink attachment has timed out waiting for connections, can only be deleted; + + DEPROVISIONING: PrivateLink attachment deprovisioning is in progress; + readOnly: true + example: READY + error_code: + type: string + description: >- + Error code if PrivateLink attachment is in a failed state. May be + used for programmatic error checking. + readOnly: true + error_message: + type: string + description: >- + Displayable error message if PrivateLink attachment is in a failed + state. + readOnly: true + dns_domain: + type: string + description: The root DNS domain for the PrivateLink attachment. + example: us-east-1.aws.private.confluent.cloud + readOnly: true + cloud: + type: object + description: >- + The cloud specific status of the PrivateLink attachment. These will + be populated when the PrivateLink attachment reaches the + WAITING_FOR_CONNECTIONS state. + discriminator: + propertyName: kind + mapping: + AwsPrivateLinkAttachmentStatus: >- + #/components/schemas/networking.v1.AwsPrivateLinkAttachmentStatus + AzurePrivateLinkAttachmentStatus: >- + #/components/schemas/networking.v1.AzurePrivateLinkAttachmentStatus + GcpPrivateLinkAttachmentStatus: >- + #/components/schemas/networking.v1.GcpPrivateLinkAttachmentStatus + readOnly: true + required: + - kind + - vpc_endpoint_service + - private_link_service + - service_attachment + properties: + kind: + type: string + description: PrivateLinkAttachmentStatus kind. + enum: + - AwsPrivateLinkAttachmentStatus + readOnly: true + vpc_endpoint_service: + description: > + AWS VPC Endpoint Service that can be used to establish + connections for all zones. + type: object + readOnly: true + required: + - vpc_endpoint_service_name + properties: + vpc_endpoint_service_name: + type: string + description: Id of the VPC Endpoint service. + readOnly: true + private_link_service: + description: > + Azure PrivateLink service that can be used to connect to a + PrivateEndpoint. + type: object + readOnly: true + required: + - private_link_service_alias + - private_link_service_resource_id + properties: + private_link_service_alias: + description: Azure PrivateLink service alias. + type: string + minLength: 1 + readOnly: true + example: >- + pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Azure PrivateLink service resource id. + type: string + minLength: 1 + readOnly: true + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef + service_attachment: + description: | + GCP PSC Service attachment that can be used to connect + to a PSC Endpoint. + type: object + readOnly: true + required: + - private_service_connect_service_attachment + properties: + private_service_connect_service_attachment: + description: >- + Id of a Private Service Connect Service Attachment in + Confluent Cloud. + type: string + minLength: 1 + readOnly: true + example: >- + projects/example-project/regions/us-central1/serviceAttachments/plt-abcdef-service-attachment-us-central1 + readOnly: true + networking.v1.PrivateLinkAttachmentConnectionSpec: + type: object + description: The desired state of the Private Link Attachment Connection + properties: + display_name: + type: string + description: The name of the PrivateLink attachment connection. + example: prod-gcp-us-central1-a + cloud: + type: object + description: The cloud-specific PrivateLink attachment connection details. + discriminator: + propertyName: kind + mapping: + AwsPrivateLinkAttachmentConnection: >- + #/components/schemas/networking.v1.AwsPrivateLinkAttachmentConnection + AzurePrivateLinkAttachmentConnection: >- + #/components/schemas/networking.v1.AzurePrivateLinkAttachmentConnection + GcpPrivateLinkAttachmentConnection: >- + #/components/schemas/networking.v1.GcpPrivateLinkAttachmentConnection + x-immutable: true + required: + - kind + - vpc_endpoint_id + - private_endpoint_resource_id + - private_service_connect_connection_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnection kind. + enum: + - AwsPrivateLinkAttachmentConnection + vpc_endpoint_id: + description: >- + Id of a VPC Endpoint that is connected to the VPC Endpoint + service. + type: string + minLength: 1 + example: vpce-00000000000000000 + private_endpoint_resource_id: + description: > + Resource Id of the PrivateEndpoint that is connected to the + PrivateLink service. + type: string + minLength: 1 + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3 + private_service_connect_connection_id: + description: Id of the Private Service connection. + type: string + minLength: 1 + example: '00000000000000000' + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + private_link_attachment: + description: The private_link_attachment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.PrivateLinkAttachmentConnectionStatus: + type: object + required: + - phase + description: The status of the Private Link Attachment Connection + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - READY + - FAILED + - DEPROVISIONING + - DISCONNECTED + description: | + The lifecycle phase of the PrivateLink attachment: + + PROVISIONING: PrivateLink attachment connection provisioning is in progress; + + READY: PrivateLink attachment connection is ready; + + FAILED: PrivateLink attachment connection is in a failed state; + + DEPROVISIONING: PrivateLink attachment connection deprovisioning is in progress; + + DISCONNECTED:| + PrivateLink attachment connection is in a disconnected state. This means the + private endpoint associated with this PrivateLink attachment connection has been deleted; + readOnly: true + example: READY + error_code: + type: string + description: >- + Error code if PrivateLink attachment connection is in a failed + state. May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: >- + Displayable error message if PrivateLink attachment connection is in + a failed state. + readOnly: true + cloud: + type: object + description: The cloud specific status of the PrivateLink attachment connection. + discriminator: + propertyName: kind + mapping: + AwsPrivateLinkAttachmentConnectionStatus: >- + #/components/schemas/networking.v1.AwsPrivateLinkAttachmentConnectionStatus + AzurePrivateLinkAttachmentConnectionStatus: >- + #/components/schemas/networking.v1.AzurePrivateLinkAttachmentConnectionStatus + GcpPrivateLinkAttachmentConnectionStatus: >- + #/components/schemas/networking.v1.GcpPrivateLinkAttachmentConnectionStatus + readOnly: true + required: + - kind + - vpc_endpoint_service_name + - vpc_endpoint_id + - private_link_service_alias + - private_link_service_resource_id + - private_endpoint_resource_id + - private_service_connect_service_attachment + - private_service_connect_connection_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnectionStatus kind. + enum: + - AwsPrivateLinkAttachmentConnectionStatus + vpc_endpoint_service_name: + description: Id of the VPC Endpoint service used for PrivateLink. + type: string + minLength: 1 + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + readOnly: true + vpc_endpoint_id: + description: >- + Id of the VPC Endpoint (if any) that is connected to the VPC + Endpoint service. + type: string + minLength: 1 + readOnly: true + example: vpce-00000000000000000 + private_link_service_alias: + description: Azure PrivateLink service alias. + type: string + minLength: 1 + readOnly: true + example: >- + pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Azure PrivateLink service resource id. + type: string + minLength: 1 + readOnly: true + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3 + private_endpoint_resource_id: + description: | + Resource Id of the PrivateEndpoint (if any) that is connected to + the PrivateLink service. + type: string + minLength: 1 + readOnly: true + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3 + private_service_connect_service_attachment: + description: GCP Private Service Connect ServiceAttachment. + type: string + minLength: 1 + readOnly: true + example: >- + projects/example-project/regions/us-central1/serviceAttachments/plt-abcdef-service-attachment-us-central1-a + private_service_connect_connection_id: + description: Id of the Private Service connection. + type: string + minLength: 1 + readOnly: true + example: '00000000000000000' + readOnly: true + networking.v1.DnsForwarderSpec: + type: object + description: The desired state of the Dns Forwarder + properties: + display_name: + type: string + description: The name of the DNS forwarder + example: prod-dnsf-1 + domains: + type: array + items: + type: string + uniqueItems: true + minItems: 0 + maxItems: 10 + description: List of domains for the DNS forwarder to use + example: + - example.com + - domainname.com + config: + type: object + discriminator: + propertyName: kind + mapping: + ForwardViaIp: '#/components/schemas/networking.v1.ForwardViaIp' + description: >- + The specific details of different kinds of configuration for DNS + Forwarder. + title: ForwardViaIp + required: + - kind + - dns_server_ips + properties: + kind: + description: DNS Forwarder Configured via DNS Server IPs kind type. + type: string + enum: + - ForwardViaIp + dns_server_ips: + type: array + items: + $ref: '#/components/schemas/networking.v1.Ip' + uniqueItems: true + minItems: 1 + maxItems: 3 + description: List of IP addresses of the DNS server + example: + - 10.200.0.0 + - 10.200.0.1 + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + gateway: + description: The gateway to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.DnsForwarderStatus: + type: object + required: + - phase + description: The status of the Dns Forwarder + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - CREATED + - READY + - DEGRADED + - FAILED + - DEPROVISIONING + description: | + The lifecycle phase of the DNS forwarder: + + PROVISIONING: DNS forwarder provisioning is in progress; + + CREATED: DNS forwarder is created. It will automatically become ready once a Kafka cluster is provisioned; + + READY: DNS forwarder is ready; + + FAILED: DNS forwarder is in a failed state; + + DEGRADED: DNS forwarder is in a degraded state, transitioning from 'READY' due to unreachable DNS resolvers; + + DEPROVISIONING: DNS forwarder deprovisioning is in progress; + readOnly: true + example: READY + error_code: + type: string + description: >- + Error code if dns forwarder is in a failed state. May be used for + programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if dns forwarder is in a failed state + readOnly: true + readOnly: true + networking.v1.AccessPointSpec: + type: object + description: The desired state of the Access Point + properties: + display_name: + type: string + description: The name of the access point. + example: prod-ap-egress-usw2 + config: + type: object + discriminator: + propertyName: kind + mapping: + AwsEgressPrivateLinkEndpoint: '#/components/schemas/networking.v1.AwsEgressPrivateLinkEndpoint' + AwsIngressPrivateLinkEndpoint: '#/components/schemas/networking.v1.AwsIngressPrivateLinkEndpoint' + AzureEgressPrivateLinkEndpoint: >- + #/components/schemas/networking.v1.AzureEgressPrivateLinkEndpoint + AzureIngressPrivateLinkEndpoint: >- + #/components/schemas/networking.v1.AzureIngressPrivateLinkEndpoint + AwsPrivateNetworkInterface: '#/components/schemas/networking.v1.AwsPrivateNetworkInterface' + GcpEgressPrivateServiceConnectEndpoint: >- + #/components/schemas/networking.v1.GcpEgressPrivateServiceConnectEndpoint + GcpIngressPrivateServiceConnectEndpoint: >- + #/components/schemas/networking.v1.GcpIngressPrivateServiceConnectEndpoint + description: The specific details of the different access point configurations. + required: + - kind + - vpc_endpoint_service_name + - vpc_endpoint_id + - private_link_service_resource_id + - private_endpoint_resource_id + - private_service_connect_endpoint_target + - private_service_connect_connection_id + properties: + kind: + type: string + description: AwsEgressPrivateLinkEndpoint kind. + enum: + - AwsEgressPrivateLinkEndpoint + vpc_endpoint_service_name: + description: ID of the VPC Endpoint service used for PrivateLink. + type: string + minLength: 1 + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + enable_high_availability: + type: boolean + description: >- + Whether a resource should be provisioned with high availability. + Endpoints deployed with high availability have network + interfaces deployed in multiple AZs. + example: false + x-immutable: true + target_system: + type: string + description: >- + [Used by the Confluent Cloud Console] The target system or + service that the PrivateLink Endpoint connects to (e.g. + "MONGODB" or "SNOWFLAKE"). + example: S3 + vpc_endpoint_id: + description: >- + ID of a VPC Endpoint that will be connected to the VPC Endpoint + service. + type: string + minLength: 1 + example: vpce-00000000000000000 + x-immutable: true + private_link_service_resource_id: + description: Resource ID of the Azure Private Link service. + type: string + minLength: 1 + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3 + private_link_subresource_name: + type: string + description: Name of the subresource for the Private Endpoint to connect to. + example: sqlServer + private_endpoint_resource_id: + description: >- + Resource ID of a Private Endpoint that will be connected to the + Private Link service. + type: string + minLength: 1 + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-centralus-rg/providers/Microsoft.Network/privateEndpoints/private-endpoint-azure-centralus + x-immutable: true + network_interfaces: + description: List of the IDs of the Elastic Network Interfaces. + type: array + items: + type: string + uniqueItems: true + minItems: 51 + example: + - eni-00000000000000000 + - eni-00000000000000001 + - eni-00000000000000002 + - eni-00000000000000003 + - eni-00000000000000004 + - eni-00000000000000005 + - eni-00000000000000006 + - eni-00000000000000007 + - eni-00000000000000008 + - eni-00000000000000009 + - eni-00000000000000010 + - eni-00000000000000011 + - eni-00000000000000012 + - eni-00000000000000013 + - eni-00000000000000014 + - eni-00000000000000015 + - eni-00000000000000016 + - eni-00000000000000017 + - eni-00000000000000018 + - eni-00000000000000019 + - eni-00000000000000020 + - eni-00000000000000021 + - eni-00000000000000022 + - eni-00000000000000023 + - eni-00000000000000024 + - eni-00000000000000025 + - eni-00000000000000026 + - eni-00000000000000027 + - eni-00000000000000028 + - eni-00000000000000029 + - eni-00000000000000030 + - eni-00000000000000031 + - eni-00000000000000032 + - eni-00000000000000033 + - eni-00000000000000034 + - eni-00000000000000035 + - eni-00000000000000036 + - eni-00000000000000037 + - eni-00000000000000038 + - eni-00000000000000039 + - eni-00000000000000040 + - eni-00000000000000041 + - eni-00000000000000042 + - eni-00000000000000043 + - eni-00000000000000044 + - eni-00000000000000045 + - eni-00000000000000046 + - eni-00000000000000047 + - eni-00000000000000048 + - eni-00000000000000049 + - eni-00000000000000050 + account: + type: string + pattern: ^\d{12}$ + example: '000000000000' + description: >- + The AWS account ID associated with the ENIs you are using for + the Confluent Private Network Interface. + x-immutable: true + egress_routes: + type: array + description: List of egress CIDRs (IPv4) for egress PNI. + items: + type: string + uniqueItems: true + example: + - 10.0.0.0/16 + - 10.1.0.0/16 + - 10.2.0.0/16 + - 172.16.0.0/16 + private_service_connect_endpoint_target: + description: >- + URI of the service attachment for the published service that the + Private Service Connect Endpoint connects to or + "ALL_GOOGLE_APIS" for global Google APIs. + type: string + minLength: 1 + example: >- + projects/project-name/regions/us-central1/serviceAttachments/service-attachment-name + private_service_connect_connection_id: + description: The ID of the Private Service Connect connection. + type: string + minLength: 1 + example: '00000000000000000' + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + gateway: + description: The gateway to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.AccessPointStatus: + type: object + required: + - phase + description: The status of the Access Point + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PENDING_ACCEPT + - READY + - FAILED + - DEPROVISIONING + - DISCONNECTED + - DEGRADED + - ERROR + description: | + The lifecycle phase of the access point: + + PROVISIONING: Access point provisioning is in progress; + + PENDING_ACCEPT: Access point connection request is pending acceptance by the customer; + + READY: Access point is ready; + + FAILED: Access point is in a failed state; + + DEPROVISIONING: Access point deprovisioning is in progress; + + DISCONNECTED: Access Point has been disconnected in the cloud provider by the customer; + + DEGRADED: Access Point is experiencing reduced performance or partial failure; + + ERROR: Invalid customer input during Access Point creation; + readOnly: true + example: READY + error_code: + type: string + description: >- + Error code if access point is in a failed state. May be used for + programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if access point is in a failed state. + readOnly: true + config: + type: object + description: Cloud specific status of the access point. + discriminator: + propertyName: kind + mapping: + AwsEgressPrivateLinkEndpointStatus: >- + #/components/schemas/networking.v1.AwsEgressPrivateLinkEndpointStatus + AwsIngressPrivateLinkEndpointStatus: >- + #/components/schemas/networking.v1.AwsIngressPrivateLinkEndpointStatus + AzureEgressPrivateLinkEndpointStatus: >- + #/components/schemas/networking.v1.AzureEgressPrivateLinkEndpointStatus + AzureIngressPrivateLinkEndpointStatus: >- + #/components/schemas/networking.v1.AzureIngressPrivateLinkEndpointStatus + GcpEgressPrivateServiceConnectEndpointStatus: >- + #/components/schemas/networking.v1.GcpEgressPrivateServiceConnectEndpointStatus + GcpIngressPrivateServiceConnectEndpointStatus: >- + #/components/schemas/networking.v1.GcpIngressPrivateServiceConnectEndpointStatus + readOnly: true + title: AWS + required: + - kind + - vpc_endpoint_id + - vpc_endpoint_dns_name + - vpc_endpoint_service_name + - private_endpoint_resource_id + - private_endpoint_ip_address + - private_link_service_alias + - private_link_service_resource_id + - private_service_connect_endpoint_connection_id + - private_service_connect_endpoint_name + - private_service_connect_endpoint_ip_address + - private_service_connect_service_attachment + - private_service_connect_connection_id + properties: + kind: + description: AwsEgressPrivateLinkEndpointStatus kind. + type: string + enum: + - AwsEgressPrivateLinkEndpointStatus + vpc_endpoint_id: + description: >- + ID of a VPC Endpoint (if any) that is connected to the VPC + Endpoint service. + type: string + example: vpce-00000000000000000 + readOnly: true + vpc_endpoint_dns_name: + description: >- + DNS name of a VPC Endpoint (if any) that is connected to the VPC + Endpoint service. + type: string + example: >- + vpce-00000000000000000-00000000.vpce-svc-00000000000000000.us-west-2.vpce.amazonaws.com + readOnly: true + vpc_endpoint_service_name: + description: >- + ID of the Confluent Cloud VPC Endpoint service used for + PrivateLink. + type: string + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + readOnly: true + dns_domain: + description: >- + DNS domain name used to configure the Private Hosted Zone for + the Access Point. + type: string + example: ap123abc.us-west-2.aws.accesspoint.confluent.cloud + readOnly: true + private_endpoint_resource_id: + description: >- + Resource ID of the Private Endpoint (if any) that is connected + to the Private Link service. + type: string + readOnly: true + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3 + private_endpoint_domain: + description: >- + Domain of the Private Endpoint (if any) that is connected to the + Private Link service. + type: string + readOnly: true + example: dbname.database.windows.net + private_endpoint_ip_address: + description: >- + IP address of the Private Endpoint (if any) that is connected to + the Private Link service. + type: string + readOnly: true + example: 10.2.0.68 + private_endpoint_custom_dns_config_domains: + description: >- + Domains of the Private Endpoint (if any) based off FQDNs in + Azure custom DNS configs, which are required in your private DNS + setup. + type: array + items: + type: string + readOnly: true + example: + - dbname.database.windows.net + - dbname-region.database.windows.net + private_link_service_alias: + description: Alias of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: >- + plattg-123abc-privatelink.00000000-0000-0000-0000-000000000000.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Resource ID of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/plattg-123abc/providers/Microsoft.Network/privateLinkServices/plattg-123abc-privatelink + private_service_connect_endpoint_connection_id: + description: >- + Connection ID of the Private Service Connect Endpoint (if any) + that is connected to the endpoint target. + type: string + readOnly: true + example: '' + private_service_connect_endpoint_name: + description: >- + Name of the Private Service Connect Endpoint (if any) that is + connected to the endpoint target. + type: string + readOnly: true + example: plap-123456 + private_service_connect_endpoint_ip_address: + description: >- + IP address of the Private Service Connect Endpoint (if any) that + is connected to the endpoint target. + type: string + readOnly: true + example: 10.2.0.68 + private_service_connect_service_attachment: + description: >- + URI of the Private Service Connect Service Attachment in + Confluent Cloud. + type: string + readOnly: true + example: >- + projects/traffic-prod/regions/us-central1/serviceAttachments/plattg-abc123-service-attachment + private_service_connect_connection_id: + description: The ID of the Private Service Connect connection. + type: string + readOnly: true + example: '00000000000000000' + readOnly: true + networking.v1.DnsRecordSpec: + type: object + description: The desired state of the Dns Record + properties: + display_name: + type: string + description: The name of the DNS record. + example: prod-dnsrec-1 + domain: + type: string + description: The fully qualified domain name of the DNS record. + example: example.com + x-immutable: true + config: + type: object + description: The config of the DNS record. + discriminator: + propertyName: kind + mapping: + PrivateLinkAccessPoint: '#/components/schemas/networking.v1.PrivateLinkAccessPoint' + required: + - kind + - resource_id + properties: + kind: + description: PrivateLinkAccessPoint kind. + type: string + enum: + - PrivateLinkAccessPoint + resource_id: + description: ID of the target resource. + type: string + minLength: 1 + example: ap-12345 + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + gateway: + description: The gateway to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.DnsRecordStatus: + type: object + required: + - phase + description: The status of the Dns Record + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - CREATED + - READY + - FAILED + - DEPROVISIONING + description: | + The lifecycle phase of the DNS record: + + PROVISIONING: DNS record provisioning is in progress; + + CREATED: DNS record is created. It will automatically become ready once a Kafka cluster is provisioned; + + READY: DNS record is ready; + + FAILED: DNS record is in a failed state; + + DEPROVISIONING: DNS record deprovisioning is in progress; + readOnly: true + example: READY + error_code: + type: string + description: >- + Error code if the DNS record is in a failed state. May be used for + programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if the DNS record is in a failed state. + readOnly: true + readOnly: true + networking.v1.GatewaySpec: + type: object + description: The desired state of the Gateway + properties: + display_name: + type: string + description: The name of the gateway. + example: prod-gateway + config: + type: object + description: >- + Gateway type specific configuration. Please note that Peering + configs are not supported in Create requests. + discriminator: + propertyName: kind + mapping: + AwsPrivateNetworkInterfaceGatewaySpec: >- + #/components/schemas/networking.v1.AwsPrivateNetworkInterfaceGatewaySpec + AwsPeeringGatewaySpec: '#/components/schemas/networking.v1.AwsPeeringGatewaySpec' + AwsEgressPrivateLinkGatewaySpec: >- + #/components/schemas/networking.v1.AwsEgressPrivateLinkGatewaySpec + AwsIngressPrivateLinkGatewaySpec: >- + #/components/schemas/networking.v1.AwsIngressPrivateLinkGatewaySpec + AzurePeeringGatewaySpec: '#/components/schemas/networking.v1.AzurePeeringGatewaySpec' + AzureEgressPrivateLinkGatewaySpec: >- + #/components/schemas/networking.v1.AzureEgressPrivateLinkGatewaySpec + AzureIngressPrivateLinkGatewaySpec: >- + #/components/schemas/networking.v1.AzureIngressPrivateLinkGatewaySpec + GcpPeeringGatewaySpec: '#/components/schemas/networking.v1.GcpPeeringGatewaySpec' + GcpEgressPrivateServiceConnectGatewaySpec: >- + #/components/schemas/networking.v1.GcpEgressPrivateServiceConnectGatewaySpec + GcpIngressPrivateServiceConnectGatewaySpec: >- + #/components/schemas/networking.v1.GcpIngressPrivateServiceConnectGatewaySpec + x-immutable: true + required: + - kind + - region + - zones + properties: + kind: + description: AWS Egress Private Link Gateway Spec kind type. + type: string + enum: + - AwsEgressPrivateLinkGatewaySpec + region: + type: string + description: AWS region of the Egress Private Link Gateway. + zones: + type: array + items: + type: string + description: >- + AWS availability zone ids of the Private Network Interface + Gateway. + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.GatewayStatus: + type: object + required: + - phase + description: The status of the Gateway + properties: + phase: + type: string + x-extensible-enum: + - CREATED + - PROVISIONING + - READY + - FAILED + - DEPROVISIONING + - EXPIRED + description: | + The lifecycle phase of the gateway: + + CREATED: gateway exists without an Access Point. + + PROVISIONING: gateway provisioning is in progress; + + READY: gateway is ready; + + FAILED: gateway is in a failed state; + + DEPROVISIONING: gateway deprovisioning is in progress; + + EXPIRED: gateway has timed out waiting for connections, can only be deleted; + readOnly: true + example: READY + error_code: + type: string + description: >- + Error code if gateway is in a failed state. May be used for + programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if gateway is in a failed state + readOnly: true + cloud_gateway: + type: object + description: Gateway type specific status. + readOnly: true + discriminator: + propertyName: kind + mapping: + AwsPrivateNetworkInterfaceGatewayStatus: >- + #/components/schemas/networking.v1.AwsPrivateNetworkInterfaceGatewayStatus + AwsEgressPrivateLinkGatewayStatus: >- + #/components/schemas/networking.v1.AwsEgressPrivateLinkGatewayStatus + AwsIngressPrivateLinkGatewayStatus: >- + #/components/schemas/networking.v1.AwsIngressPrivateLinkGatewayStatus + AzureEgressPrivateLinkGatewayStatus: >- + #/components/schemas/networking.v1.AzureEgressPrivateLinkGatewayStatus + AzureIngressPrivateLinkGatewayStatus: >- + #/components/schemas/networking.v1.AzureIngressPrivateLinkGatewayStatus + GcpPeeringGatewayStatus: '#/components/schemas/networking.v1.GcpPeeringGatewayStatus' + GcpEgressPrivateServiceConnectGatewayStatus: >- + #/components/schemas/networking.v1.GcpEgressPrivateServiceConnectGatewayStatus + GcpIngressPrivateServiceConnectGatewayStatus: >- + #/components/schemas/networking.v1.GcpIngressPrivateServiceConnectGatewayStatus + required: + - kind + properties: + kind: + description: AWS Egress Private Link Gateway Status kind type. + type: string + enum: + - AwsEgressPrivateLinkGatewayStatus + principal_arn: + description: The principal ARN used by the AWS Egress Private Link Gateway. + type: string + example: arn:aws:iam::123456789012:cc-tenant-1-role + readOnly: true + vpc_endpoint_service_name: + description: >- + The ID of the AWS VPC Endpoint Service that can be used to + establish connections for all zones. + type: string + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + readOnly: true + account: + description: >- + The AWS account ID associated with the Private Network Interface + Gateway. + type: string + example: '000000000000' + readOnly: true + subscription: + type: string + description: >- + The Azure Subscription ID associated with the Confluent Cloud + VPC. + example: 00000000-0000-0000-0000-000000000000 + readOnly: true + private_link_service_alias: + description: Alias of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: >- + plattg-123abc-privatelink.00000000-0000-0000-0000-000000000000.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Resource ID of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/plattg-123abc/providers/Microsoft.Network/privateLinkServices/plattg-123abc-privatelink + iam_principal: + description: The IAM principal email used by the GCP Peering Gateway. + type: string + example: my-service-account@my-project.iam.gserviceaccount.com + readOnly: true + project: + type: string + description: The GCP project used by the GCP Private Service Connect Gateway. + example: proj-tenant-1 + readOnly: true + private_service_connect_service_attachment: + description: >- + URI of the Private Service Connect Service Attachment in + Confluent Cloud. + type: string + readOnly: true + example: >- + projects/traffic-prod/regions/us-central1/serviceAttachments/plattg-abc123-service-attachment + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + networking.v1.ConnectionType: + type: string + description: Network connection type. + x-extensible-enum: + - PEERING + - TRANSITGATEWAY + - PRIVATELINK + example: PRIVATELINK + networking.v1.ZoneInfo: + type: object + description: Cloud provider zone metadata. + properties: + zone_id: + description: Cloud provider zone id + type: string + example: use1-az3 + cidr: + description: > + The IPv4 [CIDR + block](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + to used for this network. + + Must be a `/27`. Required for VPC peering and AWS TransitGateway. + type: string + example: 10.20.0.0/27 + networking.v1.DnsConfig: + type: object + description: The network DNS config + required: + - resolution + properties: + resolution: + type: string + description: Network DNS resolution type. + x-extensible-enum: + - CHASED_PRIVATE + - PRIVATE + ObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + TypedEnvScopedObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + networking.v1.AwsNetwork: + type: object + description: The AWS network details. + required: + - kind + - vpc + - account + properties: + kind: + description: Network kind type. + type: string + enum: + - AwsNetwork + vpc: + type: string + description: The Confluent Cloud VPC ID. + example: vpc-00000000000000000 + readOnly: true + account: + type: string + description: The AWS account ID associated with the Confluent Cloud VPC. + example: '000000000000' + readOnly: true + private_link_endpoint_service: + type: string + description: >- + The endpoint service of the Confluent Cloud VPC. (used for + PrivateLink) if available. + example: com.amazonaws.vpce.eu-west-3.vpce-00000000000000000 + readOnly: true + networking.v1.GcpNetwork: + type: object + description: The GCP network details. + required: + - kind + - project + - vpc_network + properties: + kind: + description: Network kind type. + type: string + enum: + - GcpNetwork + project: + type: string + description: The GCP Project ID associated with the Confluent Cloud VPC. + example: cc-prod-3 + readOnly: true + vpc_network: + type: string + description: The network name of the Confluent Cloud VPC. + example: prod-network + readOnly: true + private_service_connect_service_attachments: + type: object + description: > + The mapping of zones to Private Service Connect Service + + Attachments if available. Keys are zones and values are + + [GCP Private Service Connect Service + + Attachment](https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#api_7) + additionalProperties: + type: string + example: + us-central1-a: >- + projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-a + us-central1-b: >- + projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-b + us-central1-c: >- + projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-c + readOnly: true + networking.v1.AzureNetwork: + type: object + description: The Azure network details. + required: + - kind + - vnet + - subscription + properties: + kind: + description: Network kind type. + type: string + enum: + - AzureNetwork + vnet: + type: string + description: The resource ID of the Confluent Cloud VNet. + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/prod-group/providers/Microsoft.Network/virtualNetworks/prod-network + readOnly: true + subscription: + type: string + description: The Azure Subscription ID associated with the Confluent Cloud VPC. + example: 00000000-0000-0000-0000-000000000000 + readOnly: true + private_link_service_aliases: + type: object + description: > + The mapping of zones to Private Link Service Aliases if available. + Keys are zones + + and values are [Azure Private Link Service + + Aliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service). + additionalProperties: + type: string + example: + '1': >- + 0-00000-privatelink-1.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '2': >- + 0-00000-privatelink-2.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '3': >- + 0-00000-privatelink-3.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + readOnly: true + private_link_service_resource_ids: + type: object + description: > + The mapping of zones to Private Link Service Resource IDs if + available. Keys are zones + + and values are [Azure Private Link Service Resource + + IDs](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service). + additionalProperties: + type: string + example: + '1': >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-1 + '2': >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-2 + '3': >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-3 + readOnly: true + networking.v1.AwsPeering: + type: object + title: AWS + description: AWS VPC Peering. + required: + - kind + - account + - vpc + - routes + - customer_region + properties: + kind: + description: Peering kind type. + type: string + enum: + - AwsPeering + account: + type: string + pattern: ^\d{12}$ + example: '000000000000' + description: >- + The AWS account ID associated with the VPC you are peering with + Confluent Cloud network. + vpc: + type: string + minLength: 1 + description: The VPC ID you are peering with Confluent Cloud network. + example: vpc-00000000000000000 + routes: + type: array + items: + $ref: '#/components/schemas/networking.v1.Cidr' + description: > + The [CIDR + blocks](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + of the VPC you are peering + + with Confluent Cloud network. This is used by Confluent Cloud + network to route traffic back to your network. + + The CIDR block must be a private range and cannot overlap with the + Confluent Cloud CIDR block. + example: + - 10.108.16.0/21 + customer_region: + type: string + description: The region of the VPC you are peering with Confluent Cloud network. + example: us-east-1 + networking.v1.GcpPeering: + type: object + title: GCP + description: GCP VPC Peering. + required: + - kind + - project + - vpc_network + properties: + kind: + description: Peering kind type. + type: string + enum: + - GcpPeering + example: GcpPeering + project: + type: string + minLength: 1 + description: > + The Google Cloud project ID associated with the VPC that you are + peering with Confluent Cloud network. + example: my-gcp-project + vpc_network: + type: string + minLength: 1 + description: >- + The name of the VPC that you are peering with Confluent Cloud + network. + example: my-gcp-network + import_custom_routes: + type: boolean + description: > + Enable customer route import. For more information, see + + [Importing custom + routes](https://cloud.google.com/vpc/docs/vpc-peering#importing-exporting-routes). + example: true + default: false + networking.v1.AzurePeering: + type: object + title: AZURE + description: Azure VNet Peering. + required: + - kind + - tenant + - vnet + - customer_region + properties: + kind: + description: Peering kind type. + type: string + enum: + - AzurePeering + tenant: + type: string + minLength: 1 + description: > + The Azure Tenant ID in which your Azure Subscription exists. + + Represents an organization in Azure Active Directory. You can find + your Azure Tenant ID in the Azure Portal + + under + + [Azure Active + Directory](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview). + + Must be a valid **32 character UUID string**. + vnet: + type: string + minLength: 1 + description: >- + The resource ID of the VNet that you are peering with Confluent + Cloud. You can find the name of your Azure VNet in the [Azure Portal + on the Overview tab of your Azure Virtual + Network](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Network%2FvirtualNetworks). + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet + customer_region: + type: string + description: The region of the VNet you are peering with Confluent Cloud network. + example: eastus2 + networking.v1.AwsTransitGatewayAttachment: + type: object + title: AWS + description: AWS Transit Gateway Attachment. + required: + - kind + - ram_share_arn + - transit_gateway_id + - routes + properties: + kind: + description: AWS Transit Gateway Attachment kind type. + type: string + enum: + - AwsTransitGatewayAttachment + ram_share_arn: + description: >- + The full AWS Resource Name (ARN) for the AWS Resource Access Manager + (RAM) Share of the Transit Gateways that you want Confluent Cloud to + be attached to. + type: string + example: >- + arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx + transit_gateway_id: + description: >- + The ID of the AWS Transit Gateway that you want Confluent CLoud to + be attached to. + type: string + example: tgw-xxxxxxxxxxxxxxxxx + routes: + type: array + items: + $ref: '#/components/schemas/networking.v1.Cidr' + description: List of destination routes. + example: + - 100.64.0.0/10 + - 10.0.0.0/8 + - 192.168.0.0/16 + - 172.16.0.0/12 + networking.v1.AwsTransitGatewayAttachmentStatus: + type: object + title: AWS + description: AWS Transit Gateway Attachment details generated by AWS. + required: + - transit_gateway_attachment_id + properties: + kind: + description: AWS Transit Gateway Attachment Status kind type. + type: string + enum: + - AwsTransitGatewayAttachmentStatus + transit_gateway_attachment_id: + description: >- + The ID of the AWS Transit Gateway VPC Attachment that attaches + Confluent VPC to Transit Gateway. + type: string + example: tgw-attach-xxxxx + readOnly: true + networking.v1.AwsPrivateLinkAccess: + type: object + title: AWS + description: AWS PrivateLink access configuration. + required: + - kind + - account + properties: + kind: + description: PrivateLink kind type. + type: string + enum: + - AwsPrivateLinkAccess + account: + type: string + pattern: ^\d{12}$ + example: '000000000000' + description: > + The AWS account ID for the account containing the VPCs you want to + connect from using AWS PrivateLink. + + You can find your AWS account ID + [here](https://console.aws.amazon.com/billing/home?#/account) + + under **My Account** in your AWS Management Console. Must be a **12 + character string**. + networking.v1.AzurePrivateLinkAccess: + type: object + title: AZURE + description: Azure PrivateLink access configuration. + required: + - kind + - subscription + properties: + kind: + description: PrivateLink kind type. + type: string + enum: + - AzurePrivateLinkAccess + subscription: + type: string + minLength: 1 + description: > + The Azure subscription ID for the account containing the VNets you + want to connect from using + + Azure Private Link. You can find your Azure subscription ID in the + subscription section of your + + [Microsoft Azure + Portal](https://portal.azure.com/#blade/Microsoft_Azure_Billing/SubscriptionsBlade). + + Must be a valid **32 character UUID string**. + networking.v1.GcpPrivateServiceConnectAccess: + type: object + title: GCP + description: GCP Private Service Connect access configuration. + required: + - kind + - project + properties: + kind: + description: PrivateLink kind type. + type: string + enum: + - GcpPrivateServiceConnectAccess + project: + type: string + minLength: 1 + description: > + The GCP project ID for the account containing the VPCs that you want + to connect from + + using Private Service Connect. You can find your Google Cloud + Project ID under **Project ID** section of + + your [Google Cloud Console + dashboard](https://console.cloud.google.com/home/dashboard). + networking.v1.NetworkLinkServiceAcceptPolicy: + type: object + title: Network Link Service + description: > + List of environments/networks from which connections can be accepted on + this network link service. + properties: + environments: + description: | + List of environments from which connections can be accepted. + All networks win the list of environment will be allowed. + type: array + items: + type: string + uniqueItems: true + networks: + description: | + List of networks from which connections can be accepted. + type: array + items: + type: string + uniqueItems: true + GlobalObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + EnvScopedObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + networking.v1.AwsPrivateLinkAttachmentStatus: + description: | + AWS PrivateLink attachment represents reserved capacity in an + AWS VPC Endpoint Service that can be used to establish PrivateLink + connections. + type: object + required: + - kind + - vpc_endpoint_service + properties: + kind: + type: string + description: PrivateLinkAttachmentStatus kind. + enum: + - AwsPrivateLinkAttachmentStatus + readOnly: true + vpc_endpoint_service: + description: > + AWS VPC Endpoint Service that can be used to establish connections + for all zones. + type: object + readOnly: true + required: + - vpc_endpoint_service_name + properties: + vpc_endpoint_service_name: + type: string + description: Id of the VPC Endpoint service. + readOnly: true + networking.v1.AzurePrivateLinkAttachmentStatus: + type: object + description: | + Azure PrivateLink attachment represents reserved capacity in a + PrivateLink service that can be used to establish PrivateLink + required: + - kind + - private_link_service + properties: + kind: + type: string + description: PrivateLinkAttachmentStatus kind. + enum: + - AzurePrivateLinkAttachmentStatus + readOnly: true + private_link_service: + description: > + Azure PrivateLink service that can be used to connect to a + PrivateEndpoint. + type: object + readOnly: true + required: + - private_link_service_alias + - private_link_service_resource_id + properties: + private_link_service_alias: + description: Azure PrivateLink service alias. + type: string + minLength: 1 + readOnly: true + example: >- + pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Azure PrivateLink service resource id. + type: string + minLength: 1 + readOnly: true + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef + networking.v1.GcpPrivateLinkAttachmentStatus: + type: object + description: | + GCP PrivateLink attachment represents reserved capacity in a + GCP PSC Service attachment. A PSC Endpoint can be connected to + the Service attachment. + required: + - kind + - service_attachment + properties: + kind: + type: string + description: PrivateLinkAttachmentStatus kind. + enum: + - GcpPrivateLinkAttachmentStatus + readOnly: true + service_attachment: + description: | + GCP PSC Service attachment that can be used to connect + to a PSC Endpoint. + type: object + readOnly: true + required: + - private_service_connect_service_attachment + properties: + private_service_connect_service_attachment: + description: >- + Id of a Private Service Connect Service Attachment in Confluent + Cloud. + type: string + minLength: 1 + readOnly: true + example: >- + projects/example-project/regions/us-central1/serviceAttachments/plt-abcdef-service-attachment-us-central1 + networking.v1.AwsPrivateLinkAttachmentConnection: + description: >- + Represents a connection between an AWS VPC Endpoint and an Endpoint + service. + type: object + required: + - kind + - vpc_endpoint_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnection kind. + enum: + - AwsPrivateLinkAttachmentConnection + vpc_endpoint_id: + description: Id of a VPC Endpoint that is connected to the VPC Endpoint service. + type: string + minLength: 1 + example: vpce-00000000000000000 + networking.v1.AzurePrivateLinkAttachmentConnection: + description: >- + Represents a connection between an Azure PrivateLink service and a + PrivateEndpoint. + type: object + required: + - kind + - private_endpoint_resource_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnection kind. + enum: + - AzurePrivateLinkAttachmentConnection + private_endpoint_resource_id: + description: > + Resource Id of the PrivateEndpoint that is connected to the + PrivateLink service. + type: string + minLength: 1 + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3 + networking.v1.GcpPrivateLinkAttachmentConnection: + type: object + description: >- + Represents a connection between a GCP PSC Service Attachment and a PSC + Endpoint. + required: + - kind + - private_service_connect_connection_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnection kind. + enum: + - GcpPrivateLinkAttachmentConnection + private_service_connect_connection_id: + description: Id of the Private Service connection. + type: string + minLength: 1 + example: '00000000000000000' + networking.v1.AwsPrivateLinkAttachmentConnectionStatus: + description: Status of a connection to an AWS PrivateLink attachment. + type: object + required: + - kind + - vpc_endpoint_service_name + - vpc_endpoint_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnectionStatus kind. + enum: + - AwsPrivateLinkAttachmentConnectionStatus + vpc_endpoint_service_name: + description: Id of the VPC Endpoint service used for PrivateLink. + type: string + minLength: 1 + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + readOnly: true + vpc_endpoint_id: + description: >- + Id of the VPC Endpoint (if any) that is connected to the VPC + Endpoint service. + type: string + minLength: 1 + readOnly: true + example: vpce-00000000000000000 + networking.v1.AzurePrivateLinkAttachmentConnectionStatus: + description: Status of a Azure PrivateLink attachment connection. + type: object + required: + - kind + - private_link_service_alias + - private_link_service_resource_id + - private_endpoint_resource_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnectionStatus kind. + enum: + - AzurePrivateLinkAttachmentConnectionStatus + private_link_service_alias: + description: Azure PrivateLink service alias. + type: string + minLength: 1 + readOnly: true + example: >- + pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Azure PrivateLink service resource id. + type: string + minLength: 1 + readOnly: true + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3 + private_endpoint_resource_id: + description: | + Resource Id of the PrivateEndpoint (if any) that is connected to + the PrivateLink service. + type: string + minLength: 1 + readOnly: true + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3 + networking.v1.GcpPrivateLinkAttachmentConnectionStatus: + description: Status of GCP PrivateLink attachment connection. + type: object + required: + - kind + - private_service_connect_service_attachment + - private_service_connect_connection_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnectionStatus kind. + enum: + - GcpPrivateLinkAttachmentConnectionStatus + private_service_connect_service_attachment: + description: GCP Private Service Connect ServiceAttachment. + type: string + minLength: 1 + readOnly: true + example: >- + projects/example-project/regions/us-central1/serviceAttachments/plt-abcdef-service-attachment-us-central1-a + private_service_connect_connection_id: + description: Id of the Private Service connection. + type: string + minLength: 1 + readOnly: true + example: '00000000000000000' + networking.v1.ForwardViaIp: + type: object + title: ForwardViaIp + description: DNS Forwarder Configured via DNS Server IPs. + required: + - kind + - dns_server_ips + properties: + kind: + description: DNS Forwarder Configured via DNS Server IPs kind type. + type: string + enum: + - ForwardViaIp + dns_server_ips: + type: array + items: + $ref: '#/components/schemas/networking.v1.Ip' + uniqueItems: true + minItems: 1 + maxItems: 3 + description: List of IP addresses of the DNS server + example: + - 10.200.0.0 + - 10.200.0.1 + networking.v1.AwsEgressPrivateLinkEndpoint: + type: object + description: AWS VPC Endpoint. + required: + - kind + - vpc_endpoint_service_name + properties: + kind: + type: string + description: AwsEgressPrivateLinkEndpoint kind. + enum: + - AwsEgressPrivateLinkEndpoint + vpc_endpoint_service_name: + description: ID of the VPC Endpoint service used for PrivateLink. + type: string + minLength: 1 + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + enable_high_availability: + type: boolean + description: >- + Whether a resource should be provisioned with high availability. + Endpoints deployed with high availability have network interfaces + deployed in multiple AZs. + example: false + x-immutable: true + target_system: + type: string + description: >- + [Used by the Confluent Cloud Console] The target system or service + that the PrivateLink Endpoint connects to (e.g. "MONGODB" or + "SNOWFLAKE"). + example: S3 + networking.v1.AwsIngressPrivateLinkEndpoint: + type: object + description: AWS Ingress Private Link Endpoint. + required: + - kind + - vpc_endpoint_id + properties: + kind: + type: string + description: AwsIngressPrivateLinkEndpoint kind. + enum: + - AwsIngressPrivateLinkEndpoint + vpc_endpoint_id: + description: >- + ID of a VPC Endpoint that will be connected to the VPC Endpoint + service. + type: string + minLength: 1 + example: vpce-00000000000000000 + x-immutable: true + networking.v1.AzureEgressPrivateLinkEndpoint: + type: object + description: Azure Private Endpoint. + required: + - kind + - private_link_service_resource_id + properties: + kind: + type: string + description: AzureEgressPrivateLinkEndpoint kind. + enum: + - AzureEgressPrivateLinkEndpoint + private_link_service_resource_id: + description: Resource ID of the Azure Private Link service. + type: string + minLength: 1 + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3 + private_link_subresource_name: + type: string + description: Name of the subresource for the Private Endpoint to connect to. + example: sqlServer + target_system: + type: string + description: >- + [Used by the Confluent Cloud Console] The target system or service + that the PrivateLink Endpoint connects to (e.g. "MONGODB" or + "SNOWFLAKE"). + example: SNOWFLAKE + networking.v1.AzureIngressPrivateLinkEndpoint: + type: object + description: Azure Ingress Private Link Endpoint. + required: + - kind + - private_endpoint_resource_id + properties: + kind: + type: string + description: AzureIngressPrivateLinkEndpoint kind. + enum: + - AzureIngressPrivateLinkEndpoint + private_endpoint_resource_id: + description: >- + Resource ID of a Private Endpoint that will be connected to the + Private Link service. + type: string + minLength: 1 + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-centralus-rg/providers/Microsoft.Network/privateEndpoints/private-endpoint-azure-centralus + x-immutable: true + networking.v1.AwsPrivateNetworkInterface: + type: object + description: Confluent Private Network Interface powered by AWS ENI. + required: + - kind + properties: + kind: + type: string + description: AwsPrivateNetworkInterface kind. + enum: + - AwsPrivateNetworkInterface + network_interfaces: + description: List of the IDs of the Elastic Network Interfaces. + type: array + items: + type: string + uniqueItems: true + minItems: 51 + example: + - eni-00000000000000000 + - eni-00000000000000001 + - eni-00000000000000002 + - eni-00000000000000003 + - eni-00000000000000004 + - eni-00000000000000005 + - eni-00000000000000006 + - eni-00000000000000007 + - eni-00000000000000008 + - eni-00000000000000009 + - eni-00000000000000010 + - eni-00000000000000011 + - eni-00000000000000012 + - eni-00000000000000013 + - eni-00000000000000014 + - eni-00000000000000015 + - eni-00000000000000016 + - eni-00000000000000017 + - eni-00000000000000018 + - eni-00000000000000019 + - eni-00000000000000020 + - eni-00000000000000021 + - eni-00000000000000022 + - eni-00000000000000023 + - eni-00000000000000024 + - eni-00000000000000025 + - eni-00000000000000026 + - eni-00000000000000027 + - eni-00000000000000028 + - eni-00000000000000029 + - eni-00000000000000030 + - eni-00000000000000031 + - eni-00000000000000032 + - eni-00000000000000033 + - eni-00000000000000034 + - eni-00000000000000035 + - eni-00000000000000036 + - eni-00000000000000037 + - eni-00000000000000038 + - eni-00000000000000039 + - eni-00000000000000040 + - eni-00000000000000041 + - eni-00000000000000042 + - eni-00000000000000043 + - eni-00000000000000044 + - eni-00000000000000045 + - eni-00000000000000046 + - eni-00000000000000047 + - eni-00000000000000048 + - eni-00000000000000049 + - eni-00000000000000050 + account: + type: string + pattern: ^\d{12}$ + example: '000000000000' + description: >- + The AWS account ID associated with the ENIs you are using for the + Confluent Private Network Interface. + x-immutable: true + egress_routes: + type: array + description: List of egress CIDRs (IPv4) for egress PNI. + items: + type: string + uniqueItems: true + example: + - 10.0.0.0/16 + - 10.1.0.0/16 + - 10.2.0.0/16 + - 172.16.0.0/16 + networking.v1.GcpEgressPrivateServiceConnectEndpoint: + type: object + description: GCP Private Service Connect Endpoint. + required: + - kind + - private_service_connect_endpoint_target + properties: + kind: + type: string + description: GcpEgressPrivateServiceConnectEndpoint kind. + enum: + - GcpEgressPrivateServiceConnectEndpoint + private_service_connect_endpoint_target: + description: >- + URI of the service attachment for the published service that the + Private Service Connect Endpoint connects to or "ALL_GOOGLE_APIS" + for global Google APIs. + type: string + minLength: 1 + example: >- + projects/project-name/regions/us-central1/serviceAttachments/service-attachment-name + target_system: + type: string + description: >- + [Used by the Confluent Cloud Console] The target system or service + that the PrivateLink Endpoint connects to (e.g. "GCS" or + "SNOWFLAKE"). + example: GCS + networking.v1.GcpIngressPrivateServiceConnectEndpoint: + type: object + description: GCP Ingress Private Service Connect Endpoint. + required: + - kind + - private_service_connect_connection_id + properties: + kind: + type: string + description: GcpIngressPrivateServiceConnectEndpoint kind. + enum: + - GcpIngressPrivateServiceConnectEndpoint + private_service_connect_connection_id: + description: The ID of the Private Service Connect connection. + type: string + minLength: 1 + example: '00000000000000000' + networking.v1.AwsEgressPrivateLinkEndpointStatus: + type: object + title: AWS + description: Status of an AWS PrivateLink Endpoint. + required: + - kind + - vpc_endpoint_id + - vpc_endpoint_dns_name + properties: + kind: + description: AwsEgressPrivateLinkEndpointStatus kind. + type: string + enum: + - AwsEgressPrivateLinkEndpointStatus + vpc_endpoint_id: + description: >- + ID of a VPC Endpoint (if any) that is connected to the VPC Endpoint + service. + type: string + example: vpce-00000000000000000 + readOnly: true + vpc_endpoint_dns_name: + description: >- + DNS name of a VPC Endpoint (if any) that is connected to the VPC + Endpoint service. + type: string + example: >- + vpce-00000000000000000-00000000.vpce-svc-00000000000000000.us-west-2.vpce.amazonaws.com + readOnly: true + networking.v1.AwsIngressPrivateLinkEndpointStatus: + type: object + description: Status of an AWS Ingress Private Link Endpoint. + required: + - kind + - vpc_endpoint_service_name + - vpc_endpoint_id + properties: + kind: + description: AwsIngressPrivateLinkEndpointStatus kind. + type: string + enum: + - AwsIngressPrivateLinkEndpointStatus + vpc_endpoint_service_name: + description: ID of the Confluent Cloud VPC Endpoint service used for PrivateLink. + type: string + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + readOnly: true + vpc_endpoint_id: + description: >- + ID of the VPC Endpoint used for connecting to the VPC Endpoint + service. + type: string + example: vpce-00000000000000000 + readOnly: true + dns_domain: + description: >- + DNS domain name used to configure the Private Hosted Zone for the + Access Point. + type: string + example: ap123abc.us-west-2.aws.accesspoint.confluent.cloud + readOnly: true + networking.v1.AzureEgressPrivateLinkEndpointStatus: + type: object + description: Status of an Azure Private Endpoint. + required: + - kind + - private_endpoint_resource_id + - private_endpoint_ip_address + properties: + kind: + description: AzureEgressPrivateLinkEndpointStatus kind. + type: string + enum: + - AzureEgressPrivateLinkEndpointStatus + private_endpoint_resource_id: + description: >- + Resource ID of the Private Endpoint (if any) that is connected to + the Private Link service. + type: string + readOnly: true + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3 + private_endpoint_domain: + description: >- + Domain of the Private Endpoint (if any) that is connected to the + Private Link service. + type: string + readOnly: true + example: dbname.database.windows.net + private_endpoint_ip_address: + description: >- + IP address of the Private Endpoint (if any) that is connected to the + Private Link service. + type: string + readOnly: true + example: 10.2.0.68 + private_endpoint_custom_dns_config_domains: + description: >- + Domains of the Private Endpoint (if any) based off FQDNs in Azure + custom DNS configs, which are required in your private DNS setup. + type: array + items: + type: string + readOnly: true + example: + - dbname.database.windows.net + - dbname-region.database.windows.net + networking.v1.AzureIngressPrivateLinkEndpointStatus: + type: object + description: Status of an Azure Ingress Private Link Endpoint. + required: + - kind + - private_link_service_alias + - private_link_service_resource_id + - private_endpoint_resource_id + properties: + kind: + description: AzureIngressPrivateLinkEndpointStatus kind. + type: string + enum: + - AzureIngressPrivateLinkEndpointStatus + private_link_service_alias: + description: Alias of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: >- + plattg-123abc-privatelink.00000000-0000-0000-0000-000000000000.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Resource ID of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/plattg-123abc/providers/Microsoft.Network/privateLinkServices/plattg-123abc-privatelink + private_endpoint_resource_id: + description: >- + Resource ID of the Private Endpoint used for connecting to the + Private Link Service. + type: string + readOnly: true + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-centralus-rg/providers/Microsoft.Network/privateEndpoints/private-endpoint-azure-centralus + dns_domain: + description: >- + DNS domain name used to configure the Private DNS Zone for the + Access Point. + type: string + example: ap123abc.centralus.azure.accesspoint.confluent.cloud + readOnly: true + networking.v1.GcpEgressPrivateServiceConnectEndpointStatus: + type: object + description: Status of a GCP Private Service Connect Endpoint. + required: + - kind + - private_service_connect_endpoint_connection_id + - private_service_connect_endpoint_name + - private_service_connect_endpoint_ip_address + properties: + kind: + description: GcpEgressPrivateServiceConnectEndpointStatus kind. + type: string + enum: + - GcpEgressPrivateServiceConnectEndpointStatus + private_service_connect_endpoint_connection_id: + description: >- + Connection ID of the Private Service Connect Endpoint (if any) that + is connected to the endpoint target. + type: string + readOnly: true + example: '' + private_service_connect_endpoint_name: + description: >- + Name of the Private Service Connect Endpoint (if any) that is + connected to the endpoint target. + type: string + readOnly: true + example: plap-123456 + private_service_connect_endpoint_ip_address: + description: >- + IP address of the Private Service Connect Endpoint (if any) that is + connected to the endpoint target. + type: string + readOnly: true + example: 10.2.0.68 + networking.v1.GcpIngressPrivateServiceConnectEndpointStatus: + type: object + description: Status of a GCP Ingress Private Service Connect Endpoint. + required: + - kind + - private_service_connect_service_attachment + - private_service_connect_connection_id + properties: + kind: + description: GcpIngressPrivateServiceConnectEndpointStatus kind. + type: string + enum: + - GcpIngressPrivateServiceConnectEndpointStatus + private_service_connect_service_attachment: + description: >- + URI of the Private Service Connect Service Attachment in Confluent + Cloud. + type: string + readOnly: true + example: >- + projects/traffic-prod/regions/us-central1/serviceAttachments/plattg-abc123-service-attachment + private_service_connect_connection_id: + description: The ID of the Private Service Connect connection. + type: string + readOnly: true + example: '00000000000000000' + dns_domain: + description: DNS domain name used to configure the DNS Zone for the Access Point. + type: string + example: ap123abc.us-central1.gcp.accesspoint.confluent.cloud + readOnly: true + networking.v1.PrivateLinkAccessPoint: + type: object + description: DNS record that is associated with a PrivateLink access point. + required: + - kind + - resource_id + properties: + kind: + description: PrivateLinkAccessPoint kind. + type: string + enum: + - PrivateLinkAccessPoint + resource_id: + description: ID of the target resource. + type: string + minLength: 1 + example: ap-12345 + networking.v1.AwsEgressPrivateLinkGatewaySpec: + type: object + description: AWS Egress Private Link Gateway details from AWS. + required: + - kind + - region + properties: + kind: + description: AWS Egress Private Link Gateway Spec kind type. + type: string + enum: + - AwsEgressPrivateLinkGatewaySpec + region: + type: string + description: AWS region of the Egress Private Link Gateway. + networking.v1.AwsPrivateNetworkInterfaceGatewaySpec: + type: object + description: AWS Private Network Interface Gateway details from AWS. + required: + - kind + - region + - zones + properties: + kind: + description: AWS Private Network Interface Gateway Spec kind type. + type: string + enum: + - AwsPrivateNetworkInterfaceGatewaySpec + region: + type: string + description: AWS region of the Private Network Interface Gateway. + zones: + type: array + items: + type: string + description: AWS availability zone ids of the Private Network Interface Gateway. + networking.v1.AwsIngressPrivateLinkGatewaySpec: + type: object + description: AWS Ingress Private Link Gateway details from AWS. + required: + - kind + - region + properties: + kind: + description: AWS Ingress Private Link Gateway Spec kind type. + type: string + enum: + - AwsIngressPrivateLinkGatewaySpec + region: + type: string + description: AWS region of the Ingress Private Link Gateway. + networking.v1.AwsPeeringGatewaySpec: + type: object + description: AWS Peering Gateway details from AWS. + required: + - kind + - region + properties: + kind: + description: AWS Peering Gateway Spec kind type. + type: string + enum: + - AwsPeeringGatewaySpec + region: + type: string + description: AWS region of the Peering Gateway. + networking.v1.AzurePeeringGatewaySpec: + type: object + description: Azure Peering Gateway details from Azure. + required: + - kind + - region + properties: + kind: + description: Azure Peering Gateway Spec kind type. + type: string + enum: + - AzurePeeringGatewaySpec + region: + type: string + description: Azure region of the Peering Gateway. + networking.v1.AzureEgressPrivateLinkGatewaySpec: + type: object + description: Azure Egress Private Link Gateway details from Azure. + required: + - kind + - region + properties: + kind: + description: Azure Egress Private Link Gateway Spec kind type. + type: string + enum: + - AzureEgressPrivateLinkGatewaySpec + region: + type: string + description: Azure region of the Egress Private Link Gateway. + networking.v1.AzureIngressPrivateLinkGatewaySpec: + type: object + description: Azure Ingress Private Link Gateway details from Azure. + required: + - kind + - region + properties: + kind: + description: Azure Ingress Private Link Gateway Spec kind type. + type: string + enum: + - AzureIngressPrivateLinkGatewaySpec + region: + type: string + description: Azure region of the Ingress Private Link Gateway. + networking.v1.GcpPeeringGatewaySpec: + type: object + description: GCP Peering Gateway details. + required: + - kind + - region + properties: + kind: + description: GCP Peering Gateway Spec kind type. + type: string + enum: + - GcpPeeringGatewaySpec + region: + type: string + description: GCP region of the Peering Gateway. + networking.v1.GcpEgressPrivateServiceConnectGatewaySpec: + type: object + description: GCP Private Service Connect Gateway details from GCP. + required: + - kind + - region + properties: + kind: + description: GCP Private Service Connect Gateway Spec kind type. + type: string + enum: + - GcpEgressPrivateServiceConnectGatewaySpec + region: + type: string + description: GCP region of the Egress Private Service Connect Gateway. + networking.v1.GcpIngressPrivateServiceConnectGatewaySpec: + type: object + description: GCP Ingress Private Service Connect Gateway details from GCP. + required: + - kind + - region + properties: + kind: + description: GCP Ingress Private Service Connect Gateway Spec kind type. + type: string + enum: + - GcpIngressPrivateServiceConnectGatewaySpec + region: + type: string + description: GCP region of the Ingress Private Service Connect Gateway. + networking.v1.AwsEgressPrivateLinkGatewayStatus: + type: object + required: + - kind + description: AWS Egress Private Link Gateway details from AWS. + properties: + kind: + description: AWS Egress Private Link Gateway Status kind type. + type: string + enum: + - AwsEgressPrivateLinkGatewayStatus + principal_arn: + description: The principal ARN used by the AWS Egress Private Link Gateway. + type: string + example: arn:aws:iam::123456789012:cc-tenant-1-role + readOnly: true + networking.v1.AwsIngressPrivateLinkGatewayStatus: + type: object + required: + - kind + description: AWS Ingress Private Link Gateway details from AWS. + properties: + kind: + description: AWS Ingress Private Link Gateway Status kind type. + type: string + enum: + - AwsIngressPrivateLinkGatewayStatus + vpc_endpoint_service_name: + description: >- + The ID of the AWS VPC Endpoint Service that can be used to establish + connections for all zones. + type: string + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + readOnly: true + networking.v1.AwsPrivateNetworkInterfaceGatewayStatus: + type: object + required: + - kind + description: AWS Private Network Interface Gateway details from AWS. + properties: + kind: + description: AWS Private Network Interface Gateway Status kind type. + type: string + enum: + - AwsPrivateNetworkInterfaceGatewayStatus + account: + description: >- + The AWS account ID associated with the Private Network Interface + Gateway. + type: string + example: '000000000000' + readOnly: true + networking.v1.AzureEgressPrivateLinkGatewayStatus: + type: object + required: + - kind + description: Azure Egress Private Link Gateway details from Azure. + properties: + kind: + description: Azure Egress Private Link Gateway Status kind type. + type: string + enum: + - AzureEgressPrivateLinkGatewayStatus + subscription: + type: string + description: The Azure Subscription ID associated with the Confluent Cloud VPC. + example: 00000000-0000-0000-0000-000000000000 + readOnly: true + networking.v1.AzureIngressPrivateLinkGatewayStatus: + type: object + required: + - kind + description: Azure Ingress Private Link Gateway details from Azure. + properties: + kind: + description: Azure Ingress Private Link Gateway Status kind type. + type: string + enum: + - AzureIngressPrivateLinkGatewayStatus + private_link_service_alias: + description: Alias of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: >- + plattg-123abc-privatelink.00000000-0000-0000-0000-000000000000.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Resource ID of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/plattg-123abc/providers/Microsoft.Network/privateLinkServices/plattg-123abc-privatelink + networking.v1.GcpPeeringGatewayStatus: + type: object + required: + - kind + description: GCP Peering Gateway details from GCP. + properties: + kind: + description: GCP Peering Gateway Status kind type. + type: string + enum: + - GcpPeeringGatewayStatus + iam_principal: + description: The IAM principal email used by the GCP Peering Gateway. + type: string + example: my-service-account@my-project.iam.gserviceaccount.com + readOnly: true + networking.v1.GcpEgressPrivateServiceConnectGatewayStatus: + type: object + required: + - kind + description: GCP Private Service Connect Gateway details from GCP. + properties: + kind: + description: GCP Private Service Connect Gateway Status kind type. + type: string + enum: + - GcpEgressPrivateServiceConnectGatewayStatus + project: + type: string + description: The GCP project used by the GCP Private Service Connect Gateway. + example: proj-tenant-1 + readOnly: true + networking.v1.GcpIngressPrivateServiceConnectGatewayStatus: + type: object + required: + - kind + description: GCP Ingress Private Service Connect Gateway details from GCP. + properties: + kind: + description: GCP Ingress Private Service Connect Gateway Status kind type. + type: string + enum: + - GcpIngressPrivateServiceConnectGatewayStatus + private_service_connect_service_attachment: + description: >- + URI of the Private Service Connect Service Attachment in Confluent + Cloud. + type: string + readOnly: true + example: >- + projects/traffic-prod/regions/us-central1/serviceAttachments/plattg-abc123-service-attachment + networking.v1.Cidr: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+/\d+$ + description: IPv4 CIDR block + example: 10.200.0.0/16 + networking.v1.AwsVpcEndpointService: + description: | + AWS VPC Endpoint service that can be used to create VPC Endpoints. + type: object + required: + - vpc_endpoint_service_name + properties: + vpc_endpoint_service_name: + type: string + description: Id of the VPC Endpoint service. + readOnly: true + networking.v1.AzurePrivateLinkService: + type: object + description: > + Azure Private Link Service with reserved capacity to connect a Private + Endpoint. + required: + - private_link_service_alias + - private_link_service_resource_id + properties: + private_link_service_alias: + description: Azure PrivateLink service alias. + type: string + minLength: 1 + readOnly: true + example: >- + pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Azure PrivateLink service resource id. + type: string + minLength: 1 + readOnly: true + example: >- + /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef + networking.v1.GcpPscServiceAttachment: + type: object + description: | + GCP PSC Service attachment with reserved capacity to + connect a PSC Endpoint. + required: + - private_service_connect_service_attachment + properties: + private_service_connect_service_attachment: + description: >- + Id of a Private Service Connect Service Attachment in Confluent + Cloud. + type: string + minLength: 1 + readOnly: true + example: >- + projects/example-project/regions/us-central1/serviceAttachments/plt-abcdef-service-attachment-us-central1 + networking.v1.Ip: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+$ + description: IPv4 Address + example: 10.200.0.0 + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + OverQuotaError: + x-summary: Over Quota + description: The request would exceed one or more quotas. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '402' + code: quota_exceeded + title: Kafka Clusters Per Org Quota Exceeded + detail: >- + The request would exceed the quota: + kafka_clusters_per_environment + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + x-stackQL-resources: + networks: + id: confluent.networking.networks + name: networks + title: Networks + methods: + list_networking_v1_networks: + operation: + $ref: '#/paths/~1networking~1v1~1networks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_networking_v1_network: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1networks/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_networking_v1_network: + operation: + $ref: '#/paths/~1networking~1v1~1networks~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_networking_v1_network: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1networks~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_networking_v1_network: + operation: + $ref: '#/paths/~1networking~1v1~1networks~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/networks/methods/get_networking_v1_network + - $ref: >- + #/components/x-stackQL-resources/networks/methods/list_networking_v1_networks + insert: + - $ref: >- + #/components/x-stackQL-resources/networks/methods/create_networking_v1_network + update: + - $ref: >- + #/components/x-stackQL-resources/networks/methods/update_networking_v1_network + delete: + - $ref: >- + #/components/x-stackQL-resources/networks/methods/delete_networking_v1_network + replace: [] + peerings: + id: confluent.networking.peerings + name: peerings + title: Peerings + methods: + list_networking_v1_peerings: + operation: + $ref: '#/paths/~1networking~1v1~1peerings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_networking_v1_peering: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1peerings/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_networking_v1_peering: + operation: + $ref: '#/paths/~1networking~1v1~1peerings~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_networking_v1_peering: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1peerings~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_networking_v1_peering: + operation: + $ref: '#/paths/~1networking~1v1~1peerings~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/peerings/methods/get_networking_v1_peering + - $ref: >- + #/components/x-stackQL-resources/peerings/methods/list_networking_v1_peerings + insert: + - $ref: >- + #/components/x-stackQL-resources/peerings/methods/create_networking_v1_peering + update: + - $ref: >- + #/components/x-stackQL-resources/peerings/methods/update_networking_v1_peering + delete: + - $ref: >- + #/components/x-stackQL-resources/peerings/methods/delete_networking_v1_peering + replace: [] + transit_gateway_attachments: + id: confluent.networking.transit_gateway_attachments + name: transit_gateway_attachments + title: Transit Gateway Attachments + methods: + list_networking_v1_transit_gateway_attachments: + operation: + $ref: '#/paths/~1networking~1v1~1transit-gateway-attachments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_networking_v1_transit_gateway_attachment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1transit-gateway-attachments/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_networking_v1_transit_gateway_attachment: + operation: + $ref: '#/paths/~1networking~1v1~1transit-gateway-attachments~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_networking_v1_transit_gateway_attachment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1transit-gateway-attachments~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_networking_v1_transit_gateway_attachment: + operation: + $ref: '#/paths/~1networking~1v1~1transit-gateway-attachments~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/transit_gateway_attachments/methods/get_networking_v1_transit_gateway_attachment + - $ref: >- + #/components/x-stackQL-resources/transit_gateway_attachments/methods/list_networking_v1_transit_gateway_attachments + insert: + - $ref: >- + #/components/x-stackQL-resources/transit_gateway_attachments/methods/create_networking_v1_transit_gateway_attachment + update: + - $ref: >- + #/components/x-stackQL-resources/transit_gateway_attachments/methods/update_networking_v1_transit_gateway_attachment + delete: + - $ref: >- + #/components/x-stackQL-resources/transit_gateway_attachments/methods/delete_networking_v1_transit_gateway_attachment + replace: [] + private_link_accesses: + id: confluent.networking.private_link_accesses + name: private_link_accesses + title: Private Link Accesses + methods: + list_networking_v1_private_link_accesses: + operation: + $ref: '#/paths/~1networking~1v1~1private-link-accesses/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_networking_v1_private_link_access: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1private-link-accesses/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_networking_v1_private_link_access: + operation: + $ref: '#/paths/~1networking~1v1~1private-link-accesses~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_networking_v1_private_link_access: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1private-link-accesses~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_networking_v1_private_link_access: + operation: + $ref: '#/paths/~1networking~1v1~1private-link-accesses~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/private_link_accesses/methods/get_networking_v1_private_link_access + - $ref: >- + #/components/x-stackQL-resources/private_link_accesses/methods/list_networking_v1_private_link_accesses + insert: + - $ref: >- + #/components/x-stackQL-resources/private_link_accesses/methods/create_networking_v1_private_link_access + update: + - $ref: >- + #/components/x-stackQL-resources/private_link_accesses/methods/update_networking_v1_private_link_access + delete: + - $ref: >- + #/components/x-stackQL-resources/private_link_accesses/methods/delete_networking_v1_private_link_access + replace: [] + network_link_services: + id: confluent.networking.network_link_services + name: network_link_services + title: Network Link Services + methods: + list_networking_v1_network_link_services: + operation: + $ref: '#/paths/~1networking~1v1~1network-link-services/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_networking_v1_network_link_service: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1network-link-services/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_networking_v1_network_link_service: + operation: + $ref: '#/paths/~1networking~1v1~1network-link-services~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_networking_v1_network_link_service: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1network-link-services~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_networking_v1_network_link_service: + operation: + $ref: '#/paths/~1networking~1v1~1network-link-services~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/network_link_services/methods/get_networking_v1_network_link_service + - $ref: >- + #/components/x-stackQL-resources/network_link_services/methods/list_networking_v1_network_link_services + insert: + - $ref: >- + #/components/x-stackQL-resources/network_link_services/methods/create_networking_v1_network_link_service + update: + - $ref: >- + #/components/x-stackQL-resources/network_link_services/methods/update_networking_v1_network_link_service + delete: + - $ref: >- + #/components/x-stackQL-resources/network_link_services/methods/delete_networking_v1_network_link_service + replace: [] + network_link_endpoints: + id: confluent.networking.network_link_endpoints + name: network_link_endpoints + title: Network Link Endpoints + methods: + list_networking_v1_network_link_endpoints: + operation: + $ref: '#/paths/~1networking~1v1~1network-link-endpoints/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_networking_v1_network_link_endpoint: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1network-link-endpoints/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_networking_v1_network_link_endpoint: + operation: + $ref: '#/paths/~1networking~1v1~1network-link-endpoints~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_networking_v1_network_link_endpoint: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1network-link-endpoints~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_networking_v1_network_link_endpoint: + operation: + $ref: '#/paths/~1networking~1v1~1network-link-endpoints~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/network_link_endpoints/methods/get_networking_v1_network_link_endpoint + - $ref: >- + #/components/x-stackQL-resources/network_link_endpoints/methods/list_networking_v1_network_link_endpoints + insert: + - $ref: >- + #/components/x-stackQL-resources/network_link_endpoints/methods/create_networking_v1_network_link_endpoint + update: + - $ref: >- + #/components/x-stackQL-resources/network_link_endpoints/methods/update_networking_v1_network_link_endpoint + delete: + - $ref: >- + #/components/x-stackQL-resources/network_link_endpoints/methods/delete_networking_v1_network_link_endpoint + replace: [] + network_link_service_associations: + id: confluent.networking.network_link_service_associations + name: network_link_service_associations + title: Network Link Service Associations + methods: + list_networking_v1_network_link_service_associations: + operation: + $ref: '#/paths/~1networking~1v1~1network-link-service-associations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_networking_v1_network_link_service_association: + operation: + $ref: >- + #/paths/~1networking~1v1~1network-link-service-associations~1{id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/network_link_service_associations/methods/get_networking_v1_network_link_service_association + - $ref: >- + #/components/x-stackQL-resources/network_link_service_associations/methods/list_networking_v1_network_link_service_associations + insert: [] + update: [] + delete: [] + replace: [] + ip_addresses: + id: confluent.networking.ip_addresses + name: ip_addresses + title: Ip Addresses + methods: + list_networking_v1_ip_addresses: + operation: + $ref: '#/paths/~1networking~1v1~1ip-addresses/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/ip_addresses/methods/list_networking_v1_ip_addresses + insert: [] + update: [] + delete: [] + replace: [] + private_link_attachments: + id: confluent.networking.private_link_attachments + name: private_link_attachments + title: Private Link Attachments + methods: + list_networking_v1_private_link_attachments: + operation: + $ref: '#/paths/~1networking~1v1~1private-link-attachments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_networking_v1_private_link_attachment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1private-link-attachments/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_networking_v1_private_link_attachment: + operation: + $ref: '#/paths/~1networking~1v1~1private-link-attachments~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_networking_v1_private_link_attachment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1private-link-attachments~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_networking_v1_private_link_attachment: + operation: + $ref: '#/paths/~1networking~1v1~1private-link-attachments~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/private_link_attachments/methods/get_networking_v1_private_link_attachment + - $ref: >- + #/components/x-stackQL-resources/private_link_attachments/methods/list_networking_v1_private_link_attachments + insert: + - $ref: >- + #/components/x-stackQL-resources/private_link_attachments/methods/create_networking_v1_private_link_attachment + update: + - $ref: >- + #/components/x-stackQL-resources/private_link_attachments/methods/update_networking_v1_private_link_attachment + delete: + - $ref: >- + #/components/x-stackQL-resources/private_link_attachments/methods/delete_networking_v1_private_link_attachment + replace: [] + private_link_attachment_connections: + id: confluent.networking.private_link_attachment_connections + name: private_link_attachment_connections + title: Private Link Attachment Connections + methods: + list_networking_v1_private_link_attachment_connections: + operation: + $ref: '#/paths/~1networking~1v1~1private-link-attachment-connections/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_networking_v1_private_link_attachment_connection: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1private-link-attachment-connections/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_networking_v1_private_link_attachment_connection: + operation: + $ref: >- + #/paths/~1networking~1v1~1private-link-attachment-connections~1{id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_networking_v1_private_link_attachment_connection: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1networking~1v1~1private-link-attachment-connections~1{id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_networking_v1_private_link_attachment_connection: + operation: + $ref: >- + #/paths/~1networking~1v1~1private-link-attachment-connections~1{id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/private_link_attachment_connections/methods/get_networking_v1_private_link_attachment_connection + - $ref: >- + #/components/x-stackQL-resources/private_link_attachment_connections/methods/list_networking_v1_private_link_attachment_connections + insert: + - $ref: >- + #/components/x-stackQL-resources/private_link_attachment_connections/methods/create_networking_v1_private_link_attachment_connection + update: + - $ref: >- + #/components/x-stackQL-resources/private_link_attachment_connections/methods/update_networking_v1_private_link_attachment_connection + delete: + - $ref: >- + #/components/x-stackQL-resources/private_link_attachment_connections/methods/delete_networking_v1_private_link_attachment_connection + replace: [] + dns_forwarders: + id: confluent.networking.dns_forwarders + name: dns_forwarders + title: Dns Forwarders + methods: + list_networking_v1_dns_forwarders: + operation: + $ref: '#/paths/~1networking~1v1~1dns-forwarders/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_networking_v1_dns_forwarder: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1dns-forwarders/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_networking_v1_dns_forwarder: + operation: + $ref: '#/paths/~1networking~1v1~1dns-forwarders~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_networking_v1_dns_forwarder: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1dns-forwarders~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_networking_v1_dns_forwarder: + operation: + $ref: '#/paths/~1networking~1v1~1dns-forwarders~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/dns_forwarders/methods/get_networking_v1_dns_forwarder + - $ref: >- + #/components/x-stackQL-resources/dns_forwarders/methods/list_networking_v1_dns_forwarders + insert: + - $ref: >- + #/components/x-stackQL-resources/dns_forwarders/methods/create_networking_v1_dns_forwarder + update: + - $ref: >- + #/components/x-stackQL-resources/dns_forwarders/methods/update_networking_v1_dns_forwarder + delete: + - $ref: >- + #/components/x-stackQL-resources/dns_forwarders/methods/delete_networking_v1_dns_forwarder + replace: [] + access_points: + id: confluent.networking.access_points + name: access_points + title: Access Points + methods: + list_networking_v1_access_points: + operation: + $ref: '#/paths/~1networking~1v1~1access-points/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_networking_v1_access_point: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1access-points/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_networking_v1_access_point: + operation: + $ref: '#/paths/~1networking~1v1~1access-points~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_networking_v1_access_point: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1access-points~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_networking_v1_access_point: + operation: + $ref: '#/paths/~1networking~1v1~1access-points~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/access_points/methods/get_networking_v1_access_point + - $ref: >- + #/components/x-stackQL-resources/access_points/methods/list_networking_v1_access_points + insert: + - $ref: >- + #/components/x-stackQL-resources/access_points/methods/create_networking_v1_access_point + update: + - $ref: >- + #/components/x-stackQL-resources/access_points/methods/update_networking_v1_access_point + delete: + - $ref: >- + #/components/x-stackQL-resources/access_points/methods/delete_networking_v1_access_point + replace: [] + dns_records: + id: confluent.networking.dns_records + name: dns_records + title: Dns Records + methods: + list_networking_v1_dns_records: + operation: + $ref: '#/paths/~1networking~1v1~1dns-records/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_networking_v1_dns_record: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1dns-records/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_networking_v1_dns_record: + operation: + $ref: '#/paths/~1networking~1v1~1dns-records~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_networking_v1_dns_record: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1dns-records~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_networking_v1_dns_record: + operation: + $ref: '#/paths/~1networking~1v1~1dns-records~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/dns_records/methods/get_networking_v1_dns_record + - $ref: >- + #/components/x-stackQL-resources/dns_records/methods/list_networking_v1_dns_records + insert: + - $ref: >- + #/components/x-stackQL-resources/dns_records/methods/create_networking_v1_dns_record + update: + - $ref: >- + #/components/x-stackQL-resources/dns_records/methods/update_networking_v1_dns_record + delete: + - $ref: >- + #/components/x-stackQL-resources/dns_records/methods/delete_networking_v1_dns_record + replace: [] + gateways: + id: confluent.networking.gateways + name: gateways + title: Gateways + methods: + list_networking_v1_gateways: + operation: + $ref: '#/paths/~1networking~1v1~1gateways/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_networking_v1_gateway: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1gateways/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_networking_v1_gateway: + operation: + $ref: '#/paths/~1networking~1v1~1gateways~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_networking_v1_gateway: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networking~1v1~1gateways~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_networking_v1_gateway: + operation: + $ref: '#/paths/~1networking~1v1~1gateways~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/gateways/methods/get_networking_v1_gateway + - $ref: >- + #/components/x-stackQL-resources/gateways/methods/list_networking_v1_gateways + insert: + - $ref: >- + #/components/x-stackQL-resources/gateways/methods/create_networking_v1_gateway + update: + - $ref: >- + #/components/x-stackQL-resources/gateways/methods/update_networking_v1_gateway + delete: + - $ref: >- + #/components/x-stackQL-resources/gateways/methods/delete_networking_v1_gateway + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/notifications.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/notifications.yaml new file mode 100644 index 0000000..b3cb52c --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/notifications.yaml @@ -0,0 +1,9394 @@ +openapi: 3.0.0 +info: + title: notifications API + description: confluent notifications API + version: 1.0.0 +paths: + /notifications/v1/subscriptions: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNotificationsV1Subscriptions + summary: List of Subscriptions + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all subscriptions. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 250 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Subscription. + content: + application/json: + schema: + type: object + description: >- + `Subscription` objects represent the intent of the customers + to get notifications of particular types. + + A subscription is created for a particular `NotificationType` + and the user will get notifications on the + + `Integrations` that are provided while creating the + subscription. + + + This API allows you to create, retrieve, and update + subscriptions, + + as well as to view the list of all your subscriptions. You can + also delete subscriptions + + with RECOMMENDED or OPTIONAL notification types. Subscriptions + with REQUIRED notification types cannot be deleted. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Subscriptions Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - SubscriptionList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Subscription` objects represent the intent of the + customers to get notifications of particular types. + + A subscription is created for a particular + `NotificationType` and the user will get notifications + on the + + `Integrations` that are provided while creating the + subscription. + + + This API allows you to create, retrieve, and update + subscriptions, + + as well as to view the list of all your subscriptions. + You can also delete subscriptions + + with RECOMMENDED or OPTIONAL notification types. + Subscriptions with REQUIRED notification types cannot be + deleted. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Subscriptions Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Subscription + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the subscription. When the + subscription is ENABLED, the user will receive + + notification on the configured Integrations. If the + subscription is DISABLED, the user will not + + recieve any notification for the configured + notification type. Note that, you cannot disable + + a subscription for `REQUIRED` notification type. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - id + - metadata + - notification_type + - integrations + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNotificationsV1Subscription + summary: Create a Subscription + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a subscription. + tags: + - Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Subscription` objects represent the intent of the customers to + get notifications of particular types. + + A subscription is created for a particular `NotificationType` + and the user will get notifications on the + + `Integrations` that are provided while creating the + subscription. + + + This API allows you to create, retrieve, and update + subscriptions, + + as well as to view the list of all your subscriptions. You can + also delete subscriptions + + with RECOMMENDED or OPTIONAL notification types. Subscriptions + with REQUIRED notification types cannot be deleted. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Subscriptions Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Subscription + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the subscription. When the subscription + is ENABLED, the user will receive + + notification on the configured Integrations. If the + subscription is DISABLED, the user will not + + recieve any notification for the configured notification + type. Note that, you cannot disable + + a subscription for `REQUIRED` notification type. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - notification_type + - integrations + responses: + '201': + description: A Subscription was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: >- + https://api.confluent.cloud/notifications/v1/subscriptions/{id} + description: Subscription resource uri + content: + application/json: + schema: + type: object + description: >- + `Subscription` objects represent the intent of the customers + to get notifications of particular types. + + A subscription is created for a particular `NotificationType` + and the user will get notifications on the + + `Integrations` that are provided while creating the + subscription. + + + This API allows you to create, retrieve, and update + subscriptions, + + as well as to view the list of all your subscriptions. You can + also delete subscriptions + + with RECOMMENDED or OPTIONAL notification types. Subscriptions + with REQUIRED notification types cannot be deleted. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Subscriptions Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Subscription + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the subscription. When the + subscription is ENABLED, the user will receive + + notification on the configured Integrations. If the + subscription is DISABLED, the user will not + + recieve any notification for the configured notification + type. Note that, you cannot disable + + a subscription for `REQUIRED` notification type. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - notification_type + - integrations + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/subscriptions/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNotificationsV1Subscription + summary: Read a Subscription + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a subscription. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the subscription. + tags: + - Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Subscription. + content: + application/json: + schema: + type: object + description: >- + `Subscription` objects represent the intent of the customers + to get notifications of particular types. + + A subscription is created for a particular `NotificationType` + and the user will get notifications on the + + `Integrations` that are provided while creating the + subscription. + + + This API allows you to create, retrieve, and update + subscriptions, + + as well as to view the list of all your subscriptions. You can + also delete subscriptions + + with RECOMMENDED or OPTIONAL notification types. Subscriptions + with REQUIRED notification types cannot be deleted. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Subscriptions Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Subscription + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the subscription. When the + subscription is ENABLED, the user will receive + + notification on the configured Integrations. If the + subscription is DISABLED, the user will not + + recieve any notification for the configured notification + type. Note that, you cannot disable + + a subscription for `REQUIRED` notification type. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - api_version + - kind + - id + - notification_type + - integrations + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNotificationsV1Subscription + summary: Update a Subscription + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a subscription. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the subscription. + tags: + - Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/notifications.v1.Subscription' + responses: + '200': + description: Subscription. + content: + application/json: + schema: + type: object + description: >- + `Subscription` objects represent the intent of the customers + to get notifications of particular types. + + A subscription is created for a particular `NotificationType` + and the user will get notifications on the + + `Integrations` that are provided while creating the + subscription. + + + This API allows you to create, retrieve, and update + subscriptions, + + as well as to view the list of all your subscriptions. You can + also delete subscriptions + + with RECOMMENDED or OPTIONAL notification types. Subscriptions + with REQUIRED notification types cannot be deleted. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Subscriptions Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Subscription + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the subscription. When the + subscription is ENABLED, the user will receive + + notification on the configured Integrations. If the + subscription is DISABLED, the user will not + + recieve any notification for the configured notification + type. Note that, you cannot disable + + a subscription for `REQUIRED` notification type. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - api_version + - kind + - id + - notification_type + - integrations + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNotificationsV1Subscription + summary: Delete a Subscription + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a subscription. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the subscription. + tags: + - Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Subscription is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/integrations: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNotificationsV1Integrations + summary: List of Integrations + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all integrations. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 250 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: >- + You can create an `Integration` to specify how we can notify + you when we receive an alert/notification for + + a subscription. Please note that you can only perform create, + update and delete operations for integrations + + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, + update or delete integrations of type `RoleEmail` + + and `UserEmail`. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Integrations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `integrations_per_org` | Maximum number of integrations in + one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + You can create an `Integration` to specify how we can + notify you when we receive an alert/notification for + + a subscription. Please note that you can only perform + create, update and delete operations for integrations + + of type `Webhook`, `Slack` and `MsTeams`. You cannot + create, update or delete integrations of type + `RoleEmail` + + and `UserEmail`. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Integrations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `integrations_per_org` | Maximum number of + integrations in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: > + A human readable description for the particular + integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: >- + #/components/schemas/notifications.v1.SlackTarget + RoleEmail: >- + #/components/schemas/notifications.v1.RoleEmailTarget + UserEmail: >- + #/components/schemas/notifications.v1.UserEmailTarget + Webhook: >- + #/components/schemas/notifications.v1.WebhookTarget + MsTeams: >- + #/components/schemas/notifications.v1.MsTeamsTarget + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: >- + Slack Webhook URL for the particular Slack + channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the + referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + required: + - id + - metadata + - display_name + - target + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNotificationsV1Integration + summary: Create an Integration + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create an integration. + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + You can create an `Integration` to specify how we can notify you + when we receive an alert/notification for + + a subscription. Please note that you can only perform create, + update and delete operations for integrations + + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, + update or delete integrations of type `RoleEmail` + + and `UserEmail`. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Integrations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `integrations_per_org` | Maximum number of integrations in one + Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: | + A human readable description for the particular integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + required: + - display_name + - target + responses: + '201': + description: An Integration was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/notifications/v1/integrations/{id} + description: Integration resource uri + content: + application/json: + schema: + type: object + description: >- + You can create an `Integration` to specify how we can notify + you when we receive an alert/notification for + + a subscription. Please note that you can only perform create, + update and delete operations for integrations + + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, + update or delete integrations of type `RoleEmail` + + and `UserEmail`. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Integrations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `integrations_per_org` | Maximum number of integrations in + one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: > + A human readable description for the particular + integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + required: + - display_name + - target + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/integrations/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNotificationsV1Integration + summary: Read an Integration + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read an integration. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: >- + You can create an `Integration` to specify how we can notify + you when we receive an alert/notification for + + a subscription. Please note that you can only perform create, + update and delete operations for integrations + + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, + update or delete integrations of type `RoleEmail` + + and `UserEmail`. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Integrations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `integrations_per_org` | Maximum number of integrations in + one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: > + A human readable description for the particular + integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + required: + - api_version + - kind + - id + - display_name + - target + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNotificationsV1Integration + summary: Update an Integration + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update an integration. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/notifications.v1.Integration' + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: >- + You can create an `Integration` to specify how we can notify + you when we receive an alert/notification for + + a subscription. Please note that you can only perform create, + update and delete operations for integrations + + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, + update or delete integrations of type `RoleEmail` + + and `UserEmail`. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Integrations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `integrations_per_org` | Maximum number of integrations in + one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: > + A human readable description for the particular + integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + required: + - api_version + - kind + - id + - display_name + - target + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNotificationsV1Integration + summary: Delete an Integration + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete an integration. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Integration is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/integrations:test: + post: + summary: Test a Webhook, Slack or Microsoft Teams integration + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Sends a test notification to validate the integration. This is supported + only for Webhook, Slack + + and MsTeams targets + requestBody: + content: + application/json: + schema: + type: object + description: >- + You can create an `Integration` to specify how we can notify you + when we receive an alert/notification for + + a subscription. Please note that you can only perform create, + update and delete operations for integrations + + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, + update or delete integrations of type `RoleEmail` + + and `UserEmail`. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Integrations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `integrations_per_org` | Maximum number of integrations in one + Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: | + A human readable description for the particular integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + required: + - display_name + - target + x-lifecycle-stage: General Availability + x-self-access: true + x-name: notifications.v1.Integration + operationId: testNotificationsV1Integration + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: Notification sent to test integration. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/notification-types/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNotificationsV1NotificationType + summary: Read a Notification Type + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a notification type. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the notification type. + tags: + - Notification Types (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Notification Type. + content: + application/json: + schema: + type: object + description: >- + The type of notifications (and their corresponding metadata) + supported by Confluent. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Notification Types Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NotificationType + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + description: | + Human readable display name of the notification type + example: Cluster Shrink + category: + type: string + x-extensible-enum: + - BILLING_LICENSING + - SECURITY + - SERVICE + - ACCOUNT + description: > + Represents the group with which the notification is + associated. + + Notifications are grouped under certain categories for + better organization. + + - BILLING_LICENSING: All billing, payments or licensing + related notifications are grouped here. + + - SECURITY: All Confluent Cloud and Platform security + related notifications are grouped here. + + - SERVICE: All Confluent services (eg. Kafka, Schema + Registry, Connect etc.) related notifications are + grouped here. + - ACCOUNT: All Confluent account related notifications are + grouped here. + + For example: Billing, payment or license related + notifications are grouped in BILLING_LICENSING category. + example: BILLING_LICENSING + description: + type: string + description: | + Human readable description of the notification type + example: Cluster shrink operation is completed + subscription_priority: + type: string + x-extensible-enum: + - REQUIRED + - RECOMMENDED + - OPTIONAL + description: > + Indicates whether the notification is auto-subscribed and + if the user can opt-out. + + - REQUIRED: the user is auto-subscribed to this + notification and can't opt-out. + + - RECOMMENDED: the user is auto-subscribed to this + notification and can opt-out. + + - OPTIONAL: the user is not auto-subscribed to this + notification but can explicitly subscribe to it. + example: REQUIRED + is_included_in_plan: + type: boolean + description: | + Whether this notification is available to subscribe or not + as per the user's current billing plan. + severity: + type: string + x-extensible-enum: + - CRITICAL + - WARN + - INFO + description: > + Severity indicates the impact of this notification. + + - CRITICAL: a high impact notification which needs + immediate attention. + + - WARN: a warning notification which can be addressed now + or later. + + - INFO: an informational notification. + example: INFO + required: + - api_version + - kind + - id + - display_name + - category + - description + - subscription_priority + - is_included_in_plan + - severity + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/notification-types: + get: + summary: Retrieve a list of all notification types for the resource type. + parameters: + - name: resource_type + description: Confluent Cloud resource type + in: query + required: false + schema: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 250 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNotificationsV1NotificationTypes + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to list_by_resource_type a notification type. + tags: + - Notification Types (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: List of Notification Type. + content: + application/json: + schema: + type: object + description: >- + The type of notifications (and their corresponding metadata) + supported by Confluent. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Notification Types Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NotificationTypeList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + The type of notifications (and their corresponding + metadata) supported by Confluent. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Notification Types Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - NotificationType + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: | + Human readable display name of the notification type + example: Cluster Shrink + category: + type: string + x-extensible-enum: + - BILLING_LICENSING + - SECURITY + - SERVICE + - ACCOUNT + description: > + Represents the group with which the notification is + associated. + + Notifications are grouped under certain categories + for better organization. + + - BILLING_LICENSING: All billing, payments or + licensing related notifications are grouped here. + + - SECURITY: All Confluent Cloud and Platform + security related notifications are grouped here. + + - SERVICE: All Confluent services (eg. Kafka, Schema + Registry, Connect etc.) related notifications are + grouped here. + - ACCOUNT: All Confluent account related + notifications are grouped here. + + For example: Billing, payment or license related + notifications are grouped in BILLING_LICENSING + category. + example: BILLING_LICENSING + description: + type: string + description: | + Human readable description of the notification type + example: Cluster shrink operation is completed + subscription_priority: + type: string + x-extensible-enum: + - REQUIRED + - RECOMMENDED + - OPTIONAL + description: > + Indicates whether the notification is + auto-subscribed and if the user can opt-out. + + - REQUIRED: the user is auto-subscribed to this + notification and can't opt-out. + + - RECOMMENDED: the user is auto-subscribed to this + notification and can opt-out. + + - OPTIONAL: the user is not auto-subscribed to this + notification but can explicitly subscribe to it. + example: REQUIRED + is_included_in_plan: + type: boolean + description: > + Whether this notification is available to subscribe + or not + + as per the user's current billing plan. + severity: + type: string + x-extensible-enum: + - CRITICAL + - WARN + - INFO + description: > + Severity indicates the impact of this notification. + + - CRITICAL: a high impact notification which needs + immediate attention. + + - WARN: a warning notification which can be + addressed now or later. + + - INFO: an informational notification. + example: INFO + required: + - id + - metadata + - display_name + - category + - description + - subscription_priority + - is_included_in_plan + - severity + uniqueItems: true + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/resource-preferences: + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNotificationsV1ResourcePreference + summary: Create a Resource Preference + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a resource preference. + tags: + - Resource Preferences (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `ResourcePreference` objects represent the intent of the + customers to enable or disable all notifications + + at the resource level. A ResourcePreference is created for a + specific Confluent Cloud Resource + + (e.g., a connector) and determines whether the user will receive + notifications for that resource. + + + This API allows you to create, retrieve, update and delete + resourcePreferences. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Resource Preferences Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourcePreference + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: >- + environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the resource preference. When the + resource preference is ENABLED, the user will receive + + notifications for the Confluent Cloud resource. If the + resource preference is DISABLED, the user will not + + receive any notification for the resource. + + Note that, you will still receive notifications for + `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + required: + - resource + - resource_type + responses: + '201': + description: A Resource Preference was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: >- + https://api.confluent.cloud/notifications/v1/resource-preferences/{id} + description: ResourcePreference resource uri + content: + application/json: + schema: + type: object + description: >- + `ResourcePreference` objects represent the intent of the + customers to enable or disable all notifications + + at the resource level. A ResourcePreference is created for a + specific Confluent Cloud Resource + + (e.g., a connector) and determines whether the user will + receive notifications for that resource. + + + This API allows you to create, retrieve, update and delete + resourcePreferences. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Resource Preferences Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourcePreference + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: >- + environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the resource preference. When the + resource preference is ENABLED, the user will receive + + notifications for the Confluent Cloud resource. If the + resource preference is DISABLED, the user will not + + receive any notification for the resource. + + Note that, you will still receive notifications for + `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + required: + - resource + - resource_type + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/resource-preferences/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNotificationsV1ResourcePreference + summary: Read a Resource Preference + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a resource preference. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource preference. + tags: + - Resource Preferences (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Resource Preference. + content: + application/json: + schema: + type: object + description: >- + `ResourcePreference` objects represent the intent of the + customers to enable or disable all notifications + + at the resource level. A ResourcePreference is created for a + specific Confluent Cloud Resource + + (e.g., a connector) and determines whether the user will + receive notifications for that resource. + + + This API allows you to create, retrieve, update and delete + resourcePreferences. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Resource Preferences Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourcePreference + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: >- + environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the resource preference. When the + resource preference is ENABLED, the user will receive + + notifications for the Confluent Cloud resource. If the + resource preference is DISABLED, the user will not + + receive any notification for the resource. + + Note that, you will still receive notifications for + `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + required: + - api_version + - kind + - id + - resource + - resource_type + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNotificationsV1ResourcePreference + summary: Update a Resource Preference + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a resource preference. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource preference. + tags: + - Resource Preferences (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/notifications.v1.ResourcePreference' + responses: + '200': + description: Resource Preference. + content: + application/json: + schema: + type: object + description: >- + `ResourcePreference` objects represent the intent of the + customers to enable or disable all notifications + + at the resource level. A ResourcePreference is created for a + specific Confluent Cloud Resource + + (e.g., a connector) and determines whether the user will + receive notifications for that resource. + + + This API allows you to create, retrieve, update and delete + resourcePreferences. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Resource Preferences Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourcePreference + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: >- + environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the resource preference. When the + resource preference is ENABLED, the user will receive + + notifications for the Confluent Cloud resource. If the + resource preference is DISABLED, the user will not + + receive any notification for the resource. + + Note that, you will still receive notifications for + `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + required: + - api_version + - kind + - id + - resource + - resource_type + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNotificationsV1ResourcePreference + summary: Delete a Resource Preference + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a resource preference. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource preference. + tags: + - Resource Preferences (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Resource Preference is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/resource-preferences:lookup: + get: + summary: Lookup a resource preference by filter (returns one) + parameters: + - name: resource + description: Confluent Cloud resource definition + in: query + required: true + schema: + type: string + - name: resource_type + description: Confluent Cloud resource type + in: query + required: true + schema: + type: string + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 250 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + x-lifecycle-stage: General Availability + x-self-access: true + x-name: notifications.v1.ResourcePreference + operationId: getNotificationsV1ResourcePreferenceByFilter + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read_by_filter a resource preference. + tags: + - Resource Preferences (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Resource Preference. + content: + application/json: + schema: + type: object + description: >- + `ResourcePreference` objects represent the intent of the + customers to enable or disable all notifications + + at the resource level. A ResourcePreference is created for a + specific Confluent Cloud Resource + + (e.g., a connector) and determines whether the user will + receive notifications for that resource. + + + This API allows you to create, retrieve, update and delete + resourcePreferences. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Resource Preferences Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourcePreference + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: >- + environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the resource preference. When the + resource preference is ENABLED, the user will receive + + notifications for the Confluent Cloud resource. If the + resource preference is DISABLED, the user will not + + receive any notification for the resource. + + Note that, you will still receive notifications for + `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + required: + - api_version + - kind + - id + - resource + - resource_type + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/resource-subscriptions: + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNotificationsV1ResourceSubscription + summary: Create a Resource Subscription + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a resource subscription. + tags: + - Resource Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `ResourceSubscription` objects represent the intent of the + customers to get notifications of particular types + + at the resource level. A ResourceSubscription is created for a + specific Confluent Cloud Resource + + (e.g., a connector) and determines whether the user will receive + notifications for that resource. + + + This API allows you to create, retrieve, update, delete and list + ResourceSubscription. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Resource Subscriptions Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscription + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: >- + environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the resource preference. When the + resource preference is ENABLED, the user will receive + + notifications for the Confluent Cloud resource. If the + resource preference is DISABLED, the user will not + + receive any notification for the resource. + + Note that, you will still receive notifications for + `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - resource + - resource_type + - notification_type + - integrations + responses: + '201': + description: A Resource Subscription was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: >- + https://api.confluent.cloud/notifications/v1/resource-subscriptions/{id} + description: ResourceSubscription resource uri + content: + application/json: + schema: + type: object + description: >- + `ResourceSubscription` objects represent the intent of the + customers to get notifications of particular types + + at the resource level. A ResourceSubscription is created for a + specific Confluent Cloud Resource + + (e.g., a connector) and determines whether the user will + receive notifications for that resource. + + + This API allows you to create, retrieve, update, delete and + list ResourceSubscription. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Resource Subscriptions Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscription + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: >- + environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the resource preference. When the + resource preference is ENABLED, the user will receive + + notifications for the Confluent Cloud resource. If the + resource preference is DISABLED, the user will not + + receive any notification for the resource. + + Note that, you will still receive notifications for + `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - resource + - resource_type + - notification_type + - integrations + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/resource-subscriptions/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNotificationsV1ResourceSubscription + summary: Read a Resource Subscription + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a resource subscription. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource subscription. + tags: + - Resource Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Resource Subscription. + content: + application/json: + schema: + type: object + description: >- + `ResourceSubscription` objects represent the intent of the + customers to get notifications of particular types + + at the resource level. A ResourceSubscription is created for a + specific Confluent Cloud Resource + + (e.g., a connector) and determines whether the user will + receive notifications for that resource. + + + This API allows you to create, retrieve, update, delete and + list ResourceSubscription. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Resource Subscriptions Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscription + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: >- + environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the resource preference. When the + resource preference is ENABLED, the user will receive + + notifications for the Confluent Cloud resource. If the + resource preference is DISABLED, the user will not + + receive any notification for the resource. + + Note that, you will still receive notifications for + `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - api_version + - kind + - id + - resource + - resource_type + - notification_type + - integrations + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNotificationsV1ResourceSubscription + summary: Update a Resource Subscription + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a resource subscription. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource subscription. + tags: + - Resource Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/notifications.v1.ResourceSubscription' + responses: + '200': + description: Resource Subscription. + content: + application/json: + schema: + type: object + description: >- + `ResourceSubscription` objects represent the intent of the + customers to get notifications of particular types + + at the resource level. A ResourceSubscription is created for a + specific Confluent Cloud Resource + + (e.g., a connector) and determines whether the user will + receive notifications for that resource. + + + This API allows you to create, retrieve, update, delete and + list ResourceSubscription. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Resource Subscriptions Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscription + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: >- + environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the resource preference. When the + resource preference is ENABLED, the user will receive + + notifications for the Confluent Cloud resource. If the + resource preference is DISABLED, the user will not + + receive any notification for the resource. + + Note that, you will still receive notifications for + `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - api_version + - kind + - id + - resource + - resource_type + - notification_type + - integrations + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNotificationsV1ResourceSubscription + summary: Delete a Resource Subscription + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a resource subscription. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource subscription. + tags: + - Resource Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Resource Subscription is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/resource-subscriptions:lookup: + get: + summary: Lookup a list of resource subscription by filter + parameters: + - name: resource + description: Confluent Cloud resource definition + in: query + required: true + schema: + type: string + - name: resource_type + description: Confluent Cloud resource type + in: query + required: true + schema: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 250 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNotificationsV1ResourceSubscriptionsByFilter + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to list_by_filter a resource subscription. + tags: + - Resource Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: List of ResourceSubscriptions + content: + application/json: + schema: + type: object + description: >- + `ResourceSubscription` objects represent the intent of the + customers to get notifications of particular types + + at the resource level. A ResourceSubscription is created for a + specific Confluent Cloud Resource + + (e.g., a connector) and determines whether the user will + receive notifications for that resource. + + + This API allows you to create, retrieve, update, delete and + list ResourceSubscription. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Resource Subscriptions Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscriptionList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `ResourceSubscription` objects represent the intent of + the customers to get notifications of particular types + + at the resource level. A ResourceSubscription is created + for a specific Confluent Cloud Resource + + (e.g., a connector) and determines whether the user will + receive notifications for that resource. + + + This API allows you to create, retrieve, update, delete + and list ResourceSubscription. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Resource Subscriptions Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - ResourceSubscription + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: >- + environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the resource preference. When + the resource preference is ENABLED, the user will + receive + + notifications for the Confluent Cloud resource. If + the resource preference is DISABLED, the user will + not + + receive any notification for the resource. + + Note that, you will still receive notifications for + `REQUIRED` notification type even when it is + DISABLED. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - id + - metadata + - resource + - resource_type + - notification_type + - integrations + uniqueItems: true + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + notifications.v1.SubscriptionList: + type: object + description: >- + `Subscription` objects represent the intent of the customers to get + notifications of particular types. + + A subscription is created for a particular `NotificationType` and the + user will get notifications on the + + `Integrations` that are provided while creating the subscription. + + + This API allows you to create, retrieve, and update subscriptions, + + as well as to view the list of all your subscriptions. You can also + delete subscriptions + + with RECOMMENDED or OPTIONAL notification types. Subscriptions with + REQUIRED notification types cannot be deleted. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Subscriptions Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - SubscriptionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Subscription` objects represent the intent of the customers to + get notifications of particular types. + + A subscription is created for a particular `NotificationType` and + the user will get notifications on the + + `Integrations` that are provided while creating the subscription. + + + This API allows you to create, retrieve, and update subscriptions, + + as well as to view the list of all your subscriptions. You can + also delete subscriptions + + with RECOMMENDED or OPTIONAL notification types. Subscriptions + with REQUIRED notification types cannot be deleted. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Subscriptions Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Subscription + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the subscription. When the subscription + is ENABLED, the user will receive + + notification on the configured Integrations. If the + subscription is DISABLED, the user will not + + recieve any notification for the configured notification type. + Note that, you cannot disable + + a subscription for `REQUIRED` notification type. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - id + - metadata + - notification_type + - integrations + uniqueItems: true + notifications.v1.Subscription: + type: object + description: >- + `Subscription` objects represent the intent of the customers to get + notifications of particular types. + + A subscription is created for a particular `NotificationType` and the + user will get notifications on the + + `Integrations` that are provided while creating the subscription. + + + This API allows you to create, retrieve, and update subscriptions, + + as well as to view the list of all your subscriptions. You can also + delete subscriptions + + with RECOMMENDED or OPTIONAL notification types. Subscriptions with + REQUIRED notification types cannot be deleted. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Subscriptions Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Subscription + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the subscription. When the subscription is + ENABLED, the user will receive + + notification on the configured Integrations. If the subscription is + DISABLED, the user will not + + recieve any notification for the configured notification type. Note + that, you cannot disable + + a subscription for `REQUIRED` notification type. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + notifications.v1.IntegrationList: + type: object + description: >- + You can create an `Integration` to specify how we can notify you when we + receive an alert/notification for + + a subscription. Please note that you can only perform create, update and + delete operations for integrations + + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or + delete integrations of type `RoleEmail` + + and `UserEmail`. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Integrations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `integrations_per_org` | Maximum number of integrations in one + Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + You can create an `Integration` to specify how we can notify you + when we receive an alert/notification for + + a subscription. Please note that you can only perform create, + update and delete operations for integrations + + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, + update or delete integrations of type `RoleEmail` + + and `UserEmail`. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Integrations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `integrations_per_org` | Maximum number of integrations in one + Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: | + A human readable description for the particular integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + required: + - id + - metadata + - display_name + - target + uniqueItems: true + notifications.v1.Integration: + type: object + description: >- + You can create an `Integration` to specify how we can notify you when we + receive an alert/notification for + + a subscription. Please note that you can only perform create, update and + delete operations for integrations + + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or + delete integrations of type `RoleEmail` + + and `UserEmail`. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Integrations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `integrations_per_org` | Maximum number of integrations in one + Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: | + A human readable description for the particular integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + notifications.v1.NotificationType: + type: object + description: >- + The type of notifications (and their corresponding metadata) supported + by Confluent. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Notification Types Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NotificationType + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: | + Human readable display name of the notification type + example: Cluster Shrink + category: + type: string + x-extensible-enum: + - BILLING_LICENSING + - SECURITY + - SERVICE + - ACCOUNT + description: > + Represents the group with which the notification is associated. + + Notifications are grouped under certain categories for better + organization. + + - BILLING_LICENSING: All billing, payments or licensing related + notifications are grouped here. + + - SECURITY: All Confluent Cloud and Platform security related + notifications are grouped here. + + - SERVICE: All Confluent services (eg. Kafka, Schema Registry, + Connect etc.) related notifications are + grouped here. + - ACCOUNT: All Confluent account related notifications are grouped + here. + + For example: Billing, payment or license related notifications are + grouped in BILLING_LICENSING category. + example: BILLING_LICENSING + description: + type: string + description: | + Human readable description of the notification type + example: Cluster shrink operation is completed + subscription_priority: + type: string + x-extensible-enum: + - REQUIRED + - RECOMMENDED + - OPTIONAL + description: > + Indicates whether the notification is auto-subscribed and if the + user can opt-out. + + - REQUIRED: the user is auto-subscribed to this notification and + can't opt-out. + + - RECOMMENDED: the user is auto-subscribed to this notification and + can opt-out. + + - OPTIONAL: the user is not auto-subscribed to this notification but + can explicitly subscribe to it. + example: REQUIRED + is_included_in_plan: + type: boolean + description: | + Whether this notification is available to subscribe or not + as per the user's current billing plan. + severity: + type: string + x-extensible-enum: + - CRITICAL + - WARN + - INFO + description: > + Severity indicates the impact of this notification. + + - CRITICAL: a high impact notification which needs immediate + attention. + + - WARN: a warning notification which can be addressed now or later. + + - INFO: an informational notification. + example: INFO + notifications.v1.NotificationTypeList: + type: object + description: >- + The type of notifications (and their corresponding metadata) supported + by Confluent. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Notification Types Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NotificationTypeList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + The type of notifications (and their corresponding metadata) + supported by Confluent. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Notification Types Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NotificationType + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + description: | + Human readable display name of the notification type + example: Cluster Shrink + category: + type: string + x-extensible-enum: + - BILLING_LICENSING + - SECURITY + - SERVICE + - ACCOUNT + description: > + Represents the group with which the notification is + associated. + + Notifications are grouped under certain categories for better + organization. + + - BILLING_LICENSING: All billing, payments or licensing + related notifications are grouped here. + + - SECURITY: All Confluent Cloud and Platform security related + notifications are grouped here. + + - SERVICE: All Confluent services (eg. Kafka, Schema Registry, + Connect etc.) related notifications are + grouped here. + - ACCOUNT: All Confluent account related notifications are + grouped here. + + For example: Billing, payment or license related notifications + are grouped in BILLING_LICENSING category. + example: BILLING_LICENSING + description: + type: string + description: | + Human readable description of the notification type + example: Cluster shrink operation is completed + subscription_priority: + type: string + x-extensible-enum: + - REQUIRED + - RECOMMENDED + - OPTIONAL + description: > + Indicates whether the notification is auto-subscribed and if + the user can opt-out. + + - REQUIRED: the user is auto-subscribed to this notification + and can't opt-out. + + - RECOMMENDED: the user is auto-subscribed to this + notification and can opt-out. + + - OPTIONAL: the user is not auto-subscribed to this + notification but can explicitly subscribe to it. + example: REQUIRED + is_included_in_plan: + type: boolean + description: | + Whether this notification is available to subscribe or not + as per the user's current billing plan. + severity: + type: string + x-extensible-enum: + - CRITICAL + - WARN + - INFO + description: > + Severity indicates the impact of this notification. + + - CRITICAL: a high impact notification which needs immediate + attention. + + - WARN: a warning notification which can be addressed now or + later. + + - INFO: an informational notification. + example: INFO + required: + - id + - metadata + - display_name + - category + - description + - subscription_priority + - is_included_in_plan + - severity + uniqueItems: true + notifications.v1.ResourcePreference: + type: object + description: >- + `ResourcePreference` objects represent the intent of the customers to + enable or disable all notifications + + at the resource level. A ResourcePreference is created for a specific + Confluent Cloud Resource + + (e.g., a connector) and determines whether the user will receive + notifications for that resource. + + + This API allows you to create, retrieve, update and delete + resourcePreferences. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Resource Preferences Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourcePreference + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: >- + environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the resource preference. When the resource + preference is ENABLED, the user will receive + + notifications for the Confluent Cloud resource. If the resource + preference is DISABLED, the user will not + + receive any notification for the resource. + + Note that, you will still receive notifications for `REQUIRED` + notification type even when it is DISABLED. + example: ENABLED + notifications.v1.ResourceSubscription: + type: object + description: >- + `ResourceSubscription` objects represent the intent of the customers to + get notifications of particular types + + at the resource level. A ResourceSubscription is created for a specific + Confluent Cloud Resource + + (e.g., a connector) and determines whether the user will receive + notifications for that resource. + + + This API allows you to create, retrieve, update, delete and list + ResourceSubscription. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Resource Subscriptions Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscription + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: >- + environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the resource preference. When the resource + preference is ENABLED, the user will receive + + notifications for the Confluent Cloud resource. If the resource + preference is DISABLED, the user will not + + receive any notification for the resource. + + Note that, you will still receive notifications for `REQUIRED` + notification type even when it is DISABLED. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + notifications.v1.ResourceSubscriptionList: + type: object + description: >- + `ResourceSubscription` objects represent the intent of the customers to + get notifications of particular types + + at the resource level. A ResourceSubscription is created for a specific + Confluent Cloud Resource + + (e.g., a connector) and determines whether the user will receive + notifications for that resource. + + + This API allows you to create, retrieve, update, delete and list + ResourceSubscription. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Resource Subscriptions Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscriptionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `ResourceSubscription` objects represent the intent of the + customers to get notifications of particular types + + at the resource level. A ResourceSubscription is created for a + specific Confluent Cloud Resource + + (e.g., a connector) and determines whether the user will receive + notifications for that resource. + + + This API allows you to create, retrieve, update, delete and list + ResourceSubscription. + + + + Related guide: [Cloud + Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + + ## The Resource Subscriptions Model + + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscription + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: >- + environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: > + Denotes the state of the resource preference. When the + resource preference is ENABLED, the user will receive + + notifications for the Confluent Cloud resource. If the + resource preference is DISABLED, the user will not + + receive any notification for the resource. + + Note that, you will still receive notifications for `REQUIRED` + notification type even when it is DISABLED. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - id + - metadata + - resource + - resource_type + - notification_type + - integrations + uniqueItems: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + GlobalObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + notifications.v1.Target: + description: Target for the particular integration + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + notifications.v1.SlackTarget: + type: object + description: Target required for Slack integration + required: + - kind + - webhook_url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + notifications.v1.RoleEmailTarget: + type: object + description: Email integration target to send email to all user with specified role + required: + - kind + - role_name + properties: + kind: + type: string + enum: + - RoleEmail + description: Email Integration type for Role + example: RoleEmail + role_name: + type: string + description: name of the role + example: OrganizationAdmin + notifications.v1.UserEmailTarget: + type: object + description: Email integration target to send email to a particular user + required: + - kind + - user + properties: + kind: + type: string + enum: + - UserEmail + description: Email Integration type for User + example: UserEmail + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + notifications.v1.WebhookTarget: + type: object + description: Target required for webhook integration + required: + - kind + - url + properties: + kind: + type: string + enum: + - Webhook + description: Integration Type + example: Webhook + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + notifications.v1.MsTeamsTarget: + type: object + description: Target required for MS Teams integration + required: + - kind + - webhook_url + properties: + kind: + type: string + enum: + - MsTeams + description: Integration Type + example: MsTeams + webhook_url: + type: string + format: uri + description: MS Teams Webhook URL for the particular team channel + example: https://admin.webhook.office.com/webhookb2/{id}/IncomingWebhook/{id} + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + OverQuotaError: + x-summary: Over Quota + description: The request would exceed one or more quotas. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '402' + code: quota_exceeded + title: Kafka Clusters Per Org Quota Exceeded + detail: >- + The request would exceed the quota: + kafka_clusters_per_environment + x-stackQL-resources: + subscriptions: + id: confluent.notifications.subscriptions + name: subscriptions + title: Subscriptions + methods: + list_notifications_v1_subscriptions: + operation: + $ref: '#/paths/~1notifications~1v1~1subscriptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_notifications_v1_subscription: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1notifications~1v1~1subscriptions/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_notifications_v1_subscription: + operation: + $ref: '#/paths/~1notifications~1v1~1subscriptions~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_notifications_v1_subscription: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1notifications~1v1~1subscriptions~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_notifications_v1_subscription: + operation: + $ref: '#/paths/~1notifications~1v1~1subscriptions~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/subscriptions/methods/get_notifications_v1_subscription + - $ref: >- + #/components/x-stackQL-resources/subscriptions/methods/list_notifications_v1_subscriptions + insert: + - $ref: >- + #/components/x-stackQL-resources/subscriptions/methods/create_notifications_v1_subscription + update: + - $ref: >- + #/components/x-stackQL-resources/subscriptions/methods/update_notifications_v1_subscription + delete: + - $ref: >- + #/components/x-stackQL-resources/subscriptions/methods/delete_notifications_v1_subscription + replace: [] + integrations: + id: confluent.notifications.integrations + name: integrations + title: Integrations + methods: + list_notifications_v1_integrations: + operation: + $ref: '#/paths/~1notifications~1v1~1integrations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_notifications_v1_integration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1notifications~1v1~1integrations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_notifications_v1_integration: + operation: + $ref: '#/paths/~1notifications~1v1~1integrations~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_notifications_v1_integration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1notifications~1v1~1integrations~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_notifications_v1_integration: + operation: + $ref: '#/paths/~1notifications~1v1~1integrations~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + test_notifications_v1_integration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1notifications~1v1~1integrations:test/post' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/integrations/methods/get_notifications_v1_integration + - $ref: >- + #/components/x-stackQL-resources/integrations/methods/list_notifications_v1_integrations + insert: + - $ref: >- + #/components/x-stackQL-resources/integrations/methods/create_notifications_v1_integration + update: + - $ref: >- + #/components/x-stackQL-resources/integrations/methods/update_notifications_v1_integration + delete: + - $ref: >- + #/components/x-stackQL-resources/integrations/methods/delete_notifications_v1_integration + replace: [] + notification_types: + id: confluent.notifications.notification_types + name: notification_types + title: Notification Types + methods: + get_notifications_v1_notification_type: + operation: + $ref: '#/paths/~1notifications~1v1~1notification-types~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_notifications_v1_notification_types: + operation: + $ref: '#/paths/~1notifications~1v1~1notification-types/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/notification_types/methods/get_notifications_v1_notification_type + - $ref: >- + #/components/x-stackQL-resources/notification_types/methods/list_notifications_v1_notification_types + insert: [] + update: [] + delete: [] + replace: [] + resource_preferences: + id: confluent.notifications.resource_preferences + name: resource_preferences + title: Resource Preferences + methods: + create_notifications_v1_resource_preference: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1notifications~1v1~1resource-preferences/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_notifications_v1_resource_preference: + operation: + $ref: '#/paths/~1notifications~1v1~1resource-preferences~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_notifications_v1_resource_preference: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1notifications~1v1~1resource-preferences~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_notifications_v1_resource_preference: + operation: + $ref: '#/paths/~1notifications~1v1~1resource-preferences~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + get_notifications_v1_resource_preference_by_filter: + operation: + $ref: '#/paths/~1notifications~1v1~1resource-preferences:lookup/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/resource_preferences/methods/get_notifications_v1_resource_preference + - $ref: >- + #/components/x-stackQL-resources/resource_preferences/methods/get_notifications_v1_resource_preference_by_filter + insert: + - $ref: >- + #/components/x-stackQL-resources/resource_preferences/methods/create_notifications_v1_resource_preference + update: + - $ref: >- + #/components/x-stackQL-resources/resource_preferences/methods/update_notifications_v1_resource_preference + delete: + - $ref: >- + #/components/x-stackQL-resources/resource_preferences/methods/delete_notifications_v1_resource_preference + replace: [] + resource_subscriptions: + id: confluent.notifications.resource_subscriptions + name: resource_subscriptions + title: Resource Subscriptions + methods: + create_notifications_v1_resource_subscription: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1notifications~1v1~1resource-subscriptions/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_notifications_v1_resource_subscription: + operation: + $ref: '#/paths/~1notifications~1v1~1resource-subscriptions~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_notifications_v1_resource_subscription: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1notifications~1v1~1resource-subscriptions~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_notifications_v1_resource_subscription: + operation: + $ref: '#/paths/~1notifications~1v1~1resource-subscriptions~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_notifications_v1_resource_subscriptions_by_filter: + operation: + $ref: '#/paths/~1notifications~1v1~1resource-subscriptions:lookup/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/resource_subscriptions/methods/get_notifications_v1_resource_subscription + - $ref: >- + #/components/x-stackQL-resources/resource_subscriptions/methods/list_notifications_v1_resource_subscriptions_by_filter + insert: + - $ref: >- + #/components/x-stackQL-resources/resource_subscriptions/methods/create_notifications_v1_resource_subscription + update: + - $ref: >- + #/components/x-stackQL-resources/resource_subscriptions/methods/update_notifications_v1_resource_subscription + delete: + - $ref: >- + #/components/x-stackQL-resources/resource_subscriptions/methods/delete_notifications_v1_resource_subscription + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/org.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/org.yaml new file mode 100644 index 0000000..10461ca --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/org.yaml @@ -0,0 +1,3580 @@ +openapi: 3.0.0 +info: + title: org API + description: confluent org API + version: 1.0.0 +paths: + /org/v2/environments: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listOrgV2Environments + summary: List of Environments + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all environments. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Environments (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Environment. + content: + application/json: + schema: + type: object + description: >- + `Environment` objects represent an isolated namespace for your + Confluent resources + + for organizational purposes. + + + The API allows you to create, delete, and update your + environments. You can retrieve + + individual environments as well as a list of all your + environments. + + + + Related guide: [Environments in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + + ## The Environments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `environments_per_org` | Environments in one Confluent Cloud + organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - EnvironmentList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Environment` objects represent an isolated namespace + for your Confluent resources + + for organizational purposes. + + + The API allows you to create, delete, and update your + environments. You can retrieve + + individual environments as well as a list of all your + environments. + + + + Related guide: [Environments in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + + ## The Environments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `environments_per_org` | Environments in one Confluent + Cloud organization | + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Environment + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: prod-finance01 + description: A human-readable name for the Environment + stream_governance_config: + type: object + description: Stream Governance configurations for the environment + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: > + Stream Governance Package. Supported values are + ESSENTIALS and ADVANCED. + + Package comparison can be found + + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + required: + - id + - metadata + - display_name + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createOrgV2Environment + summary: Create an Environment + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create an environment. + tags: + - Environments (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Environment` objects represent an isolated namespace for your + Confluent resources + + for organizational purposes. + + + The API allows you to create, delete, and update your + environments. You can retrieve + + individual environments as well as a list of all your + environments. + + + + Related guide: [Environments in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + + ## The Environments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `environments_per_org` | Environments in one Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Environment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + example: prod-finance01 + description: A human-readable name for the Environment + stream_governance_config: + type: object + description: Stream Governance configurations for the environment + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: > + Stream Governance Package. Supported values are + ESSENTIALS and ADVANCED. + + Package comparison can be found + + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + required: + - display_name + responses: + '201': + description: An Environment was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/org/v2/environments/{id} + description: Environment resource uri + content: + application/json: + schema: + type: object + description: >- + `Environment` objects represent an isolated namespace for your + Confluent resources + + for organizational purposes. + + + The API allows you to create, delete, and update your + environments. You can retrieve + + individual environments as well as a list of all your + environments. + + + + Related guide: [Environments in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + + ## The Environments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `environments_per_org` | Environments in one Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Environment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + example: prod-finance01 + description: A human-readable name for the Environment + stream_governance_config: + type: object + description: Stream Governance configurations for the environment + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: > + Stream Governance Package. Supported values are + ESSENTIALS and ADVANCED. + + Package comparison can be found + + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + required: + - display_name + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /org/v2/environments/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getOrgV2Environment + summary: Read an Environment + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read an environment. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the environment. + tags: + - Environments (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Environment. + content: + application/json: + schema: + type: object + description: >- + `Environment` objects represent an isolated namespace for your + Confluent resources + + for organizational purposes. + + + The API allows you to create, delete, and update your + environments. You can retrieve + + individual environments as well as a list of all your + environments. + + + + Related guide: [Environments in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + + ## The Environments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `environments_per_org` | Environments in one Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Environment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + example: prod-finance01 + description: A human-readable name for the Environment + stream_governance_config: + type: object + description: Stream Governance configurations for the environment + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: > + Stream Governance Package. Supported values are + ESSENTIALS and ADVANCED. + + Package comparison can be found + + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + required: + - api_version + - kind + - id + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateOrgV2Environment + summary: Update an Environment + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update an environment. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the environment. + tags: + - Environments (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/org.v2.Environment' + responses: + '200': + description: Environment. + content: + application/json: + schema: + type: object + description: >- + `Environment` objects represent an isolated namespace for your + Confluent resources + + for organizational purposes. + + + The API allows you to create, delete, and update your + environments. You can retrieve + + individual environments as well as a list of all your + environments. + + + + Related guide: [Environments in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + + ## The Environments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `environments_per_org` | Environments in one Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Environment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + example: prod-finance01 + description: A human-readable name for the Environment + stream_governance_config: + type: object + description: Stream Governance configurations for the environment + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: > + Stream Governance Package. Supported values are + ESSENTIALS and ADVANCED. + + Package comparison can be found + + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + required: + - api_version + - kind + - id + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteOrgV2Environment + summary: Delete an Environment + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete an environment. + + + If successful, this request will also recursively delete all of the + environment's associated resources, + + including all Kafka clusters, connectors, etc. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the environment. + tags: + - Environments (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Environment is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /org/v2/organizations: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listOrgV2Organizations + summary: List of Organizations + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all organizations. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Organizations (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Organization. + content: + application/json: + schema: + type: object + description: >- + `Organization` objects represent a customer organization. An + organization contains all customer + + resources (e.g., Environments, Kafka Clusters, Service + Accounts, API Keys) and is tied to a billing + + agreement (including any annual commitment or support plan). + + + The API allows you to list, view, and update your + organizations. + + + + Related guide: [Organizations for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + + ## The Organizations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `organizations_per_user` | Confluent Cloud organizations a + user belongs to | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OrganizationList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Organization` objects represent a customer + organization. An organization contains all customer + + resources (e.g., Environments, Kafka Clusters, Service + Accounts, API Keys) and is tied to a billing + + agreement (including any annual commitment or support + plan). + + + The API allows you to list, view, and update your + organizations. + + + + Related guide: [Organizations for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + + ## The Organizations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `organizations_per_user` | Confluent Cloud + organizations a user belongs to | + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Organization + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: Finance Org + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + description: A human-readable name for the Organization + jit_enabled: + type: boolean + description: >- + The flag to toggle Just-In-Time user provisioning + for SSO-enabled organization. Available for early + access only. + required: + - id + - metadata + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /org/v2/organizations/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getOrgV2Organization + summary: Read an Organization + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read an organization. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the organization. + tags: + - Organizations (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Organization. + content: + application/json: + schema: + type: object + description: >- + `Organization` objects represent a customer organization. An + organization contains all customer + + resources (e.g., Environments, Kafka Clusters, Service + Accounts, API Keys) and is tied to a billing + + agreement (including any annual commitment or support plan). + + + The API allows you to list, view, and update your + organizations. + + + + Related guide: [Organizations for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + + ## The Organizations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `organizations_per_user` | Confluent Cloud organizations a + user belongs to | + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + example: Finance Org + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + description: A human-readable name for the Organization + jit_enabled: + type: boolean + description: >- + The flag to toggle Just-In-Time user provisioning for + SSO-enabled organization. Available for early access only. + required: + - api_version + - kind + - id + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateOrgV2Organization + summary: Update an Organization + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update an organization. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the organization. + tags: + - Organizations (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/org.v2.Organization' + responses: + '200': + description: Organization. + content: + application/json: + schema: + type: object + description: >- + `Organization` objects represent a customer organization. An + organization contains all customer + + resources (e.g., Environments, Kafka Clusters, Service + Accounts, API Keys) and is tied to a billing + + agreement (including any annual commitment or support plan). + + + The API allows you to list, view, and update your + organizations. + + + + Related guide: [Organizations for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + + ## The Organizations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `organizations_per_user` | Confluent Cloud organizations a + user belongs to | + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + display_name: + type: string + example: Finance Org + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + description: A human-readable name for the Organization + jit_enabled: + type: boolean + description: >- + The flag to toggle Just-In-Time user provisioning for + SSO-enabled organization. Available for early access only. + required: + - api_version + - kind + - id + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + org.v2.EnvironmentList: + type: object + description: >- + `Environment` objects represent an isolated namespace for your Confluent + resources + + for organizational purposes. + + + The API allows you to create, delete, and update your environments. You + can retrieve + + individual environments as well as a list of all your environments. + + + + Related guide: [Environments in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + + ## The Environments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `environments_per_org` | Environments in one Confluent Cloud + organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - EnvironmentList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Environment` objects represent an isolated namespace for your + Confluent resources + + for organizational purposes. + + + The API allows you to create, delete, and update your + environments. You can retrieve + + individual environments as well as a list of all your + environments. + + + + Related guide: [Environments in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + + ## The Environments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `environments_per_org` | Environments in one Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Environment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + example: prod-finance01 + description: A human-readable name for the Environment + stream_governance_config: + type: object + description: Stream Governance configurations for the environment + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: > + Stream Governance Package. Supported values are ESSENTIALS + and ADVANCED. + + Package comparison can be found + + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + required: + - id + - metadata + - display_name + uniqueItems: true + org.v2.Environment: + type: object + description: >- + `Environment` objects represent an isolated namespace for your Confluent + resources + + for organizational purposes. + + + The API allows you to create, delete, and update your environments. You + can retrieve + + individual environments as well as a list of all your environments. + + + + Related guide: [Environments in Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + + ## The Environments Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `environments_per_org` | Environments in one Confluent Cloud + organization | + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Environment + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: prod-finance01 + description: A human-readable name for the Environment + stream_governance_config: + type: object + description: Stream Governance configurations for the environment + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: > + Stream Governance Package. Supported values are ESSENTIALS and + ADVANCED. + + Package comparison can be found + + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + org.v2.OrganizationList: + type: object + description: >- + `Organization` objects represent a customer organization. An + organization contains all customer + + resources (e.g., Environments, Kafka Clusters, Service Accounts, API + Keys) and is tied to a billing + + agreement (including any annual commitment or support plan). + + + The API allows you to list, view, and update your organizations. + + + + Related guide: [Organizations for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + + ## The Organizations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `organizations_per_user` | Confluent Cloud organizations a user + belongs to | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OrganizationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Organization` objects represent a customer organization. An + organization contains all customer + + resources (e.g., Environments, Kafka Clusters, Service Accounts, + API Keys) and is tied to a billing + + agreement (including any annual commitment or support plan). + + + The API allows you to list, view, and update your organizations. + + + + Related guide: [Organizations for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + + ## The Organizations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `organizations_per_user` | Confluent Cloud organizations a user + belongs to | + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + display_name: + type: string + example: Finance Org + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + description: A human-readable name for the Organization + jit_enabled: + type: boolean + description: >- + The flag to toggle Just-In-Time user provisioning for + SSO-enabled organization. Available for early access only. + required: + - id + - metadata + uniqueItems: true + org.v2.Organization: + type: object + description: >- + `Organization` objects represent a customer organization. An + organization contains all customer + + resources (e.g., Environments, Kafka Clusters, Service Accounts, API + Keys) and is tied to a billing + + agreement (including any annual commitment or support plan). + + + The API allows you to list, view, and update your organizations. + + + + Related guide: [Organizations for Confluent + Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + + ## The Organizations Model + + + + + ## Quotas and Limits + + This resource is subject to the [following + quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + + | Quota | Description | + + | --- | --- | + + | `organizations_per_user` | Confluent Cloud organizations a user + belongs to | + properties: + api_version: + type: string + enum: + - org/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: Finance Org + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + description: A human-readable name for the Organization + jit_enabled: + type: boolean + description: >- + The flag to toggle Just-In-Time user provisioning for SSO-enabled + organization. Available for early access only. + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + org.v2.StreamGovernanceConfig: + description: | + Configurations pertaining to Stream Governance + type: object + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: > + Stream Governance Package. Supported values are ESSENTIALS and + ADVANCED. + + Package comparison can be found + + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + OverQuotaError: + x-summary: Over Quota + description: The request would exceed one or more quotas. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '402' + code: quota_exceeded + title: Kafka Clusters Per Org Quota Exceeded + detail: >- + The request would exceed the quota: + kafka_clusters_per_environment + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + x-stackQL-resources: + environments: + id: confluent.org.environments + name: environments + title: Environments + methods: + list_org_v2_environments: + operation: + $ref: '#/paths/~1org~1v2~1environments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_org_v2_environment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1org~1v2~1environments/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_org_v2_environment: + operation: + $ref: '#/paths/~1org~1v2~1environments~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_org_v2_environment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1org~1v2~1environments~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_org_v2_environment: + operation: + $ref: '#/paths/~1org~1v2~1environments~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/environments/methods/get_org_v2_environment + - $ref: >- + #/components/x-stackQL-resources/environments/methods/list_org_v2_environments + insert: + - $ref: >- + #/components/x-stackQL-resources/environments/methods/create_org_v2_environment + update: + - $ref: >- + #/components/x-stackQL-resources/environments/methods/update_org_v2_environment + delete: + - $ref: >- + #/components/x-stackQL-resources/environments/methods/delete_org_v2_environment + replace: [] + organizations: + id: confluent.org.organizations + name: organizations + title: Organizations + methods: + list_org_v2_organizations: + operation: + $ref: '#/paths/~1org~1v2~1organizations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_org_v2_organization: + operation: + $ref: '#/paths/~1org~1v2~1organizations~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_org_v2_organization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1org~1v2~1organizations~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/get_org_v2_organization + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/list_org_v2_organizations + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/update_org_v2_organization + delete: [] + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/partner.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/partner.yaml new file mode 100644 index 0000000..f0c0364 --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/partner.yaml @@ -0,0 +1,2762 @@ +openapi: 3.0.0 +info: + title: partner API + description: confluent partner API + version: 1.0.0 +paths: + /partner/v2/entitlements: + get: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + operationId: listPartnerV2Entitlements + summary: List of Entitlements + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Partner + v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Retrieve a sorted, filtered, paginated list of all entitlements. + parameters: + - name: organization.id + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: Filter the results by exact match for organization.id. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + description: An opaque pagination token for collection requests. + tags: + - Entitlements (partner/v2) + security: + - oauth: + - partner:describe + responses: + '200': + description: Entitlement. + content: + application/json: + schema: + $ref: '#/components/schemas/partner.v2.EntitlementList' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-codeSamples: + - lang: Shell + source: |- + curl --request GET \ + --url 'https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE' \ + --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' + - lang: Java + source: |- + OkHttpClient client = new OkHttpClient(); + + Request request = new Request.Builder() + .url("https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE") + .get() + .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN") + .build(); + + Response response = client.newCall(request).execute(); + - lang: Go + source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" + - lang: Python + source: >- + import http.client + + + conn = http.client.HTTPSConnection("api.confluent.cloud") + + + headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" } + + + conn.request("GET", + "/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE", + headers=headers) + + + res = conn.getresponse() + + data = res.read() + + + print(data.decode("utf-8")) + - lang: Node + source: |- + const http = require("https"); + + const options = { + "method": "GET", + "hostname": "api.confluent.cloud", + "port": null, + "path": "/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE", + "headers": { + "Authorization": "Bearer REPLACE_BEARER_TOKEN" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.end(); + - lang: C + source: >- + CURL *hnd = curl_easy_init(); + + + curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); + + curl_easy_setopt(hnd, CURLOPT_URL, + "https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE"); + + + struct curl_slist *headers = NULL; + + headers = curl_slist_append(headers, "Authorization: Bearer + REPLACE_BEARER_TOKEN"); + + curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); + + + CURLcode ret = curl_easy_perform(hnd); + - lang: C# + source: >- + var client = new + RestClient("https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE"); + + var request = new RestRequest(Method.GET); + + request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); + + IRestResponse response = client.Execute(request); + post: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + operationId: createPartnerV2Entitlement + summary: Create an Entitlement + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Partner + v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Make a request to create an entitlement. + tags: + - Entitlements (partner/v2) + security: + - oauth: + - partner:create + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Entitlement` objects represent metadata about a marketplace + entitlement. + properties: + api_version: + type: string + enum: + - partner/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Entitlement + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + external_id: + type: string + description: >- + The unique external ID of the entitlement (this should be + unique to customer) + example: 1111-2222-3333-4444 + name: + type: string + description: The name of the entitlement + example: Acme Prod Entitlement + plan_id: + type: string + description: The plan ID the entitlement + example: confluent-cloud-payg-prod + x-extensible-enum: + - confluent-cloud-payg-prod + - payg-prod.gcpmarketplace.confluent.cloud + product_id: + type: string + description: The product ID of the entitlement + example: confluent-cloud-kafka-service-azure + x-extensible-enum: + - confluent-cloud-kafka-service-azure + - confluent-cloud-for-apache-kafka + - payg-prod.gcpmarketplace.confluent.cloud + usage_reporting_id: + type: string + description: > + The usage reporting ID of the entitlement (if usage + reporting uses + + a different ID, otherwise, same as external_id) + example: 1111-2222-3333-4444 + resource_id: + type: string + description: The resource ID of the entitlement + example: 1111-2222-3333-4444 + organization: + description: The organization associated with this object. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + additionalProperties: false + required: + - external_id + - name + - plan_id + - product_id + responses: + '201': + description: An Entitlement is being created. + headers: + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/partner/v2/entitlements/{id} + description: Entitlement resource uri + content: + application/json: + schema: + type: object + description: >- + `Entitlement` objects represent metadata about a marketplace + entitlement. + properties: + api_version: + type: string + enum: + - partner/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Entitlement + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + external_id: + type: string + description: >- + The unique external ID of the entitlement (this should be + unique to customer) + example: 1111-2222-3333-4444 + name: + type: string + description: The name of the entitlement + example: Acme Prod Entitlement + plan_id: + type: string + description: The plan ID the entitlement + example: confluent-cloud-payg-prod + x-extensible-enum: + - confluent-cloud-payg-prod + - payg-prod.gcpmarketplace.confluent.cloud + product_id: + type: string + description: The product ID of the entitlement + example: confluent-cloud-kafka-service-azure + x-extensible-enum: + - confluent-cloud-kafka-service-azure + - confluent-cloud-for-apache-kafka + - payg-prod.gcpmarketplace.confluent.cloud + usage_reporting_id: + type: string + description: > + The usage reporting ID of the entitlement (if usage + reporting uses + + a different ID, otherwise, same as external_id) + example: 1111-2222-3333-4444 + resource_id: + type: string + description: The resource ID of the entitlement + example: 1111-2222-3333-4444 + organization: + description: The organization associated with this object. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + additionalProperties: false + required: + - external_id + - name + - plan_id + - product_id + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-codeSamples: + - lang: Shell + source: |- + curl --request POST \ + --url https://api.confluent.cloud/partner/v2/entitlements \ + --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \ + --header 'content-type: application/json' \ + --data '{"external_id":"1111-2222-3333-4444","name":"Acme Prod Entitlement","plan_id":"confluent-cloud-payg-prod","product_id":"confluent-cloud-kafka-service-azure","usage_reporting_id":"1111-2222-3333-4444","resource_id":"1111-2222-3333-4444","organization":{"related":"string"}}' + - lang: Java + source: >- + OkHttpClient client = new OkHttpClient(); + + + MediaType mediaType = MediaType.parse("application/json"); + + RequestBody body = RequestBody.create(mediaType, + "{\"external_id\":\"1111-2222-3333-4444\",\"name\":\"Acme Prod + Entitlement\",\"plan_id\":\"confluent-cloud-payg-prod\",\"product_id\":\"confluent-cloud-kafka-service-azure\",\"usage_reporting_id\":\"1111-2222-3333-4444\",\"resource_id\":\"1111-2222-3333-4444\",\"organization\":{\"related\":\"string\"}}"); + + Request request = new Request.Builder() + .url("https://api.confluent.cloud/partner/v2/entitlements") + .post(body) + .addHeader("content-type", "application/json") + .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN") + .build(); + + Response response = client.newCall(request).execute(); + - lang: Go + source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.confluent.cloud/partner/v2/entitlements\"\n\n\tpayload := strings.NewReader(\"{\\\"external_id\\\":\\\"1111-2222-3333-4444\\\",\\\"name\\\":\\\"Acme Prod Entitlement\\\",\\\"plan_id\\\":\\\"confluent-cloud-payg-prod\\\",\\\"product_id\\\":\\\"confluent-cloud-kafka-service-azure\\\",\\\"usage_reporting_id\\\":\\\"1111-2222-3333-4444\\\",\\\"resource_id\\\":\\\"1111-2222-3333-4444\\\",\\\"organization\\\":{\\\"related\\\":\\\"string\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" + - lang: Python + source: >- + import http.client + + + conn = http.client.HTTPSConnection("api.confluent.cloud") + + + payload = "{\"external_id\":\"1111-2222-3333-4444\",\"name\":\"Acme + Prod + Entitlement\",\"plan_id\":\"confluent-cloud-payg-prod\",\"product_id\":\"confluent-cloud-kafka-service-azure\",\"usage_reporting_id\":\"1111-2222-3333-4444\",\"resource_id\":\"1111-2222-3333-4444\",\"organization\":{\"related\":\"string\"}}" + + + headers = { + 'content-type': "application/json", + 'Authorization': "Bearer REPLACE_BEARER_TOKEN" + } + + conn.request("POST", "/partner/v2/entitlements", payload, headers) + + + res = conn.getresponse() + + data = res.read() + + + print(data.decode("utf-8")) + - lang: Node + source: |- + const http = require("https"); + + const options = { + "method": "POST", + "hostname": "api.confluent.cloud", + "port": null, + "path": "/partner/v2/entitlements", + "headers": { + "content-type": "application/json", + "Authorization": "Bearer REPLACE_BEARER_TOKEN" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.write(JSON.stringify({ + external_id: '1111-2222-3333-4444', + name: 'Acme Prod Entitlement', + plan_id: 'confluent-cloud-payg-prod', + product_id: 'confluent-cloud-kafka-service-azure', + usage_reporting_id: '1111-2222-3333-4444', + resource_id: '1111-2222-3333-4444', + organization: {related: 'string'} + })); + req.end(); + - lang: C + source: >- + CURL *hnd = curl_easy_init(); + + + curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST"); + + curl_easy_setopt(hnd, CURLOPT_URL, + "https://api.confluent.cloud/partner/v2/entitlements"); + + + struct curl_slist *headers = NULL; + + headers = curl_slist_append(headers, "content-type: + application/json"); + + headers = curl_slist_append(headers, "Authorization: Bearer + REPLACE_BEARER_TOKEN"); + + curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); + + + curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, + "{\"external_id\":\"1111-2222-3333-4444\",\"name\":\"Acme Prod + Entitlement\",\"plan_id\":\"confluent-cloud-payg-prod\",\"product_id\":\"confluent-cloud-kafka-service-azure\",\"usage_reporting_id\":\"1111-2222-3333-4444\",\"resource_id\":\"1111-2222-3333-4444\",\"organization\":{\"related\":\"string\"}}"); + + + CURLcode ret = curl_easy_perform(hnd); + - lang: C# + source: >- + var client = new + RestClient("https://api.confluent.cloud/partner/v2/entitlements"); + + var request = new RestRequest(Method.POST); + + request.AddHeader("content-type", "application/json"); + + request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); + + request.AddParameter("application/json", + "{\"external_id\":\"1111-2222-3333-4444\",\"name\":\"Acme Prod + Entitlement\",\"plan_id\":\"confluent-cloud-payg-prod\",\"product_id\":\"confluent-cloud-kafka-service-azure\",\"usage_reporting_id\":\"1111-2222-3333-4444\",\"resource_id\":\"1111-2222-3333-4444\",\"organization\":{\"related\":\"string\"}}", + ParameterType.RequestBody); + + IRestResponse response = client.Execute(request); + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + /partner/v2/entitlements/{id}: + get: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + operationId: getPartnerV2Entitlement + summary: Read an Entitlement + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Partner + v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Make a request to read an entitlement. + parameters: + - name: organization.id + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: Scope the operation to the given organization.id. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the entitlement. + tags: + - Entitlements (partner/v2) + security: + - oauth: + - partner:describe + responses: + '200': + description: Entitlement. + content: + application/json: + schema: + type: object + description: >- + `Entitlement` objects represent metadata about a marketplace + entitlement. + properties: + api_version: + type: string + enum: + - partner/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Entitlement + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + external_id: + type: string + description: >- + The unique external ID of the entitlement (this should be + unique to customer) + example: 1111-2222-3333-4444 + name: + type: string + description: The name of the entitlement + example: Acme Prod Entitlement + plan_id: + type: string + description: The plan ID the entitlement + example: confluent-cloud-payg-prod + x-extensible-enum: + - confluent-cloud-payg-prod + - payg-prod.gcpmarketplace.confluent.cloud + product_id: + type: string + description: The product ID of the entitlement + example: confluent-cloud-kafka-service-azure + x-extensible-enum: + - confluent-cloud-kafka-service-azure + - confluent-cloud-for-apache-kafka + - payg-prod.gcpmarketplace.confluent.cloud + usage_reporting_id: + type: string + description: > + The usage reporting ID of the entitlement (if usage + reporting uses + + a different ID, otherwise, same as external_id) + example: 1111-2222-3333-4444 + resource_id: + type: string + description: The resource ID of the entitlement + example: 1111-2222-3333-4444 + organization: + description: The organization associated with this object. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + additionalProperties: false + required: + - external_id + - name + - plan_id + - product_id + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-codeSamples: + - lang: Shell + source: |- + curl --request GET \ + --url 'https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE' \ + --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' + - lang: Java + source: |- + OkHttpClient client = new OkHttpClient(); + + Request request = new Request.Builder() + .url("https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE") + .get() + .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN") + .build(); + + Response response = client.newCall(request).execute(); + - lang: Go + source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" + - lang: Python + source: >- + import http.client + + + conn = http.client.HTTPSConnection("api.confluent.cloud") + + + headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" } + + + conn.request("GET", + "/partner/v2/entitlements/%7Bid%7D?organization.id=SOME_STRING_VALUE", + headers=headers) + + + res = conn.getresponse() + + data = res.read() + + + print(data.decode("utf-8")) + - lang: Node + source: |- + const http = require("https"); + + const options = { + "method": "GET", + "hostname": "api.confluent.cloud", + "port": null, + "path": "/partner/v2/entitlements/%7Bid%7D?organization.id=SOME_STRING_VALUE", + "headers": { + "Authorization": "Bearer REPLACE_BEARER_TOKEN" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.end(); + - lang: C + source: >- + CURL *hnd = curl_easy_init(); + + + curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); + + curl_easy_setopt(hnd, CURLOPT_URL, + "https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE"); + + + struct curl_slist *headers = NULL; + + headers = curl_slist_append(headers, "Authorization: Bearer + REPLACE_BEARER_TOKEN"); + + curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); + + + CURLcode ret = curl_easy_perform(hnd); + - lang: C# + source: >- + var client = new + RestClient("https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE"); + + var request = new RestRequest(Method.GET); + + request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); + + IRestResponse response = client.Execute(request); + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + /partner/v2/organizations/{id}: + get: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + operationId: getPartnerV2Organization + summary: Read an Organization + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Partner + v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Make a request to read an organization. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the organization. + tags: + - Organizations (partner/v2) + security: + - oauth: + - marketplace::describe + responses: + '200': + description: Organization. + content: + application/json: + schema: + type: object + description: >- + `Organizations` objects represent an entire Confluent Cloud + organization. + properties: + api_version: + type: string + enum: + - partner/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + name: + type: string + description: The name of the organization + example: Acme Organization + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + sso_url: + type: string + format: uri + description: The login URL for the customer to access Confluent Cloud + example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn + readOnly: true + sso_config: + discriminator: + propertyName: kind + type: object + required: + - kind + - tenant_id + properties: + kind: + type: string + example: AzureSSOConfig + tenant_id: + type: string + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: The Azure AD tenant ID + additionalProperties: false + required: + - api_version + - kind + - id + - metadata + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-codeSamples: + - lang: Shell + source: |- + curl --request GET \ + --url 'https://api.confluent.cloud/partner/v2/organizations/{id}' \ + --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' + - lang: Java + source: |- + OkHttpClient client = new OkHttpClient(); + + Request request = new Request.Builder() + .url("https://api.confluent.cloud/partner/v2/organizations/{id}") + .get() + .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN") + .build(); + + Response response = client.newCall(request).execute(); + - lang: Go + source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.confluent.cloud/partner/v2/organizations/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" + - lang: Python + source: >- + import http.client + + + conn = http.client.HTTPSConnection("api.confluent.cloud") + + + headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" } + + + conn.request("GET", "/partner/v2/organizations/{id}", + headers=headers) + + + res = conn.getresponse() + + data = res.read() + + + print(data.decode("utf-8")) + - lang: Node + source: |- + const http = require("https"); + + const options = { + "method": "GET", + "hostname": "api.confluent.cloud", + "port": null, + "path": "/partner/v2/organizations/{id}", + "headers": { + "Authorization": "Bearer REPLACE_BEARER_TOKEN" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.end(); + - lang: C + source: >- + CURL *hnd = curl_easy_init(); + + + curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); + + curl_easy_setopt(hnd, CURLOPT_URL, + "https://api.confluent.cloud/partner/v2/organizations/{id}"); + + + struct curl_slist *headers = NULL; + + headers = curl_slist_append(headers, "Authorization: Bearer + REPLACE_BEARER_TOKEN"); + + curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); + + + CURLcode ret = curl_easy_perform(hnd); + - lang: C# + source: >- + var client = new + RestClient("https://api.confluent.cloud/partner/v2/organizations/{id}"); + + var request = new RestRequest(Method.GET); + + request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); + + IRestResponse response = client.Execute(request); + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + /partner/v2/organizations: + get: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + operationId: listPartnerV2Organizations + summary: List of Organizations + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Partner + v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Retrieve a sorted, filtered, paginated list of all organizations. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + description: An opaque pagination token for collection requests. + tags: + - Organizations (partner/v2) + security: + - oauth: + - marketplace::describe + responses: + '200': + description: Organization. + content: + application/json: + schema: + $ref: '#/components/schemas/partner.v2.OrganizationList' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-codeSamples: + - lang: Shell + source: |- + curl --request GET \ + --url 'https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE' \ + --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' + - lang: Java + source: |- + OkHttpClient client = new OkHttpClient(); + + Request request = new Request.Builder() + .url("https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE") + .get() + .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN") + .build(); + + Response response = client.newCall(request).execute(); + - lang: Go + source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" + - lang: Python + source: >- + import http.client + + + conn = http.client.HTTPSConnection("api.confluent.cloud") + + + headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" } + + + conn.request("GET", + "/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE", + headers=headers) + + + res = conn.getresponse() + + data = res.read() + + + print(data.decode("utf-8")) + - lang: Node + source: |- + const http = require("https"); + + const options = { + "method": "GET", + "hostname": "api.confluent.cloud", + "port": null, + "path": "/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE", + "headers": { + "Authorization": "Bearer REPLACE_BEARER_TOKEN" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.end(); + - lang: C + source: >- + CURL *hnd = curl_easy_init(); + + + curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); + + curl_easy_setopt(hnd, CURLOPT_URL, + "https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE"); + + + struct curl_slist *headers = NULL; + + headers = curl_slist_append(headers, "Authorization: Bearer + REPLACE_BEARER_TOKEN"); + + curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); + + + CURLcode ret = curl_easy_perform(hnd); + - lang: C# + source: >- + var client = new + RestClient("https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE"); + + var request = new RestRequest(Method.GET); + + request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); + + IRestResponse response = client.Execute(request); + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + /partner/v2/signup: + post: + summary: Signup an Organization on behalf of a Customer + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Partner + v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Create an organization for a customer. You must pass in either an + entitlement object reference (a url to + + a previously created entitlement) or entitlement details. If you pass in + an entitlement object reference, we will link with the + + created entitlement. If you pass in the entitlement details, we will + create the entitlement with the organization + + in a single transaction. If you pass in user details (email, given name, + and family name), we will + + create a user as well. If you do not pass in user details, you MUST call + `/partner/v2/signup/activate` + + with user details to complete signup. + parameters: + - name: dry_run + in: query + required: false + schema: + type: boolean + description: If true, only perform validation of signup + requestBody: + description: A JSON object containing signup information + content: + application/json: + schema: + $ref: '#/components/schemas/PartnerSignupRequest' + x-lifecycle-stage: Early Access + operationId: signup + tags: + - Signup (partner/v2) + security: + - oauth: + - partner:create + responses: + '201': + description: Successful signup. + content: + application/json: + schema: + $ref: '#/components/schemas/PartnerSignupResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /partner/v2/signup/activate: + post: + summary: Activate an Incomplete Signup + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Partner + v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Creates a user in the organization previously created in + `/partner/v2/signup`. This completes the signup + + process if you did not pass in user details to `/partner/v2/signup`. + Calling this endpoint if the signup + + process has been completed will result in a `409 Conflict` error. + requestBody: + description: A JSON object containing signup information + content: + application/json: + schema: + $ref: '#/components/schemas/ActivatePartnerSignupRequest' + x-lifecycle-stage: Early Access + operationId: activateSignup + tags: + - Signup (partner/v2) + security: + - oauth: + - partner:create + responses: + '201': + description: Successful signup activation. User is being created. + content: + application/json: + schema: + $ref: '#/components/schemas/PartnerSignupResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Early Access + /partner/v2/signup/link: + post: + summary: Signup a Customer by Linking to an Existing Organization + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Partner + v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Signup a customer by linking a new entitlement to an existing Confluent + Cloud organization. + parameters: + - name: dry_run + in: query + required: false + schema: + type: boolean + description: If true, only perform validation of signup + requestBody: + description: A JSON object containing signup information + content: + application/json: + schema: + $ref: '#/components/schemas/PartnerLinkRequest' + x-lifecycle-stage: Early Access + operationId: signupPartnerV2Link + tags: + - Signup (partner/v2) + security: + - oauth: + - partner:create + responses: + '201': + description: Successful signup. + content: + application/json: + schema: + $ref: '#/components/schemas/PartnerSignupResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + partner.v2.EntitlementList: + type: object + description: >- + `Entitlement` objects represent metadata about a marketplace + entitlement. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - partner/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - EntitlementList + metadata: + $ref: '#/components/schemas/ListMeta' + data: + type: array + items: + type: object + description: >- + `Entitlement` objects represent metadata about a marketplace + entitlement. + properties: + api_version: + type: string + enum: + - partner/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Entitlement + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + external_id: + type: string + description: >- + The unique external ID of the entitlement (this should be + unique to customer) + example: 1111-2222-3333-4444 + name: + type: string + description: The name of the entitlement + example: Acme Prod Entitlement + plan_id: + type: string + description: The plan ID the entitlement + example: confluent-cloud-payg-prod + x-extensible-enum: + - confluent-cloud-payg-prod + - payg-prod.gcpmarketplace.confluent.cloud + product_id: + type: string + description: The product ID of the entitlement + example: confluent-cloud-kafka-service-azure + x-extensible-enum: + - confluent-cloud-kafka-service-azure + - confluent-cloud-for-apache-kafka + - payg-prod.gcpmarketplace.confluent.cloud + usage_reporting_id: + type: string + description: > + The usage reporting ID of the entitlement (if usage reporting + uses + + a different ID, otherwise, same as external_id) + example: 1111-2222-3333-4444 + resource_id: + type: string + description: The resource ID of the entitlement + example: 1111-2222-3333-4444 + organization: + description: The organization associated with this object. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + additionalProperties: false + required: + - id + - metadata + - external_id + - name + - plan_id + - product_id + uniqueItems: true + additionalProperties: false + partner.v2.Entitlement: + type: object + description: >- + `Entitlement` objects represent metadata about a marketplace + entitlement. + properties: + api_version: + type: string + enum: + - partner/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Entitlement + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + external_id: + type: string + description: >- + The unique external ID of the entitlement (this should be unique to + customer) + example: 1111-2222-3333-4444 + name: + type: string + description: The name of the entitlement + example: Acme Prod Entitlement + plan_id: + type: string + description: The plan ID the entitlement + example: confluent-cloud-payg-prod + x-extensible-enum: + - confluent-cloud-payg-prod + - payg-prod.gcpmarketplace.confluent.cloud + product_id: + type: string + description: The product ID of the entitlement + example: confluent-cloud-kafka-service-azure + x-extensible-enum: + - confluent-cloud-kafka-service-azure + - confluent-cloud-for-apache-kafka + - payg-prod.gcpmarketplace.confluent.cloud + usage_reporting_id: + type: string + description: | + The usage reporting ID of the entitlement (if usage reporting uses + a different ID, otherwise, same as external_id) + example: 1111-2222-3333-4444 + resource_id: + type: string + description: The resource ID of the entitlement + example: 1111-2222-3333-4444 + organization: + description: The organization associated with this object. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + additionalProperties: false + partner.v2.Organization: + type: object + description: >- + `Organizations` objects represent an entire Confluent Cloud + organization. + properties: + api_version: + type: string + enum: + - partner/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + name: + type: string + description: The name of the organization + example: Acme Organization + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + sso_url: + type: string + format: uri + description: The login URL for the customer to access Confluent Cloud + example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn + readOnly: true + sso_config: + discriminator: + propertyName: kind + type: object + required: + - kind + - tenant_id + properties: + kind: + type: string + example: AzureSSOConfig + tenant_id: + type: string + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: The Azure AD tenant ID + additionalProperties: false + partner.v2.OrganizationList: + type: object + description: >- + `Organizations` objects represent an entire Confluent Cloud + organization. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - partner/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OrganizationList + metadata: + $ref: '#/components/schemas/ListMeta' + data: + type: array + items: + type: object + description: >- + `Organizations` objects represent an entire Confluent Cloud + organization. + properties: + api_version: + type: string + enum: + - partner/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + name: + type: string + description: The name of the organization + example: Acme Organization + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + sso_url: + type: string + format: uri + description: The login URL for the customer to access Confluent Cloud + example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn + readOnly: true + sso_config: + discriminator: + propertyName: kind + type: object + required: + - kind + - tenant_id + properties: + kind: + type: string + example: AzureSSOConfig + tenant_id: + type: string + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: The Azure AD tenant ID + additionalProperties: false + required: + - id + - metadata + uniqueItems: true + additionalProperties: false + PartnerSignupRequest: + type: object + description: The partner signup request + required: + - organization + - entitlement + properties: + organization: + type: object + description: >- + `Organizations` objects represent an entire Confluent Cloud + organization. + properties: + api_version: + type: string + enum: + - partner/v2 + description: >- + APIVersion defines the schema version of this representation of + a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be reclaimed + and reused after an object is deleted ("time"); however, it may + collide with IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + name: + type: string + description: The name of the organization + example: Acme Organization + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + sso_url: + type: string + format: uri + description: The login URL for the customer to access Confluent Cloud + example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn + readOnly: true + sso_config: + discriminator: + propertyName: kind + type: object + required: + - kind + - tenant_id + properties: + kind: + type: string + example: AzureSSOConfig + tenant_id: + type: string + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: The Azure AD tenant ID + additionalProperties: false + required: + - name + - sso_config + user: + type: string + description: (opaque JSON object) + required: + - given_name + - family_name + - email + entitlement: + type: object + description: >- + `Entitlement` objects represent metadata about a marketplace + entitlement. + properties: + api_version: + type: string + enum: + - partner/v2 + description: >- + APIVersion defines the schema version of this representation of + a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Entitlement + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be reclaimed + and reused after an object is deleted ("time"); however, it may + collide with IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + external_id: + type: string + description: >- + The unique external ID of the entitlement (this should be unique + to customer) + example: 1111-2222-3333-4444 + name: + type: string + description: The name of the entitlement + example: Acme Prod Entitlement + plan_id: + type: string + description: The plan ID the entitlement + example: confluent-cloud-payg-prod + x-extensible-enum: + - confluent-cloud-payg-prod + - payg-prod.gcpmarketplace.confluent.cloud + product_id: + type: string + description: The product ID of the entitlement + example: confluent-cloud-kafka-service-azure + x-extensible-enum: + - confluent-cloud-kafka-service-azure + - confluent-cloud-for-apache-kafka + - payg-prod.gcpmarketplace.confluent.cloud + usage_reporting_id: + type: string + description: > + The usage reporting ID of the entitlement (if usage reporting + uses + + a different ID, otherwise, same as external_id) + example: 1111-2222-3333-4444 + resource_id: + type: string + description: The resource ID of the entitlement + example: 1111-2222-3333-4444 + organization: + description: The organization associated with this object. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + additionalProperties: false + required: + - external_id + - name + - plan_id + - product_id + - id + - related + - resource_name + PartnerSignupResponse: + type: object + description: The partner signup response + required: + - organization_id + - sso_url + properties: + organization_id: + type: string + description: The ID of the organization + example: b3a17773-05cc-4431-9560-433fb4613da8 + sso_url: + type: string + format: uri + description: The login URL for the customer to access Confluent Cloud + example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn + display_message: + type: string + description: >- + The display message contains useful information which is shown on + the Marketplace UI to the customers. + example: >- + Your support plan will remain the same, to change the plan, follow + this + [link](https://docs.confluent.io/cloud/current/faq.html#how-do-i-change-support-plans). + ActivatePartnerSignupRequest: + type: object + description: The partner signup activation request + required: + - user + - organization_id + properties: + user: + type: string + description: (opaque JSON object) + required: + - given_name + - family_name + - email + organization_id: + type: string + description: The ID of the organization + example: b3a17773-05cc-4431-9560-433fb4613da8 + PartnerLinkRequest: + type: object + description: The partner linking request + required: + - token + - organization + - entitlement + properties: + token: + type: string + description: The linking token that was generated. + example: >- + eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c + x-redact: true + organization: + type: object + description: >- + `Organizations` objects represent an entire Confluent Cloud + organization. + properties: + api_version: + type: string + enum: + - partner/v2 + description: >- + APIVersion defines the schema version of this representation of + a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be reclaimed + and reused after an object is deleted ("time"); however, it may + collide with IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + name: + type: string + description: The name of the organization + example: Acme Organization + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + sso_url: + type: string + format: uri + description: The login URL for the customer to access Confluent Cloud + example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn + readOnly: true + sso_config: + discriminator: + propertyName: kind + type: object + required: + - kind + - tenant_id + properties: + kind: + type: string + example: AzureSSOConfig + tenant_id: + type: string + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: The Azure AD tenant ID + additionalProperties: false + required: + - sso_config + entitlement: + type: object + description: >- + `Entitlement` objects represent metadata about a marketplace + entitlement. + properties: + api_version: + type: string + enum: + - partner/v2 + description: >- + APIVersion defines the schema version of this representation of + a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Entitlement + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be reclaimed + and reused after an object is deleted ("time"); however, it may + collide with IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + external_id: + type: string + description: >- + The unique external ID of the entitlement (this should be unique + to customer) + example: 1111-2222-3333-4444 + name: + type: string + description: The name of the entitlement + example: Acme Prod Entitlement + plan_id: + type: string + description: The plan ID the entitlement + example: confluent-cloud-payg-prod + x-extensible-enum: + - confluent-cloud-payg-prod + - payg-prod.gcpmarketplace.confluent.cloud + product_id: + type: string + description: The product ID of the entitlement + example: confluent-cloud-kafka-service-azure + x-extensible-enum: + - confluent-cloud-kafka-service-azure + - confluent-cloud-for-apache-kafka + - payg-prod.gcpmarketplace.confluent.cloud + usage_reporting_id: + type: string + description: > + The usage reporting ID of the entitlement (if usage reporting + uses + + a different ID, otherwise, same as external_id) + example: 1111-2222-3333-4444 + resource_id: + type: string + description: The resource ID of the entitlement + example: 1111-2222-3333-4444 + organization: + description: The organization associated with this object. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + additionalProperties: false + required: + - external_id + - name + - plan_id + - product_id + - id + - related + - resource_name + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + ObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + AzureSSOConfig: + type: object + required: + - kind + - tenant_id + properties: + kind: + type: string + example: AzureSSOConfig + tenant_id: + type: string + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: The Azure AD tenant ID + v2.User: + type: string + description: (opaque JSON object) + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + x-stackQL-resources: + entitlements: + id: confluent.partner.entitlements + name: entitlements + title: Entitlements + methods: + list_partner_v2_entitlements: + operation: + $ref: '#/paths/~1partner~1v2~1entitlements/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_partner_v2_entitlement: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1partner~1v2~1entitlements/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_partner_v2_entitlement: + operation: + $ref: '#/paths/~1partner~1v2~1entitlements~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/entitlements/methods/get_partner_v2_entitlement + - $ref: >- + #/components/x-stackQL-resources/entitlements/methods/list_partner_v2_entitlements + insert: + - $ref: >- + #/components/x-stackQL-resources/entitlements/methods/create_partner_v2_entitlement + update: [] + delete: [] + replace: [] + organizations: + id: confluent.partner.organizations + name: organizations + title: Organizations + methods: + get_partner_v2_organization: + operation: + $ref: '#/paths/~1partner~1v2~1organizations~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_partner_v2_organizations: + operation: + $ref: '#/paths/~1partner~1v2~1organizations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/get_partner_v2_organization + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/list_partner_v2_organizations + insert: [] + update: [] + delete: [] + replace: [] + signups: + id: confluent.partner.signups + name: signups + title: Signups + methods: + signup: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1partner~1v2~1signup/post' + response: + mediaType: application/json + openAPIDocKey: '201' + activate_signup: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1partner~1v2~1signup~1activate/post' + response: + mediaType: application/json + openAPIDocKey: '201' + signup_partner_v2_link: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1partner~1v2~1signup~1link/post' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/provider_integrations.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/provider_integrations.yaml new file mode 100644 index 0000000..a40cd2e --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/provider_integrations.yaml @@ -0,0 +1,5597 @@ +openapi: 3.0.0 +info: + title: provider_integrations API + description: confluent provider_integrations API + version: 1.0.0 +paths: + /pim/v1/integrations: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listPimV1Integrations + summary: List of Integrations + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all integrations. + + + If no `provider` filter is specified, returns provider integrations from + all clouds. + parameters: + - name: provider + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for provider. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Integrations (pim/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: >- + `Provider Integration` objects represent access to public + cloud service provider (CSP) resources + + that may be accessed by Confluent resources (for example, + connectors). + + + The API allows you to create, retrieve, and delete individual + integrations, and also obtain a + + list of all your provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - pim/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Provider Integration` objects represent access to + public cloud service provider (CSP) resources + + that may be accessed by Confluent resources (for + example, connectors). + + + The API allows you to create, retrieve, and delete + individual integrations, and also obtain a + + list of all your provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + properties: + api_version: + type: string + enum: + - pim/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: s3_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: >- + Cloud provider to which access is provided through + provider integration. + example: AWS + default: AWS + x-extensible-enum: + - AWS + config: + type: object + description: >- + Cloud provider specific configs for provider + integration + discriminator: + propertyName: kind + mapping: + AwsIntegrationConfig: '#/components/schemas/pim.v1.AwsIntegrationConfig' + x-immutable: true + properties: + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the + Amazon Web Services (AWS) + + Identity and Access Management (IAM) role that + Confluent Cloud uses to assume + + customer IAM role when it accesses resources in + your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses + when it assumes the IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the + Amazon Web Services (AWS) + + Identity and Access Management (IAM) role that + Confluent Cloud assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: >- + Cloud provider specific config to which access + is provided through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + usages: + type: array + description: >- + List of resource crns where this integration is + being used. + minItems: 0 + items: + type: string + description: >- + crn that specifies the resource using this + integration + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true' + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - config + - environment + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createPimV1Integration + summary: Create an Integration + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create an integration. + tags: + - Integrations (pim/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Provider Integration` objects represent access to public cloud + service provider (CSP) resources + + that may be accessed by Confluent resources (for example, + connectors). + + + The API allows you to create, retrieve, and delete individual + integrations, and also obtain a + + list of all your provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + properties: + api_version: + type: string + enum: + - pim/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: s3_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: >- + Cloud provider to which access is provided through provider + integration. + example: AWS + default: AWS + x-extensible-enum: + - AWS + config: + type: object + description: Cloud provider specific configs for provider integration + discriminator: + propertyName: kind + mapping: + AwsIntegrationConfig: '#/components/schemas/pim.v1.AwsIntegrationConfig' + x-immutable: true + properties: + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that Confluent + Cloud uses to assume + + customer IAM role when it accesses resources in your AWS + account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it + assumes the IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that Confluent + Cloud assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: >- + Cloud provider specific config to which access is + provided through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true' + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - config + - environment + responses: + '201': + description: An Integration was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/pim/v1/integrations/{id} + description: Integration resource uri + content: + application/json: + schema: + type: object + description: >- + `Provider Integration` objects represent access to public + cloud service provider (CSP) resources + + that may be accessed by Confluent resources (for example, + connectors). + + + The API allows you to create, retrieve, and delete individual + integrations, and also obtain a + + list of all your provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + properties: + api_version: + type: string + enum: + - pim/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: s3_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: >- + Cloud provider to which access is provided through + provider integration. + example: AWS + default: AWS + x-extensible-enum: + - AWS + config: + type: object + description: Cloud provider specific configs for provider integration + discriminator: + propertyName: kind + mapping: + AwsIntegrationConfig: '#/components/schemas/pim.v1.AwsIntegrationConfig' + x-immutable: true + properties: + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that + Confluent Cloud uses to assume + + customer IAM role when it accesses resources in your + AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it + assumes the IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that + Confluent Cloud assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: >- + Cloud provider specific config to which access is + provided through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + usages: + type: array + description: >- + List of resource crns where this integration is being + used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true' + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - config + - environment + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /pim/v1/integrations/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getPimV1Integration + summary: Read an Integration + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read an integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (pim/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: >- + `Provider Integration` objects represent access to public + cloud service provider (CSP) resources + + that may be accessed by Confluent resources (for example, + connectors). + + + The API allows you to create, retrieve, and delete individual + integrations, and also obtain a + + list of all your provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + properties: + api_version: + type: string + enum: + - pim/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: s3_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: >- + Cloud provider to which access is provided through + provider integration. + example: AWS + default: AWS + x-extensible-enum: + - AWS + config: + type: object + description: Cloud provider specific configs for provider integration + discriminator: + propertyName: kind + mapping: + AwsIntegrationConfig: '#/components/schemas/pim.v1.AwsIntegrationConfig' + x-immutable: true + properties: + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that + Confluent Cloud uses to assume + + customer IAM role when it accesses resources in your + AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it + assumes the IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that + Confluent Cloud assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: >- + Cloud provider specific config to which access is + provided through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + usages: + type: array + description: >- + List of resource crns where this integration is being + used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true' + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - config + - environment + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deletePimV1Integration + summary: Delete an Integration + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete an integration. + + + This request fails if existing workloads are using this CSP integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (pim/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Integration is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /pim/v2/integrations: + get: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + operationId: listPimV2Integrations + summary: List of Integrations + description: > + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Provider + Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Retrieve a sorted, filtered, paginated list of all integrations. + + + If no `provider` filter is specified, returns provider integrations from + all clouds. + parameters: + - name: display_name + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: bigquery_provider_integration + description: Filter the results by a partial search of display_name. + - name: provider + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: GCP + description: Filter the results by exact match for provider. + - name: status + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: CREATED + description: Filter the results by exact match for status. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: >- + `Provider Integration` objects represent access to public + cloud service provider (CSP) resources + + that may be accessed by Confluent resources (for example, + connectors). + + + The API allows you to create, retrieve, update, delete, and + validate individual integrations, and also obtain a + + list of all your provider integrations. + + + Note: The pim/v2 API currently supports only Azure and GCP + provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - pim/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Provider Integration` objects represent access to + public cloud service provider (CSP) resources + + that may be accessed by Confluent resources (for + example, connectors). + + + The API allows you to create, retrieve, update, delete, + and validate individual integrations, and also obtain a + + list of all your provider integrations. + + + Note: The pim/v2 API currently supports only Azure and + GCP provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + properties: + api_version: + type: string + enum: + - pim/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: >- + Cloud provider to which access is provided through + provider integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: > + Cloud provider specific configuration for the + provider integration. + + Required only when updating integrations with + `DRAFT` status. Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: >- + #/components/schemas/pim.v2.AzureIntegrationConfig + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: > + The ID of the Google Service Account that + Confluent Cloud uses to impersonate + + customer Google Service Account when it accesses + resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: > + The ID of the Google Service Account that + Confluent Cloud impersonates + + to access resources in your GCP Project. + example: >- + customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: >- + Cloud provider specific config to which access + is provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: > + The ID of the Confluent Multi-Tenant App that + Confluent Cloud uses to impersonate + + customer Azure App when it accesses resources in + your Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: > + The ID of the customer's Azure Active Directory + (Azure AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the + Amazon Web Services (AWS) + + Identity and Access Management (IAM) role that + Confluent Cloud uses to assume + + customer IAM role when it accesses resources in + your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses + when it assumes the IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the + Amazon Web Services (AWS) + + Identity and Access Management (IAM) role that + Confluent Cloud assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: >- + List of resource crns where this integration is + being used. + minItems: 0 + items: + type: string + description: >- + crn that specifies the resource using this + integration + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: > + Status of the provider integration. + + - `DRAFT`: Integration exists but is not associated + with customer configuration + + - `CREATED`: Integration has been associated with + customer configuration + + - `ACTIVE`: Integration is in use by Confluent + resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: >- + Environment of the referred resource, if + env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - id + - status + - environment + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + operationId: createPimV2Integration + summary: Create an Integration + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Provider + Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Make a request to create an integration. + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Provider Integration` objects represent access to public cloud + service provider (CSP) resources + + that may be accessed by Confluent resources (for example, + connectors). + + + The API allows you to create, retrieve, update, delete, and + validate individual integrations, and also obtain a + + list of all your provider integrations. + + + Note: The pim/v2 API currently supports only Azure and GCP + provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + properties: + api_version: + type: string + enum: + - pim/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: >- + Cloud provider to which access is provided through provider + integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: > + Cloud provider specific configuration for the provider + integration. + + Required only when updating integrations with `DRAFT` + status. Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent + Cloud uses to impersonate + + customer Google Service Account when it accesses + resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent + Cloud impersonates + + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: >- + Cloud provider specific config to which access is + provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: > + The ID of the Confluent Multi-Tenant App that Confluent + Cloud uses to impersonate + + customer Azure App when it accesses resources in your + Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: > + The ID of the customer's Azure Active Directory (Azure + AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that Confluent + Cloud uses to assume + + customer IAM role when it accesses resources in your AWS + account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it + assumes the IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that Confluent + Cloud assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: > + Status of the provider integration. + + - `DRAFT`: Integration exists but is not associated with + customer configuration + + - `CREATED`: Integration has been associated with customer + configuration + + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - environment + responses: + '201': + description: An Integration was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/pim/v2/integrations/{id} + description: Integration resource uri + content: + application/json: + schema: + type: object + description: >- + `Provider Integration` objects represent access to public + cloud service provider (CSP) resources + + that may be accessed by Confluent resources (for example, + connectors). + + + The API allows you to create, retrieve, update, delete, and + validate individual integrations, and also obtain a + + list of all your provider integrations. + + + Note: The pim/v2 API currently supports only Azure and GCP + provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + properties: + api_version: + type: string + enum: + - pim/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: >- + Cloud provider to which access is provided through + provider integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: > + Cloud provider specific configuration for the provider + integration. + + Required only when updating integrations with `DRAFT` + status. Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent + Cloud uses to impersonate + + customer Google Service Account when it accesses + resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent + Cloud impersonates + + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: >- + Cloud provider specific config to which access is + provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: > + The ID of the Confluent Multi-Tenant App that + Confluent Cloud uses to impersonate + + customer Azure App when it accesses resources in your + Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: > + The ID of the customer's Azure Active Directory (Azure + AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that + Confluent Cloud uses to assume + + customer IAM role when it accesses resources in your + AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it + assumes the IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that + Confluent Cloud assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: >- + List of resource crns where this integration is being + used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: > + Status of the provider integration. + + - `DRAFT`: Integration exists but is not associated with + customer configuration + + - `CREATED`: Integration has been associated with customer + configuration + + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - status + - environment + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + /pim/v2/integrations/{id}: + get: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + operationId: getPimV2Integration + summary: Read an Integration + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Provider + Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Make a request to read an integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: >- + `Provider Integration` objects represent access to public + cloud service provider (CSP) resources + + that may be accessed by Confluent resources (for example, + connectors). + + + The API allows you to create, retrieve, update, delete, and + validate individual integrations, and also obtain a + + list of all your provider integrations. + + + Note: The pim/v2 API currently supports only Azure and GCP + provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + properties: + api_version: + type: string + enum: + - pim/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: >- + Cloud provider to which access is provided through + provider integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: > + Cloud provider specific configuration for the provider + integration. + + Required only when updating integrations with `DRAFT` + status. Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent + Cloud uses to impersonate + + customer Google Service Account when it accesses + resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent + Cloud impersonates + + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: >- + Cloud provider specific config to which access is + provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: > + The ID of the Confluent Multi-Tenant App that + Confluent Cloud uses to impersonate + + customer Azure App when it accesses resources in your + Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: > + The ID of the customer's Azure Active Directory (Azure + AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that + Confluent Cloud uses to assume + + customer IAM role when it accesses resources in your + AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it + assumes the IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that + Confluent Cloud assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: >- + List of resource crns where this integration is being + used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: > + Status of the provider integration. + + - `DRAFT`: Integration exists but is not associated with + customer configuration + + - `CREATED`: Integration has been associated with customer + configuration + + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - status + - environment + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + operationId: updatePimV2Integration + summary: Update an Integration + description: >+ + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Provider + Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Make a request to update an integration. + + + This request only works for integrations with `DRAFT` status. + + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Provider Integration` objects represent access to public cloud + service provider (CSP) resources + + that may be accessed by Confluent resources (for example, + connectors). + + + The API allows you to create, retrieve, update, delete, and + validate individual integrations, and also obtain a + + list of all your provider integrations. + + + Note: The pim/v2 API currently supports only Azure and GCP + provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + properties: + api_version: + type: string + enum: + - pim/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: >- + Cloud provider to which access is provided through provider + integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: > + Cloud provider specific configuration for the provider + integration. + + Required only when updating integrations with `DRAFT` + status. Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent + Cloud uses to impersonate + + customer Google Service Account when it accesses + resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent + Cloud impersonates + + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: >- + Cloud provider specific config to which access is + provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: > + The ID of the Confluent Multi-Tenant App that Confluent + Cloud uses to impersonate + + customer Azure App when it accesses resources in your + Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: > + The ID of the customer's Azure Active Directory (Azure + AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that Confluent + Cloud uses to assume + + customer IAM role when it accesses resources in your AWS + account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it + assumes the IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that Confluent + Cloud assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: > + Status of the provider integration. + + - `DRAFT`: Integration exists but is not associated with + customer configuration + + - `CREATED`: Integration has been associated with customer + configuration + + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - environment + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: >- + `Provider Integration` objects represent access to public + cloud service provider (CSP) resources + + that may be accessed by Confluent resources (for example, + connectors). + + + The API allows you to create, retrieve, update, delete, and + validate individual integrations, and also obtain a + + list of all your provider integrations. + + + Note: The pim/v2 API currently supports only Azure and GCP + provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + properties: + api_version: + type: string + enum: + - pim/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: >- + Cloud provider to which access is provided through + provider integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: > + Cloud provider specific configuration for the provider + integration. + + Required only when updating integrations with `DRAFT` + status. Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent + Cloud uses to impersonate + + customer Google Service Account when it accesses + resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent + Cloud impersonates + + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: >- + Cloud provider specific config to which access is + provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: > + The ID of the Confluent Multi-Tenant App that + Confluent Cloud uses to impersonate + + customer Azure App when it accesses resources in your + Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: > + The ID of the customer's Azure Active Directory (Azure + AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that + Confluent Cloud uses to assume + + customer IAM role when it accesses resources in your + AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it + assumes the IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that + Confluent Cloud assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: >- + List of resource crns where this integration is being + used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: > + Status of the provider integration. + + - `DRAFT`: Integration exists but is not associated with + customer configuration + + - `CREATED`: Integration has been associated with customer + configuration + + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - status + - environment + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + operationId: deletePimV2Integration + summary: Delete an Integration + description: > + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Provider + Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Make a request to delete an integration. + + + This request fails if existing workloads are using this CSP integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Integration is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + /pim/v2/integrations:validate: + post: + description: > + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + [![Request Access To Provider + Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + + Validate the provider integration configuration. + requestBody: + content: + application/json: + schema: + type: object + description: Request to validate the provider integration configuration. + properties: + api_version: + type: string + enum: + - pim/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationValidateRequest + id: + type: string + description: The ID of the provider integration to validate. + example: cspi-00000 + maxLength: 255 + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + config: + type: object + description: > + Cloud provider specific configuration for the provider + integration. + + Required only for integrations in `DRAFT` status. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent + Cloud uses to impersonate + + customer Google Service Account when it accesses + resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent + Cloud impersonates + + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: >- + Cloud provider specific config to which access is + provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: > + The ID of the Confluent Multi-Tenant App that Confluent + Cloud uses to impersonate + + customer Azure App when it accesses resources in your + Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: > + The ID of the customer's Azure Active Directory (Azure + AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that Confluent + Cloud uses to assume + + customer IAM role when it accesses resources in your AWS + account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it + assumes the IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon + Web Services (AWS) + + Identity and Access Management (IAM) role that Confluent + Cloud assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - environment + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + x-name: pim.v2.Integration + operationId: validatePimV2Integration + summary: Validate an Integration + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: The provider integration configuration is validated successfully. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + pim.v1.IntegrationList: + type: object + description: >- + `Provider Integration` objects represent access to public cloud service + provider (CSP) resources + + that may be accessed by Confluent resources (for example, connectors). + + + The API allows you to create, retrieve, and delete individual + integrations, and also obtain a + + list of all your provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - pim/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Provider Integration` objects represent access to public cloud + service provider (CSP) resources + + that may be accessed by Confluent resources (for example, + connectors). + + + The API allows you to create, retrieve, and delete individual + integrations, and also obtain a + + list of all your provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + properties: + api_version: + type: string + enum: + - pim/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: s3_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: >- + Cloud provider to which access is provided through provider + integration. + example: AWS + default: AWS + x-extensible-enum: + - AWS + config: + type: object + description: Cloud provider specific configs for provider integration + discriminator: + propertyName: kind + mapping: + AwsIntegrationConfig: '#/components/schemas/pim.v1.AwsIntegrationConfig' + x-immutable: true + properties: + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon Web + Services (AWS) + + Identity and Access Management (IAM) role that Confluent + Cloud uses to assume + + customer IAM role when it accesses resources in your AWS + account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it + assumes the IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon Web + Services (AWS) + + Identity and Access Management (IAM) role that Confluent + Cloud assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: >- + Cloud provider specific config to which access is provided + through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true' + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - config + - environment + uniqueItems: true + pim.v1.Integration: + type: object + description: >- + `Provider Integration` objects represent access to public cloud service + provider (CSP) resources + + that may be accessed by Confluent resources (for example, connectors). + + + The API allows you to create, retrieve, and delete individual + integrations, and also obtain a + + list of all your provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + properties: + api_version: + type: string + enum: + - pim/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: s3_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: >- + Cloud provider to which access is provided through provider + integration. + example: AWS + default: AWS + x-extensible-enum: + - AWS + config: + type: object + description: Cloud provider specific configs for provider integration + discriminator: + propertyName: kind + mapping: + AwsIntegrationConfig: '#/components/schemas/pim.v1.AwsIntegrationConfig' + x-immutable: true + properties: + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon Web + Services (AWS) + + Identity and Access Management (IAM) role that Confluent Cloud + uses to assume + + customer IAM role when it accesses resources in your AWS + account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it assumes the + IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon Web + Services (AWS) + + Identity and Access Management (IAM) role that Confluent Cloud + assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: >- + Cloud provider specific config to which access is provided + through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true' + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + pim.v2.IntegrationList: + type: object + description: >- + `Provider Integration` objects represent access to public cloud service + provider (CSP) resources + + that may be accessed by Confluent resources (for example, connectors). + + + The API allows you to create, retrieve, update, delete, and validate + individual integrations, and also obtain a + + list of all your provider integrations. + + + Note: The pim/v2 API currently supports only Azure and GCP provider + integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - pim/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Provider Integration` objects represent access to public cloud + service provider (CSP) resources + + that may be accessed by Confluent resources (for example, + connectors). + + + The API allows you to create, retrieve, update, delete, and + validate individual integrations, and also obtain a + + list of all your provider integrations. + + + Note: The pim/v2 API currently supports only Azure and GCP + provider integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + properties: + api_version: + type: string + enum: + - pim/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: >- + Cloud provider to which access is provided through provider + integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: > + Cloud provider specific configuration for the provider + integration. + + Required only when updating integrations with `DRAFT` status. + Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent Cloud + uses to impersonate + + customer Google Service Account when it accesses resources + in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent Cloud + impersonates + + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: >- + Cloud provider specific config to which access is provided + through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: > + The ID of the Confluent Multi-Tenant App that Confluent + Cloud uses to impersonate + + customer Azure App when it accesses resources in your + Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: > + The ID of the customer's Azure Active Directory (Azure AD) + tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon Web + Services (AWS) + + Identity and Access Management (IAM) role that Confluent + Cloud uses to assume + + customer IAM role when it accesses resources in your AWS + account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it + assumes the IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon Web + Services (AWS) + + Identity and Access Management (IAM) role that Confluent + Cloud assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: > + Status of the provider integration. + + - `DRAFT`: Integration exists but is not associated with + customer configuration + + - `CREATED`: Integration has been associated with customer + configuration + + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - id + - status + - environment + uniqueItems: true + pim.v2.Integration: + type: object + description: >- + `Provider Integration` objects represent access to public cloud service + provider (CSP) resources + + that may be accessed by Confluent resources (for example, connectors). + + + The API allows you to create, retrieve, update, delete, and validate + individual integrations, and also obtain a + + list of all your provider integrations. + + + Note: The pim/v2 API currently supports only Azure and GCP provider + integrations. + + + + Related guide: [Provider Integration in Confluent + Cloud](https://docs.confluent.io/home/overview.html). + + + ## The Integrations Model + + + properties: + api_version: + type: string + enum: + - pim/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: >- + Cloud provider to which access is provided through provider + integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: > + Cloud provider specific configuration for the provider integration. + + Required only when updating integrations with `DRAFT` status. Not + required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent Cloud uses + to impersonate + + customer Google Service Account when it accesses resources in + your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent Cloud + impersonates + + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: >- + Cloud provider specific config to which access is provided + through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: > + The ID of the Confluent Multi-Tenant App that Confluent Cloud + uses to impersonate + + customer Azure App when it accesses resources in your Azure + subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: > + The ID of the customer's Azure Active Directory (Azure AD) + tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon Web + Services (AWS) + + Identity and Access Management (IAM) role that Confluent Cloud + uses to assume + + customer IAM role when it accesses resources in your AWS + account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it assumes the + IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon Web + Services (AWS) + + Identity and Access Management (IAM) role that Confluent Cloud + assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: > + Status of the provider integration. + + - `DRAFT`: Integration exists but is not associated with customer + configuration + + - `CREATED`: Integration has been associated with customer + configuration + + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + pim.v2.IntegrationValidateRequest: + type: object + description: Request to validate the provider integration configuration. + properties: + api_version: + type: string + enum: + - pim/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationValidateRequest + id: + type: string + description: The ID of the provider integration to validate. + example: cspi-00000 + maxLength: 255 + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + config: + type: object + description: | + Cloud provider specific configuration for the provider integration. + Required only for integrations in `DRAFT` status. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent Cloud uses + to impersonate + + customer Google Service Account when it accesses resources in + your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent Cloud + impersonates + + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: >- + Cloud provider specific config to which access is provided + through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: > + The ID of the Confluent Multi-Tenant App that Confluent Cloud + uses to impersonate + + customer Azure App when it accesses resources in your Azure + subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: > + The ID of the customer's Azure Active Directory (Azure AD) + tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon Web + Services (AWS) + + Identity and Access Management (IAM) role that Confluent Cloud + uses to assume + + customer IAM role when it accesses resources in your AWS + account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it assumes the + IAM role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon Web + Services (AWS) + + Identity and Access Management (IAM) role that Confluent Cloud + assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + pim.v1.AwsIntegrationConfig: + type: object + description: | + config schema for AWS cloud service provider. + properties: + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon Web Services + (AWS) + + Identity and Access Management (IAM) role that Confluent Cloud uses + to assume + + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it assumes the IAM + role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon Web Services + (AWS) + + Identity and Access Management (IAM) role that Confluent Cloud + assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: >- + Cloud provider specific config to which access is provided through + provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + GlobalObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + pim.v2.GcpIntegrationConfig: + type: object + description: | + config schema for GCP cloud service provider. + properties: + google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent Cloud uses to + impersonate + + customer Google Service Account when it accesses resources in your + GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: > + The ID of the Google Service Account that Confluent Cloud + impersonates + + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: >- + Cloud provider specific config to which access is provided through + provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + required: + - kind + pim.v2.AzureIntegrationConfig: + type: object + description: | + config schema for Azure cloud service provider. + properties: + confluent_multi_tenant_app_id: + type: string + description: > + The ID of the Confluent Multi-Tenant App that Confluent Cloud uses + to impersonate + + customer Azure App when it accesses resources in your Azure + subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: | + The ID of the customer's Azure Active Directory (Azure AD) tenant + example: 12345678-1234-1234-1234-123456789abc + kind: + type: string + description: >- + Cloud provider specific config to which access is provided through + provider integration. + example: AzureIntegrationConfig + x-extensible-enum: + - AzureIntegrationConfig + required: + - kind + pim.v2.AwsIntegrationConfig: + type: object + description: | + config schema for AWS cloud service provider. + properties: + iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon Web Services + (AWS) + + Identity and Access Management (IAM) role that Confluent Cloud uses + to assume + + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: > + Unique external ID that Confluent Cloud uses when it assumes the IAM + role + + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: > + Amazon Resource Name (ARN) that identifies the Amazon Web Services + (AWS) + + Identity and Access Management (IAM) role that Confluent Cloud + assumes when + + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: >- + Cloud provider specific config to which access is provided through + provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + ObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + x-stackQL-resources: + integrations_v1: + id: confluent.provider_integrations.integrations_v1 + name: integrations_v1 + title: Integrations V1 + methods: + list_pim_v1_integrations: + operation: + $ref: '#/paths/~1pim~1v1~1integrations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_pim_v1_integration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1pim~1v1~1integrations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_pim_v1_integration: + operation: + $ref: '#/paths/~1pim~1v1~1integrations~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_pim_v1_integration: + operation: + $ref: '#/paths/~1pim~1v1~1integrations~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/integrations_v1/methods/get_pim_v1_integration + - $ref: >- + #/components/x-stackQL-resources/integrations_v1/methods/list_pim_v1_integrations + insert: + - $ref: >- + #/components/x-stackQL-resources/integrations_v1/methods/create_pim_v1_integration + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/integrations_v1/methods/delete_pim_v1_integration + replace: [] + integrations_v2: + id: confluent.provider_integrations.integrations_v2 + name: integrations_v2 + title: Integrations V2 + methods: + list_pim_v2_integrations: + operation: + $ref: '#/paths/~1pim~1v2~1integrations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_pim_v2_integration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1pim~1v2~1integrations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_pim_v2_integration: + operation: + $ref: '#/paths/~1pim~1v2~1integrations~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_pim_v2_integration: + operation: + $ref: '#/paths/~1pim~1v2~1integrations~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/integrations_v2/methods/get_pim_v2_integration + - $ref: >- + #/components/x-stackQL-resources/integrations_v2/methods/list_pim_v2_integrations + insert: + - $ref: >- + #/components/x-stackQL-resources/integrations_v2/methods/create_pim_v2_integration + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/integrations_v2/methods/delete_pim_v2_integration + replace: [] + integrations: + id: confluent.provider_integrations.integrations + name: integrations + title: Integrations + methods: + update_pim_v2_integration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1pim~1v2~1integrations~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + validate_pim_v2_integration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1pim~1v2~1integrations:validate/post' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/integrations/methods/update_pim_v2_integration + delete: [] + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/quotas.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/quotas.yaml new file mode 100644 index 0000000..34e018f --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/quotas.yaml @@ -0,0 +1,4677 @@ +openapi: 3.0.0 +info: + title: quotas API + description: confluent quotas API + version: 1.0.0 +paths: + /service-quota/v1/applied-quotas: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listServiceQuotaV1AppliedQuotas + summary: List of Applied Quotas + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all applied quotas. + + + Shows all quotas for a given scope. + parameters: + - name: scope + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: ORGANIZATION + description: | + The applied scope the quota belongs to. + - name: environment + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: | + The environment ID the quota is associated with. + - name: network + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: n-12034 + description: | + The network ID the quota is associated with. + - name: kafka_cluster + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: | + The kafka cluster ID the quota is associated with. + - name: id + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: iam.max_environments.per_org + description: | + The id (quota code) that this quota belongs to. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 200 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Applied Quotas (service-quota/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Applied Quota. + content: + application/json: + schema: + type: object + description: >- + A `quota` object represents a quota configuration for a + specific Confluent Cloud resource. + + Use this API to retrieve an individual quota or list of quotas + for a given scope. + + + + Related guide: [Service Quotas for Confluent + Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). + + + ## The Applied Quotas Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AppliedQuotaList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + A `quota` object represents a quota configuration for a + specific Confluent Cloud resource. + + Use this API to retrieve an individual quota or list of + quotas for a given scope. + + + + Related guide: [Service Quotas for Confluent + Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). + + + ## The Applied Quotas Model + + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - AppliedQuota + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + scope: + type: string + description: The applied scope that this quota belongs to. + example: ORGANIZATION + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - NETWORK + - KAFKA_CLUSTER + - SERVICE_ACCOUNT + - USER_ACCOUNT + display_name: + type: string + example: Kafka Cluster Per Organization + description: A human-readable name for the quota type name. + x-immutable: true + default_limit: + type: integer + format: int32 + description: | + The default service quota value. + applied_limit: + type: integer + format: int32 + description: > + The latest applied service quota value, taking into + account any limit adjustments. + usage: + type: integer + description: > + Show the quota usage value if the quota usage is + available for this quota. + format: int32 + user: + description: The user associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + organization: + nullable: true + description: >- + A unique organization id to associate a specific + organization to this quota. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + environment: + nullable: true + description: | + The environment ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + nullable: true + description: | + The network ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: >- + Environment of the referred resource, if + env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + nullable: true + description: | + The kafka cluster ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: >- + Environment of the referred resource, if + env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - scope + - display_name + - default_limit + - applied_limit + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /service-quota/v1/applied-quotas/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getServiceQuotaV1AppliedQuota + summary: Read an Applied Quota + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read an applied quota. + parameters: + - name: environment + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: | + The environment ID the quota is associated with. + This field is only required when retrieving a single quota and + the scope of quota is "ENVIRONMENT" or "NETWORK" or "KAFKA_CLUSTER". + - name: network + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: n-12034 + description: | + The network ID the quota is associated with. + This field is only required when retrieving a single quota and + the scope of quota is "NETWORK". + - name: kafka_cluster + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: > + The kafka cluster ID the quota is associated with. + + This field is required only when the scope of quota is + "KAFKA_CLUSTER". + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the applied quota. + tags: + - Applied Quotas (service-quota/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Applied Quota. + content: + application/json: + schema: + type: object + description: >- + A `quota` object represents a quota configuration for a + specific Confluent Cloud resource. + + Use this API to retrieve an individual quota or list of quotas + for a given scope. + + + + Related guide: [Service Quotas for Confluent + Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). + + + ## The Applied Quotas Model + + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AppliedQuota + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + scope: + type: string + description: The applied scope that this quota belongs to. + example: ORGANIZATION + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - NETWORK + - KAFKA_CLUSTER + - SERVICE_ACCOUNT + - USER_ACCOUNT + display_name: + type: string + example: Kafka Cluster Per Organization + description: A human-readable name for the quota type name. + x-immutable: true + default_limit: + type: integer + format: int32 + description: | + The default service quota value. + applied_limit: + type: integer + format: int32 + description: > + The latest applied service quota value, taking into + account any limit adjustments. + usage: + type: integer + description: > + Show the quota usage value if the quota usage is available + for this quota. + format: int32 + user: + description: The user associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + organization: + nullable: true + description: >- + A unique organization id to associate a specific + organization to this quota. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + environment: + nullable: true + description: | + The environment ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + nullable: true + description: | + The network ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + nullable: true + description: | + The kafka cluster ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - scope + - display_name + - default_limit + - applied_limit + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /service-quota/v1/scopes: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listServiceQuotaV1Scopes + summary: List of Scopes + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all scopes. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 200 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Scopes (service-quota/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Scope. + content: + application/json: + schema: + type: object + description: >- + Gets a list of all available scopes for applied quotas. + + + + Related guide: [Quota + Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). + + + ## The Scopes Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ScopeList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + Gets a list of all available scopes for applied quotas. + + + + Related guide: [Quota + Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). + + + ## The Scopes Model + + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Scope + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + description: + type: string + description: the quota scope for listing quotas queries + example: ORGANIZATION scope that quotas would be applied to + required: + - id + - metadata + - description + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /service-quota/v1/scopes/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getServiceQuotaV1Scope + summary: Read a Scope + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a scope. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the scope. + tags: + - Scopes (service-quota/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Scope. + content: + application/json: + schema: + type: object + description: >- + Gets a list of all available scopes for applied quotas. + + + + Related guide: [Quota + Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). + + + ## The Scopes Model + + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Scope + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + description: + type: string + description: the quota scope for listing quotas queries + example: ORGANIZATION scope that quotas would be applied to + required: + - api_version + - kind + - id + - description + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /kafka-quotas/v1/client-quotas: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listKafkaQuotasV1ClientQuotas + summary: List of Client Quotas + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all client quotas. + parameters: + - name: spec.cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-xxxxx + description: Filter the results by exact match for spec.cluster. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-xxxxx + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Client Quotas (kafka-quotas/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Client Quota. + content: + application/json: + schema: + type: object + description: >- + `ClientQuota` objects represent Client Quotas you can set at + the service account level. + + + The API allows you to list, create, read, update, and delete + your client quotas. + + + + Related guide: [Client Quotas in Confluent + Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + + ## The Client Quotas Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuotaList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `ClientQuota` objects represent Client Quotas you can + set at the service account level. + + + The API allows you to list, create, read, update, and + delete your client quotas. + + + + Related guide: [Client Quotas in Confluent + Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + + ## The Client Quotas Model + + + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - ClientQuota + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaSpec' + required: + - id + - metadata + - spec + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + requestBody: + required: true + content: + application/json: + schema: + example: + spec: + display_name: QuotaForSA1 + description: >- + This quota defines limits on how much the target principals + can use cluster lkc-xxxxx + throughput: + ingress_byte_rate: '5' + egress_byte_rate: '5' + cluster: + id: lkc-xxxxx + principals: + - id: sa-xxxxx + environment: + id: env-xxxxx + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createKafkaQuotasV1ClientQuota + summary: Create a Client Quota + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a client quota. + tags: + - Client Quotas (kafka-quotas/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '202': + description: A Client Quota is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/kafka-quotas/v1/client-quotas/{id} + description: ClientQuota resource uri + content: + application/json: + schema: + type: object + description: >- + `ClientQuota` objects represent Client Quotas you can set at + the service account level. + + + The API allows you to list, create, read, update, and delete + your client quotas. + + + + Related guide: [Client Quotas in Confluent + Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + + ## The Client Quotas Model + + + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuota + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaSpec' + required: + - spec + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /kafka-quotas/v1/client-quotas/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getKafkaQuotasV1ClientQuota + summary: Read a Client Quota + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a client quota. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the client quota. + tags: + - Client Quotas (kafka-quotas/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Client Quota. + content: + application/json: + schema: + type: object + description: >- + `ClientQuota` objects represent Client Quotas you can set at + the service account level. + + + The API allows you to list, create, read, update, and delete + your client quotas. + + + + Related guide: [Client Quotas in Confluent + Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + + ## The Client Quotas Model + + + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuota + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaSpec' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateKafkaQuotasV1ClientQuota + summary: Update a Client Quota + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a client quota. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the client quota. + tags: + - Client Quotas (kafka-quotas/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `ClientQuota` objects represent Client Quotas you can set at the + service account level. + + + The API allows you to list, create, read, update, and delete + your client quotas. + + + + Related guide: [Client Quotas in Confluent + Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + + ## The Client Quotas Model + + + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuota + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaSpec' + required: + - spec + responses: + '200': + description: Client Quota. + content: + application/json: + schema: + type: object + description: >- + `ClientQuota` objects represent Client Quotas you can set at + the service account level. + + + The API allows you to list, create, read, update, and delete + your client quotas. + + + + Related guide: [Client Quotas in Confluent + Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + + ## The Client Quotas Model + + + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuota + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaSpec' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteKafkaQuotasV1ClientQuota + summary: Delete a Client Quota + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a client quota. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the client quota. + tags: + - Client Quotas (kafka-quotas/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Client Quota is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + service-quota.v1.AppliedQuotaList: + type: object + description: >- + A `quota` object represents a quota configuration for a specific + Confluent Cloud resource. + + Use this API to retrieve an individual quota or list of quotas for a + given scope. + + + + Related guide: [Service Quotas for Confluent + Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). + + + ## The Applied Quotas Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AppliedQuotaList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + A `quota` object represents a quota configuration for a specific + Confluent Cloud resource. + + Use this API to retrieve an individual quota or list of quotas for + a given scope. + + + + Related guide: [Service Quotas for Confluent + Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). + + + ## The Applied Quotas Model + + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AppliedQuota + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + scope: + type: string + description: The applied scope that this quota belongs to. + example: ORGANIZATION + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - NETWORK + - KAFKA_CLUSTER + - SERVICE_ACCOUNT + - USER_ACCOUNT + display_name: + type: string + example: Kafka Cluster Per Organization + description: A human-readable name for the quota type name. + x-immutable: true + default_limit: + type: integer + format: int32 + description: | + The default service quota value. + applied_limit: + type: integer + format: int32 + description: > + The latest applied service quota value, taking into account + any limit adjustments. + usage: + type: integer + description: > + Show the quota usage value if the quota usage is available for + this quota. + format: int32 + user: + description: The user associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + organization: + nullable: true + description: >- + A unique organization id to associate a specific organization + to this quota. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + environment: + nullable: true + description: | + The environment ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + nullable: true + description: | + The network ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + nullable: true + description: | + The kafka cluster ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - scope + - display_name + - default_limit + - applied_limit + uniqueItems: true + service-quota.v1.AppliedQuota: + type: object + description: >- + A `quota` object represents a quota configuration for a specific + Confluent Cloud resource. + + Use this API to retrieve an individual quota or list of quotas for a + given scope. + + + + Related guide: [Service Quotas for Confluent + Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). + + + ## The Applied Quotas Model + + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AppliedQuota + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + scope: + type: string + description: The applied scope that this quota belongs to. + example: ORGANIZATION + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - NETWORK + - KAFKA_CLUSTER + - SERVICE_ACCOUNT + - USER_ACCOUNT + display_name: + type: string + example: Kafka Cluster Per Organization + description: A human-readable name for the quota type name. + x-immutable: true + default_limit: + type: integer + format: int32 + description: | + The default service quota value. + applied_limit: + type: integer + format: int32 + description: > + The latest applied service quota value, taking into account any + limit adjustments. + usage: + type: integer + description: > + Show the quota usage value if the quota usage is available for this + quota. + format: int32 + user: + description: The user associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + organization: + nullable: true + description: >- + A unique organization id to associate a specific organization to + this quota. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + environment: + nullable: true + description: | + The environment ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + nullable: true + description: | + The network ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + nullable: true + description: | + The kafka cluster ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + service-quota.v1.ScopeList: + type: object + description: >- + Gets a list of all available scopes for applied quotas. + + + + Related guide: [Quota + Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). + + + ## The Scopes Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ScopeList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + Gets a list of all available scopes for applied quotas. + + + + Related guide: [Quota + Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). + + + ## The Scopes Model + + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Scope + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + description: + type: string + description: the quota scope for listing quotas queries + example: ORGANIZATION scope that quotas would be applied to + required: + - id + - metadata + - description + uniqueItems: true + service-quota.v1.Scope: + type: object + description: >- + Gets a list of all available scopes for applied quotas. + + + + Related guide: [Quota + Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). + + + ## The Scopes Model + + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Scope + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + description: + type: string + description: the quota scope for listing quotas queries + example: ORGANIZATION scope that quotas would be applied to + kafka-quotas.v1.ClientQuotaList: + type: object + description: >- + `ClientQuota` objects represent Client Quotas you can set at the service + account level. + + + The API allows you to list, create, read, update, and delete your client + quotas. + + + + Related guide: [Client Quotas in Confluent + Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + + ## The Client Quotas Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuotaList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `ClientQuota` objects represent Client Quotas you can set at the + service account level. + + + The API allows you to list, create, read, update, and delete your + client quotas. + + + + Related guide: [Client Quotas in Confluent + Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + + ## The Client Quotas Model + + + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuota + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaSpec' + required: + - id + - metadata + - spec + uniqueItems: true + kafka-quotas.v1.ClientQuota: + type: object + description: >- + `ClientQuota` objects represent Client Quotas you can set at the service + account level. + + + The API allows you to list, create, read, update, and delete your client + quotas. + + + + Related guide: [Client Quotas in Confluent + Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + + ## The Client Quotas Model + + + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuota + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaSpec' + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + GlobalObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + EnvScopedObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka-quotas.v1.ClientQuotaSpec: + type: object + description: The desired state of the Client Quota + properties: + display_name: + type: string + description: The name of the client quota. + example: QuotaForSA1 + description: + type: string + example: >- + This quota defines limits on how much the target principals can use + cluster lkc-xxxxx + description: A human readable description for the client quota. + throughput: + type: object + description: Throughput for the client quota. + required: + - ingress_byte_rate + - egress_byte_rate + properties: + ingress_byte_rate: + type: string + format: int64 + example: '5' + description: >- + Ingress throughput limit for principals specified in bytes per + second. + egress_byte_rate: + type: string + format: int64 + example: '5' + description: >- + Egress throughput limit for principals specified in bytes per + second. + cluster: + description: > + The ID of the Dedicated Kafka cluster where the client quota is + applied. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + principals: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: > + A list of principals to apply a client quota to. + + Use `""` to apply a client quota to all service accounts + + (see [Control application usage with Client + Quotas](https://docs.confluent.io/cloud/current/clusters/client-quotas.html#control-application-usage-with-client-quotas) + for more details). + minItems: 1 + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + kafka-quotas.v1.Throughput: + description: Quotas on maximum throughput + required: + - ingress_byte_rate + - egress_byte_rate + properties: + ingress_byte_rate: + type: string + format: int64 + example: '5' + description: >- + Ingress throughput limit for principals specified in bytes per + second. + egress_byte_rate: + type: string + format: int64 + example: '5' + description: >- + Egress throughput limit for principals specified in bytes per + second. + type: object + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + x-stackQL-resources: + applied_quotas: + id: confluent.quotas.applied_quotas + name: applied_quotas + title: Applied Quotas + methods: + list_service_quota_v1_applied_quotas: + operation: + $ref: '#/paths/~1service-quota~1v1~1applied-quotas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_service_quota_v1_applied_quota: + operation: + $ref: '#/paths/~1service-quota~1v1~1applied-quotas~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/applied_quotas/methods/get_service_quota_v1_applied_quota + - $ref: >- + #/components/x-stackQL-resources/applied_quotas/methods/list_service_quota_v1_applied_quotas + insert: [] + update: [] + delete: [] + replace: [] + scopes: + id: confluent.quotas.scopes + name: scopes + title: Scopes + methods: + list_service_quota_v1_scopes: + operation: + $ref: '#/paths/~1service-quota~1v1~1scopes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_service_quota_v1_scope: + operation: + $ref: '#/paths/~1service-quota~1v1~1scopes~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/scopes/methods/get_service_quota_v1_scope + - $ref: >- + #/components/x-stackQL-resources/scopes/methods/list_service_quota_v1_scopes + insert: [] + update: [] + delete: [] + replace: [] + client_quotas: + id: confluent.quotas.client_quotas + name: client_quotas + title: Client Quotas + methods: + list_kafka_quotas_v1_client_quotas: + operation: + $ref: '#/paths/~1kafka-quotas~1v1~1client-quotas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_kafka_quotas_v1_client_quota: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1kafka-quotas~1v1~1client-quotas/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_kafka_quotas_v1_client_quota: + operation: + $ref: '#/paths/~1kafka-quotas~1v1~1client-quotas~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_kafka_quotas_v1_client_quota: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1kafka-quotas~1v1~1client-quotas~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_kafka_quotas_v1_client_quota: + operation: + $ref: '#/paths/~1kafka-quotas~1v1~1client-quotas~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/client_quotas/methods/get_kafka_quotas_v1_client_quota + - $ref: >- + #/components/x-stackQL-resources/client_quotas/methods/list_kafka_quotas_v1_client_quotas + insert: + - $ref: >- + #/components/x-stackQL-resources/client_quotas/methods/create_kafka_quotas_v1_client_quota + update: + - $ref: >- + #/components/x-stackQL-resources/client_quotas/methods/update_kafka_quotas_v1_client_quota + delete: + - $ref: >- + #/components/x-stackQL-resources/client_quotas/methods/delete_kafka_quotas_v1_client_quota + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/schema_registry.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/schema_registry.yaml new file mode 100644 index 0000000..56ea0cb --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/schema_registry.yaml @@ -0,0 +1,4429 @@ +openapi: 3.0.0 +info: + title: schema_registry API + description: confluent schema_registry API + version: 1.0.0 +paths: + /clusterconfig: + get: + tags: + - Config (v1) + summary: Get cluster config + description: Retrieves cluster config information. + operationId: getClusterConfig + responses: + '200': + description: The cluster config + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ClusterConfig' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ClusterConfig' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ClusterConfig' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /compatibility/subjects/{subject}/versions/{version}: + post: + tags: + - Compatibility (v1) + summary: Test schema compatibility against a particular schema subject-version + description: >- + Test input schema against a particular version of a subject's schema for + compatibility. The compatibility level applied for the check is the + configured compatibility level for the subject (http:get:: + /config/(string: subject)). If this subject's compatibility level was + never changed, then the global compatibility level applies (http:get:: + /config). + operationId: testCompatibilityBySubjectName + parameters: + - name: subject + in: path + description: >- + Subject of the schema version against which compatibility is to be + tested + required: true + schema: + type: string + - name: version + in: path + description: >- + Version of the subject's schema against which compatibility is to be + tested. Valid values for versionId are between [1,2^31-1] or the + string "latest"."latest" checks compatibility of the input schema + with the last registered schema under the specified subject + required: true + schema: + type: string + - name: normalize + in: query + description: Whether to normalize the given schema + schema: + type: boolean + - name: verbose + in: query + description: Whether to return detailed error messages + schema: + type: boolean + requestBody: + description: Schema + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + required: true + responses: + '200': + description: Compatibility check result. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: >- + Not Found. Error code 40401 indicates subject not found. Error code + 40402 indicates version not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: >- + Unprocessable entity. Error code 42201 indicates an invalid schema + or schema type. Error code 42202 indicates an invalid version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /compatibility/subjects/{subject}/versions: + post: + tags: + - Compatibility (v1) + summary: Test schema compatibility against all schemas under a subject + description: >- + Test input schema against a subject's schemas for compatibility, based + on the configured compatibility level of the subject. In other words, it + will perform the same compatibility check as register for that subject. + The compatibility level applied for the check is the configured + compatibility level for the subject (http:get:: /config/(string: + subject)). If this subject's compatibility level was never changed, then + the global compatibility level applies (http:get:: /config). + operationId: testCompatibilityForSubject + parameters: + - name: subject + in: path + description: >- + Subject of the schema version against which compatibility is to be + tested + required: true + schema: + type: string + - name: verbose + in: query + description: Whether to return detailed error messages + schema: + type: boolean + requestBody: + description: Schema + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + required: true + responses: + '200': + description: Compatibility check result. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '422': + description: >- + Unprocessable Entity. Error code 42201 indicates an invalid schema + or schema type. Error code 42202 indicates an invalid version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /config/{subject}: + get: + tags: + - Config (v1) + summary: Get subject compatibility level + description: |- + Retrieves compatibility level, compatibility group, normalization, + default metadata, and rule set for a subject. + operationId: getSubjectLevelConfig + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: defaultToGlobal + in: query + description: >- + Whether to return the global compatibility level if subject + compatibility level not found + schema: + type: boolean + responses: + '200': + description: The subject compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Config' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Config' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Config' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Config (v1) + summary: Update subject compatibility level + description: |- + Update compatibility level, compatibility group, normalization, + default metadata, and rule set for the specified subject. On success, + echoes the original request back to the client. + operationId: updateSubjectLevelConfig + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + requestBody: + description: Config Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '422': + description: >- + Unprocessable Entity. Error code 42203 indicates invalid + compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. Error code 50003 indicates a failure forwarding + the request to the primary. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Config (v1) + summary: Delete subject compatibility level + description: >- + Deletes the specified subject-level compatibility level config and + reverts to the global default. + operationId: deleteSubjectConfig + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + responses: + '200': + description: Operation succeeded. Returns old compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + application/json; qs=0.5: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /config: + get: + tags: + - Config (v1) + summary: Get global compatibility level + description: |- + Retrieves the global compatibility level, compatibility group, + normalization, default metadata, and rule set. + operationId: getTopLevelConfig + responses: + '200': + description: The global compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Config' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Config' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Config' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Config (v1) + summary: Update global compatibility level + description: >- + Updates the global compatibility level, compatibility group, + + schema normalization, default metadata, and rule set. On success, echoes + the + + original request back to the client. + operationId: updateTopLevelConfig + requestBody: + description: Config Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '422': + description: >- + Unprocessable Entity. Error code 42203 indicates invalid + compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. Error code 50003 indicates a failure forwarding + the request to the primary. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Config (v1) + summary: Delete global compatibility level + description: >- + Deletes the global compatibility level config and reverts to the + default. + operationId: deleteTopLevelConfig + responses: + '200': + description: Operation succeeded. Returns old global compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + application/json; qs=0.5: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /exporters: + get: + tags: + - Exporters (v1) + summary: Gets all schema exporters + description: Retrieves a list of schema exporters that have been created. + operationId: listExporters + responses: + '200': + description: Name of the exporter + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: string + example: '["exporter1", "exporter2"]' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + post: + tags: + - Exporters (v1) + summary: Creates a new schema exporter + description: >- + Creates a new schema exporter. All attributes in request body are + optional except config. + operationId: registerExporter + requestBody: + description: Schema + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterReference' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ExporterReference' + application/json: + schema: + $ref: '#/components/schemas/ExporterReference' + required: true + responses: + '200': + description: Schema successfully registered. + content: + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ExporterResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '409': + description: >- + Conflict. Error code 40950 – Missing or invalid exporter name \ + Error code 40951 – Missing or invalid exporter config \ Error code + 40952 – Invalid exporter subjects \ Error code 40960 – Exporter + already exists \ Error code 40964 – Too many exporters + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /exporters/{name}: + get: + tags: + - Exporters (v1) + summary: Gets schema exporter by name + description: Retrieves the information of the schema exporter. + operationId: getExporterInfoByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterReference' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40450 – Exporter not found + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Exporters (v1) + summary: Update schema exporter by name + description: >- + Updates the information or configurations of the schema exporter. All + attributes in request body are optional. + operationId: updateExporterInfo + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + requestBody: + description: Exporter Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterUpdateRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ExporterUpdateRequest' + application/json: + schema: + $ref: '#/components/schemas/ExporterUpdateRequest' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '409': + description: >- + Invalid. Error code 40952 – Invalid exporter subjects. Error code + 40963 – Exporter not paused. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Exporters (v1) + summary: Delete schema exporter by name + description: Deletes the schema exporter. + operationId: deleteExporter + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '204': + description: No content. + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + $ref: '#/components/responses/schemaregistry.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /exporters/{name}/status: + get: + tags: + - Exporters (v1) + summary: Gets schema exporter status by name + description: Retrieves the status of the schema exporter. + operationId: getExporterStatusByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterStatusResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40450 – Exporter not found + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /exporters/{name}/config: + get: + tags: + - Exporters (v1) + summary: Gets schema exporter config by name + description: Retrieves the config of the schema exporter. + operationId: getExporterConfigByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterConfigResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40450 – Exporter not found + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Exporters (v1) + summary: Update schema exporter config by name + description: Updates the configuration of the schema exporter. + operationId: updateExporterConfigByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + requestBody: + description: Exporter Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterConfigResponse' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ExporterConfigResponse' + application/json: + schema: + $ref: '#/components/schemas/ExporterConfigResponse' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '409': + description: >- + Invalid. Error code 40952 – Invalid exporter subjects. Error code + 40963 – Exporter not paused. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /exporters/{name}/pause: + put: + tags: + - Exporters (v1) + summary: Pause schema exporter by name + description: Pauses the state of the schema exporter. + operationId: pauseExporterByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '409': + description: >- + Invalid. Error code 40952 – Invalid exporter subjects. Error code + 40963 – Exporter not paused. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /exporters/{name}/reset: + put: + tags: + - Exporters (v1) + summary: Reset schema exporter by name + description: Reset the state of the schema exporter. + operationId: resetExporterByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40450 – Exporter not found + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '409': + description: Invalid. Error code 40963 – Exporter not paused. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /exporters/{name}/resume: + put: + tags: + - Exporters (v1) + summary: Resume schema exporter by name + description: Resume running of the schema exporter. + operationId: resumeExporterByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40450 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '409': + description: Invalid. Error code 40961 – Exporter already running. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /contexts: + get: + tags: + - Contexts (v1) + summary: List contexts + description: Retrieves a list of contexts. + operationId: listContexts + parameters: + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: The contexts. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: string + example: . + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: string + example: . + application/json; qs=0.5: + schema: + type: array + items: + type: string + example: . + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /mode/{subject}: + get: + tags: + - Modes (v1) + summary: Get subject mode + description: Retrieves the subject mode. + operationId: getMode + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: defaultToGlobal + in: query + description: Whether to return the global mode if subject mode not found + schema: + type: boolean + responses: + '200': + description: The subject mode. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Mode' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Mode' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Mode' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Modes (v1) + summary: Update subject mode + description: >- + Update mode for the specified subject. On success, echoes the original + request back to the client. + operationId: updateMode + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: force + in: query + description: >- + Whether to force update if setting mode to IMPORT and schemas + currently exist + schema: + type: boolean + requestBody: + description: Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '422': + description: >- + Unprocessable Entity. Error code 42204 indicates an invalid mode. + Error code 42205 indicates operation not permitted. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. Error code 50003 indicates a failure forwarding + the request to the primary. Error code 50004 indicates unknown + leader. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Modes (v1) + summary: Delete subject mode + description: >- + Deletes the specified subject-level mode and reverts to the global + default. + operationId: deleteSubjectMode + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + responses: + '200': + description: Operation succeeded. Returns old mode. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Mode' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Mode' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Mode' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /mode: + get: + tags: + - Modes (v1) + summary: Get global mode + description: Retrieves global mode. + operationId: getTopLevelMode + responses: + '200': + description: The global mode + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Mode' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Mode' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Mode' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Error code 50001 -- Error in the backend data store + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Modes (v1) + summary: Update global mode + description: >- + Update global mode. On success, echoes the original request back to the + client. + operationId: updateTopLevelMode + parameters: + - name: force + in: query + description: >- + Whether to force update if setting mode to IMPORT and schemas + currently exist + schema: + type: boolean + requestBody: + description: Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '422': + description: >- + Unprocessable Entity. Error code 42204 indicates an invalid mode. + Error code 42205 indicates operation not permitted. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. Error code 50003 indicates a failure forwarding + the request to the primary. Error code 50004 indicates unknown + leader. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /schemas/ids/{id}: + get: + tags: + - Schemas (v1) + summary: Get schema string by ID + description: Retrieves the schema string identified by the input ID. + operationId: getSchema + parameters: + - name: id + in: path + description: Globally unique identifier of the schema + required: true + schema: + type: integer + format: int32 + - name: subject + in: query + description: Name of the subject + schema: + type: string + - name: format + in: query + description: >- + Desired output format, dependent on schema type. For AVRO schemas, + valid values are: " " (default) or "resolved". For PROTOBUF schemas, + valid values are: " " (default), "ignore_extensions", or + "serialized" (The parameter does not apply to JSON schemas.) + schema: + type: string + default: '' + responses: + '200': + description: The schema string. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/SchemaString' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/SchemaString' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/SchemaString' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40403 indicates schema not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /schemas/ids/{id}/schema: + get: + tags: + - Schemas (v1) + summary: Get schema by ID + description: Retrieves the schema identified by the input ID. + operationId: getSchemaOnly + parameters: + - name: id + in: path + description: Globally unique identifier of the schema + required: true + schema: + type: integer + format: int32 + - name: subject + in: query + description: Name of the subject + schema: + type: string + - name: format + in: query + description: >- + Desired output format, dependent on schema type. For AVRO schemas, + valid values are: " " (default) or "resolved". For PROTOBUF schemas, + valid values are: " " (default), "ignore_extensions", or + "serialized" (The parameter does not apply to JSON schemas.) + schema: + type: string + default: '' + responses: + '200': + description: Raw schema string. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + application/json; qs=0.5: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40403 indicates schema not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /schemas/types: + get: + tags: + - Schemas (v1) + summary: List supported schema types + description: Retrieve the schema types supported by this registry. + operationId: getSchemaTypes + responses: + '200': + description: List of supported schema types. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: string + example: AVRO + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: string + example: AVRO + application/json; qs=0.5: + schema: + type: array + items: + type: string + example: AVRO + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /schemas: + get: + tags: + - Schemas (v1) + summary: List schemas + description: Get the schemas matching the specified parameters. + operationId: getSchemas + parameters: + - name: subjectPrefix + in: query + description: Filters results by the respective subject prefix + schema: + type: string + default: '' + - name: aliases + in: query + description: Whether to include aliases in the search + schema: + type: boolean + default: false + - name: deleted + in: query + description: Whether to return soft deleted schemas + schema: + type: boolean + default: false + - name: latestOnly + in: query + description: >- + Whether to return latest schema versions only for each matching + subject + schema: + type: boolean + default: false + - name: ruleType + in: query + description: Filters results by the given rule type + schema: + type: string + default: '' + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of schemas matching the specified parameters. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + $ref: '#/components/schemas/Schema' + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + $ref: '#/components/schemas/Schema' + application/json; qs=0.5: + schema: + type: array + items: + $ref: '#/components/schemas/Schema' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /schemas/ids/{id}/subjects: + get: + tags: + - Schemas (v1) + summary: List subjects associated to schema ID + description: Retrieves all the subjects associated with a particular schema ID. + operationId: getSubjects + parameters: + - name: id + in: path + description: Globally unique identifier of the schema + required: true + schema: + type: integer + format: int32 + - name: subject + in: query + description: Filters results by the respective subject + schema: + type: string + - name: format + in: query + description: >- + Desired output format, dependent on schema type. For AVRO schemas, + valid values are: " " (default) or "resolved". For PROTOBUF schemas, + valid values are: " " (default), "ignore_extensions", or + "serialized" (The parameter does not apply to JSON schemas.) + schema: + type: string + default: '' + - name: deleted + in: query + description: Whether to include subjects where the schema was deleted + schema: + type: boolean + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of subjects matching the specified parameters. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: string + example: User + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: string + example: User + application/json; qs=0.5: + schema: + type: array + items: + type: string + example: User + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40403 indicates schema not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /schemas/ids/{id}/versions: + get: + tags: + - Schemas (v1) + summary: List subject-versions associated to schema ID + description: Get all the subject-version pairs associated with the input ID. + operationId: getVersions + parameters: + - name: id + in: path + description: Globally unique identifier of the schema + required: true + schema: + type: integer + format: int32 + - name: subject + in: query + description: Filters results by the respective subject + schema: + type: string + - name: deleted + in: query + description: Whether to include subject versions where the schema was deleted + schema: + type: boolean + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of subject versions matching the specified parameters. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + $ref: '#/components/schemas/SubjectVersion' + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + $ref: '#/components/schemas/SubjectVersion' + application/json; qs=0.5: + schema: + type: array + items: + $ref: '#/components/schemas/SubjectVersion' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40403 indicates schema not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /subjects/{subject}/versions/{version}: + get: + tags: + - Subjects (v1) + summary: Get schema by version + description: >- + Retrieves a specific version of the schema registered under this + subject. + operationId: getSchemaByVersion + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: version + in: path + description: >- + Version of the schema to be returned. Valid values for versionId are + between [1,2^31-1] or the string "latest". "latest" returns the last + registered schema under the specified subject. Note that there may + be a new latest schema that gets registered right after this request + is served. + required: true + schema: + type: string + - name: format + in: query + description: >- + Desired output format, dependent on schema type. For AVRO schemas, + valid values are: " " (default) or "resolved". For PROTOBUF schemas, + valid values are: " " (default), "ignore_extensions", or + "serialized" (The parameter does not apply to JSON schemas.) + schema: + type: string + default: '' + - name: deleted + in: query + description: Whether to include deleted schema + schema: + type: boolean + responses: + '200': + description: The schema. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Schema' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Schema' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Schema' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: >- + Not Found. Error code 40401 indicates subject not found. Error code + 40402 indicates version not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: Unprocessable Entity. Error code 42202 indicates an invalid version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Subjects (v1) + summary: Delete schema version + description: >- + Deletes a specific version of the schema registered under this subject. + This only deletes the version and the schema ID remains intact making it + still possible to decode data using the schema ID. This API is + recommended to be used only in development environments or under extreme + circumstances where-in, its required to delete a previously registered + schema for compatibility purposes or re-register previously registered + schema. + operationId: deleteSchemaVersion + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: version + in: path + description: >- + Version of the schema to be returned. Valid values for versionId are + between [1,2^31-1] or the string "latest". "latest" returns the last + registered schema under the specified subject. Note that there may + be a new latest schema that gets registered right after this request + is served. + required: true + schema: + type: string + - name: permanent + in: query + description: Whether to perform a permanent delete + schema: + type: boolean + responses: + '200': + description: Operation succeeded. Returns the schema version. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: integer + format: int32 + example: 1 + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: integer + format: int32 + example: 1 + application/json; qs=0.5: + schema: + type: integer + format: int32 + example: 1 + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: >- + Not Found. Error code 40401 indicates subject not found. Error code + 40402 indicates version not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: Unprocessable Entity. Error code 42202 indicates an invalid version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /subjects/{subject}/versions/{version}/referencedby: + get: + tags: + - Subjects (v1) + summary: List schemas referencing a schema + description: Retrieves the IDs of schemas that reference the specified schema. + operationId: getReferencedBy + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: version + in: path + description: >- + Version of the schema to be returned. Valid values for versionId are + between [1,2^31-1] or the string "latest". "latest" returns the last + registered schema under the specified subject. Note that there may + be a new latest schema that gets registered right after this request + is served. + required: true + schema: + type: string + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of IDs for schemas that reference the specified schema. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: integer + format: int32 + example: 100001 + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: integer + format: int32 + example: 100001 + application/json; qs=0.5: + schema: + type: array + items: + type: integer + format: int32 + example: 100001 + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: >- + Not Found. Error code 40401 indicates subject not found. Error code + 40402 indicates version not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: Unprocessable Entity. Error code 42202 indicates an invalid version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /subjects/{subject}/versions/{version}/schema: + get: + tags: + - Subjects (v1) + summary: Get schema string by version + description: >- + Retrieves the schema for the specified version of this subject. Only the + unescaped schema string is returned. + operationId: getSchemaOnly_1 + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: version + in: path + description: >- + Version of the schema to be returned. Valid values for versionId are + between [1,2^31-1] or the string "latest". "latest" returns the last + registered schema under the specified subject. Note that there may + be a new latest schema that gets registered right after this request + is served. + required: true + schema: + type: string + - name: deleted + in: query + description: Whether to include deleted schema + schema: + type: boolean + responses: + '200': + description: The schema string. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + application/json; qs=0.5: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: >- + Not Found. Error code 40401 indicates subject not found. Error code + 40402 indicates version not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: Unprocessable Entity. Error code 42202 indicates an invalid version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /subjects/{subject}/versions: + get: + tags: + - Subjects (v1) + summary: List versions under subject + description: Retrieves a list of versions registered under the specified subject. + operationId: listVersions + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: deleted + in: query + description: Whether to include deleted schemas + schema: + type: boolean + - name: deletedOnly + in: query + description: Whether to return deleted schemas only + schema: + type: boolean + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of version numbers matching the specified parameters. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + application/json; qs=0.5: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: 'Not Found. Error code 40401 indicates subject not found. ' + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + post: + tags: + - Subjects (v1) + summary: Register schema under a subject + description: >- + Register a new schema under the specified subject. If successfully + registered, this returns the unique identifier of this schema in the + registry. The returned identifier should be used to retrieve this schema + from the schemas resource and is different from the schema's version + which is associated with the subject. If the same schema is registered + under a different subject, the same identifier will be returned. + However, the version of the schema may be different under different + subjects. + + A schema should be compatible with the previously registered schema or + schemas (if there are any) as per the configured compatibility level. + The configured compatibility level can be obtained by issuing a GET + http:get:: /config/(string: subject). If that returns null, then GET + http:get:: /config + + When there are multiple instances of Schema Registry running in the same + cluster, the schema registration request will be forwarded to one of the + instances designated as the primary. If the primary is not available, + the client will get an error code indicating that the forwarding has + failed. + operationId: register + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: normalize + in: query + description: Whether to register the normalized schema + schema: + type: boolean + - name: format + in: query + description: >- + Desired output format, dependent on schema type. For AVRO schemas, + valid values are: " " (default) or "resolved". For PROTOBUF schemas, + valid values are: " " (default), "ignore_extensions", or + "serialized" (The parameter does not apply to JSON schemas.) + schema: + type: string + default: '' + requestBody: + description: Schema + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + required: true + responses: + '200': + description: Schema successfully registered. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/RegisterSchemaResponse' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/RegisterSchemaResponse' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/RegisterSchemaResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '409': + description: Conflict. Incompatible schema. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: >- + Unprocessable entity. Error code 42201 indicates an invalid schema + or schema type. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. Error code 50002 indicates operation timed out. + Error code 50003 indicates a failure forwarding the request to the + primary. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /subjects/{subject}: + post: + tags: + - Subjects (v1) + summary: Lookup schema under subject + description: >- + Check if a schema has already been registered under the specified + subject. If so, this returns the schema string along with its globally + unique identifier, its version under this subject and the subject name. + operationId: lookUpSchemaUnderSubject + parameters: + - name: subject + in: path + description: Subject under which the schema will be registered + required: true + schema: + type: string + - name: normalize + in: query + description: Whether to lookup the normalized schema + schema: + type: boolean + - name: format + in: query + description: >- + Desired output format, dependent on schema type. For AVRO schemas, + valid values are: " " (default) or "resolved". For PROTOBUF schemas, + valid values are: " " (default), "ignore_extensions", or + "serialized" (The parameter does not apply to JSON schemas.) + schema: + type: string + default: '' + - name: deleted + in: query + description: Whether to lookup deleted schemas + schema: + type: boolean + requestBody: + description: Schema + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + required: true + responses: + '200': + description: The schema. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Schema' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Schema' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Schema' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: >- + Not Found. Error code 40401 indicates subject not found. Error code + 40403 indicates schema not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Subjects (v1) + summary: Delete subject + description: >- + Deletes the specified subject and its associated compatibility level if + registered. It is recommended to use this API only when a topic needs to + be recycled or in development environment. + operationId: deleteSubject + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: permanent + in: query + description: Whether to perform a permanent delete + schema: + type: boolean + responses: + '200': + description: Operation succeeded. Returns list of schema versions deleted + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + application/json; qs=0.5: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /subjects: + get: + tags: + - Subjects (v1) + summary: List subjects + description: Retrieves a list of registered subjects matching specified parameters. + operationId: list + parameters: + - name: subjectPrefix + in: query + description: Subject name prefix + schema: + type: string + default: ':*:' + - name: deleted + in: query + description: Whether to look up deleted subjects + schema: + type: boolean + - name: deletedOnly + in: query + description: Whether to return deleted subjects only + schema: + type: boolean + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of subjects matching the specified parameters. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: string + example: User + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: string + example: User + application/json; qs=0.5: + schema: + type: array + items: + type: string + example: User + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: >- + Internal Server Error. Error code 50001 indicates a failure in the + backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /subjects/{subject}/metadata: + get: + tags: + - Subjects (v1) + summary: Retrieve the latest version with the given metadata. + description: Retrieve the latest version with the given metadata. + operationId: getLatestWithMetadata + parameters: + - name: subject + in: path + description: Subject under which the schema will be registered + required: true + schema: + type: string + - name: key + in: query + description: >- + The metadata key. Add "?key=key" at the end of the request to match + a metadata key. This query parameter can appear multiple times. Each + instance is matched with a corresponding value query parameter, in + order. + schema: + type: string + - name: value + in: query + description: >- + The metadata value. Add "?value=value" at the end of the request to + match a metadata value. This query parameter can appear multiple + times. Each instance is matched with a corresponding key query + parameter, in order. + schema: + type: string + - name: format + in: query + description: >- + Desired output format, dependent on schema type. For AVRO schemas, + valid values are: " " (default) or "resolved". For PROTOBUF schemas, + valid values are: " " (default), "ignore_extensions", or + "serialized" (The parameter does not apply to JSON schemas.) + schema: + type: string + default: '' + - name: deleted + in: query + description: Whether to lookup deleted schemas + schema: + type: boolean + responses: + '200': + description: The schema. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Schema' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Schema' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Schema' + '404': + description: |- + Error code 40401 -- Subject not found + Error code 40403 -- Schema not found + '500': + description: Internal Server Error. + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. +components: + schemas: + ClusterConfig: + type: object + properties: + maxSchemas: + type: integer + description: Maximum number of registered schemas allowed + format: int32 + example: 20000 + maxRequestsPerSec: + type: integer + description: Maximum number of allowed requests per second + format: int32 + example: 25 + description: Cluster Config + RegisterSchemaRequest: + type: object + properties: + version: + type: integer + description: Version number + format: int32 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + schemaType: + type: string + description: Schema type + references: + type: array + description: References to other schemas + items: + $ref: '#/components/schemas/SchemaReference' + schema: + type: string + description: Schema definition string + metadata: + $ref: '#/components/schemas/Metadata' + ruleSet: + $ref: '#/components/schemas/RuleSet' + schemaTagsToAdd: + type: array + items: + $ref: '#/components/schemas/SchemaTags' + schemaTagsToRemove: + type: array + items: + $ref: '#/components/schemas/SchemaTags' + propagateSchemaTags: + type: boolean + description: Schema register request + CompatibilityCheckResponse: + type: object + properties: + is_compatible: + type: boolean + description: Whether the compared schemas are compatible + messages: + type: array + description: Error messages + example: [] + items: + type: string + description: Error messages + example: '[]' + description: Compatibility check response + ErrorMessage: + type: object + properties: + error_code: + type: integer + description: The error code + format: int32 + message: + type: string + description: The error message + description: Error message of this operation + Config: + type: object + properties: + alias: + type: string + description: |- + If alias is specified, then this subject is an alias for the subject + named by the alias. That means that any reference to this subject + will be replaced by the alias. + normalize: + type: boolean + description: >- + If true, then schemas are automatically normalized when registered + or + + when passed during lookups. This means that clients do not have to + + pass the "normalize" query parameter to have normalization occur. + compatibilityLevel: + type: string + description: Compatibility Level + example: FULL_TRANSITIVE + x-extensible-enum: + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + - NONE + compatibilityGroup: + type: string + description: |- + Only schemas that belong to the same compatibility group will be + checked for compatibility. + defaultMetadata: + type: object + description: >- + Default value for the metadata to be used during schema + registration. + properties: + properties: + type: string + description: >- + The metadata properties and their new values (opaque JSON + object) + overrideMetadata: + type: object + description: >- + Override value for the metadata to be used during schema + registration. + properties: + properties: + type: string + description: >- + The metadata properties and their new values (opaque JSON + object) + defaultRuleSet: + type: object + description: Default value for the ruleSet to be used during schema registration. + properties: + properties: + type: string + description: >- + The metadata properties and their new values (opaque JSON + object) + overrideRuleSet: + type: object + description: >- + Override value for the ruleSet to be used during schema + registration. + properties: + properties: + type: string + description: >- + The metadata properties and their new values (opaque JSON + object) + description: Config + ConfigUpdateRequest: + type: object + properties: + alias: + type: string + description: |- + If alias is specified, then this subject is an alias for the subject + named by the alias. That means that any reference to this subject + will be replaced by the alias. + normalize: + type: boolean + description: |- + If true, then schemas are automatically normalized when registered + or when passed during lookups. This means that clients do not have + to pass the "normalize" query parameter to have normalization occur. + compatibility: + type: string + description: Compatibility Level + example: FULL_TRANSITIVE + x-extensible-enum: + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + - NONE + compatibilityGroup: + type: string + description: |- + Only schemas that belong to the same compatibility group will be + checked for compatibility. + defaultMetadata: + type: object + description: >- + Default value for the metadata to be used during schema + registration. + properties: + properties: + type: string + description: >- + The metadata properties and their new values (opaque JSON + object) + overrideMetadata: + type: object + description: >- + Override value for the metadata to be used during schema + registration. + properties: + properties: + type: string + description: >- + The metadata properties and their new values (opaque JSON + object) + defaultRuleSet: + type: object + description: Default value for the ruleSet to be used during schema registration. + properties: + properties: + type: string + description: >- + The metadata properties and their new values (opaque JSON + object) + overrideRuleSet: + type: object + description: >- + Override value for the ruleSet to be used during schema + registration. + properties: + properties: + type: string + description: >- + The metadata properties and their new values (opaque JSON + object) + description: Config update request + ExporterReference: + type: object + properties: + name: + type: string + description: Name of the exporter + example: test-exporter + contextType: + description: Context type of the exporter. One of CUSTOM, NONE or AUTO (default) + type: string + example: CUSTOM + x-extensible-enum: + - CUSTOM + - AUTO + - NONE + context: + type: string + description: Customized context of the exporter if contextType equals CUSTOM. + example: User + subjects: + type: array + description: Name of each exporter subject + items: + type: string + kekRenameFormat: + type: string + description: >- + Format string for the KEK name in the destination cluster, which may + contain ${kek} as a placeholder for the originating KEK name. For + example, dc_${kek} for the KEK aws_key will map to the destination + KEK name dc_aws_key. + subjectRenameFormat: + type: string + description: >- + Format string for the subject name in the destination cluster, which + may contain ${subject} as a placeholder for the originating subject + name. For example, dc_${subject} for the subject orders will map to + the destination subject name dc_orders. + config: + type: object + description: The map containing exporter's configurations + additionalProperties: + type: string + description: The format for a typical exporter object + ExporterResponse: + type: object + properties: + name: + type: string + description: Name of the exporter + example: test-exporter + description: Exporter register response + ExporterUpdateRequest: + type: object + properties: + contextType: + description: Context type of the exporter. One of CUSTOM, NONE or AUTO (default) + type: string + example: CUSTOM + x-extensible-enum: + - CUSTOM + - AUTO + - NONE + context: + type: string + description: Customized context of the exporter if contextType equals CUSTOM. + example: User + subjects: + type: array + description: Name of each exporter subject + items: + type: string + kekRenameFormat: + type: string + description: |- + Format string for the KEK name in the destination cluster, which may + contain ${kek} as a placeholder for the originating KEK name. For + example, dc_${kek} for the KEK aws_key will map to the destination + KEK name dc_aws_key. + subjectRenameFormat: + type: string + description: |- + Format string for the subject name in the destination cluster, which + may contain ${subject} as a placeholder for the originating subject + name. For example, dc_${subject} for the subject orders will map to + the destination subject name dc_orders. + config: + type: object + description: The map containing exporter's configurations + additionalProperties: + type: string + description: Exporter update request + ExporterStatusResponse: + type: object + properties: + name: + description: Name of exporter. + type: string + example: test-exporter + state: + type: string + description: State of the exporter. Could be STARTING, RUNNING or PAUSED + example: RUNNING + x-extensible-enum: + - STARTING + - RUNNING + - PAUSED + offset: + type: integer + description: Offset of the exporter + format: int64 + example: 100 + ts: + type: integer + description: Timestamp of the exporter + format: int64 + example: 1631206325 + trace: + description: Error trace of the exporter + type: string + example: '' + description: Exporter status get request + ExporterConfigResponse: + type: object + properties: + schema.registry.url: + description: Config SR URL + type: string + example: + basic.auth.credentials.source: + description: Config SR Auth + type: string + example: USER_INFO + basic.auth.user.info: + description: Config SR User Info + type: string + description: The map containing exporter's configurations + Mode: + type: object + properties: + mode: + type: string + description: Schema Registry operating mode + example: READWRITE + x-extensible-enum: + - READWRITE + - READONLY + - READONLY_OVERRIDE + - IMPORT + description: Schema Registry operating mode + ModeUpdateRequest: + type: object + properties: + mode: + type: string + description: Schema Registry operating mode + example: READWRITE + x-extensible-enum: + - READWRITE + - READONLY + - READONLY_OVERRIDE + - IMPORT + description: Mode update request + SchemaString: + type: object + properties: + schemaType: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema string identified by the ID + example: '{"schema": "{"type": "string"}"}' + references: + type: array + description: References to other schemas + items: + $ref: '#/components/schemas/SchemaReference' + metadata: + $ref: '#/components/schemas/Metadata' + ruleSet: + $ref: '#/components/schemas/RuleSet' + schemaTags: + type: array + description: Schema tags + items: + $ref: '#/components/schemas/SchemaTags' + maxId: + type: integer + description: Maximum ID + format: int32 + example: 1 + description: Schema definition + Schema: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schemaType: + type: string + description: Schema type + example: AVRO + references: + type: array + description: References to other schemas + items: + $ref: '#/components/schemas/SchemaReference' + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + metadata: + $ref: '#/components/schemas/Metadata' + ruleSet: + $ref: '#/components/schemas/RuleSet' + schemaTags: + type: array + description: Schema tags + items: + $ref: '#/components/schemas/SchemaTags' + description: Schema + SubjectVersion: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + description: Subject version pair + RegisterSchemaResponse: + type: object + properties: + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + description: Schema register response + SchemaReference: + type: object + properties: + name: + type: string + description: Reference name + example: io.confluent.kafka.example.User + subject: + type: string + description: Name of the referenced subject + example: User + version: + type: integer + description: Version number of the referenced subject + format: int32 + example: 1 + description: Schema reference + Metadata: + description: User-defined metadata + nullable: true + properties: + tags: + additionalProperties: + items: + type: string + type: array + uniqueItems: true + type: object + properties: + additionalProperties: + type: string + type: object + sensitive: + items: + type: string + type: array + uniqueItems: true + type: object + RuleSet: + description: Schema rule set + nullable: true + properties: + migrationRules: + items: + $ref: '#/components/schemas/Rule' + type: array + domainRules: + items: + $ref: '#/components/schemas/Rule' + type: array + type: object + SchemaTags: + type: object + properties: + schemaEntity: + $ref: '#/components/schemas/SchemaEntity' + tags: + type: array + items: + type: string + Rule: + description: Rule + properties: + name: + description: Rule name + type: string + doc: + description: Rule doc + type: string + kind: + description: Rule kind + enum: + - TRANSFORM + - CONDITION + type: string + mode: + description: Rule mode + enum: + - UPGRADE + - DOWNGRADE + - UPDOWN + - WRITE + - READ + - WRITEREAD + type: string + type: + description: Rule type + type: string + tags: + description: The tags to which this rule applies + items: + description: The tags to which this rule applies + type: string + type: array + uniqueItems: true + params: + additionalProperties: + description: Optional params for the rule + type: string + description: Optional params for the rule + type: object + expr: + description: Rule expression + type: string + onSuccess: + description: Rule action on success + type: string + onFailure: + description: Rule action on failure + type: string + disabled: + description: Whether the rule is disabled + type: boolean + type: object + SchemaEntity: + type: object + properties: + entityPath: + type: string + entityType: + type: string + enum: + - sr_record + - sr_field + responses: + schemaregistry.v1.BadRequestError: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 400 + message: Bad Request + schemaregistry.v1.UnauthorizedError: + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 401 + message: Unauthorized + schemaregistry.v1.ForbiddenError: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 403 + message: Forbidden + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + schemaregistry.v1.DefaultSystemError: + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 500 + message: Oops, something went wrong + schemaregistry.v1.AccountNotFoundError: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 404 + message: account not found + x-stackQL-resources: + cluster_config: + id: confluent.schema_registry.cluster_config + name: cluster_config + title: Cluster Config + methods: + get_cluster_config: + operation: + $ref: '#/paths/~1clusterconfig/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/cluster_config/methods/get_cluster_config + insert: [] + update: [] + delete: [] + replace: [] + compatibilities: + id: confluent.schema_registry.compatibilities + name: compatibilities + title: Compatibilities + methods: + test_compatibility_by_subject_name: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1compatibility~1subjects~1{subject}~1versions~1{version}/post + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + test_compatibility_for_subject: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1compatibility~1subjects~1{subject}~1versions/post' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + subject_level_config: + id: confluent.schema_registry.subject_level_config + name: subject_level_config + title: Subject Level Config + methods: + get_subject_level_config: + operation: + $ref: '#/paths/~1config~1{subject}/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + update_subject_level_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1config~1{subject}/put' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + delete_subject_config: + operation: + $ref: '#/paths/~1config~1{subject}/delete' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/subject_level_config/methods/get_subject_level_config + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/subject_level_config/methods/delete_subject_config + replace: + - $ref: >- + #/components/x-stackQL-resources/subject_level_config/methods/update_subject_level_config + top_level_config: + id: confluent.schema_registry.top_level_config + name: top_level_config + title: Top Level Config + methods: + get_top_level_config: + operation: + $ref: '#/paths/~1config/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + update_top_level_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1config/put' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + delete_top_level_config: + operation: + $ref: '#/paths/~1config/delete' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/top_level_config/methods/get_top_level_config + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/top_level_config/methods/delete_top_level_config + replace: + - $ref: >- + #/components/x-stackQL-resources/top_level_config/methods/update_top_level_config + exporters: + id: confluent.schema_registry.exporters + name: exporters + title: Exporters + methods: + list_exporters: + operation: + $ref: '#/paths/~1exporters/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + objectKey: $ + register_exporter: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exporters/post' + response: + mediaType: application/json; qs=0.5 + openAPIDocKey: '200' + get_exporter_info_by_name: + operation: + $ref: '#/paths/~1exporters~1{name}/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + update_exporter_info: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exporters~1{name}/put' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + delete_exporter: + operation: + $ref: '#/paths/~1exporters~1{name}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + pause_exporter_by_name: + operation: + $ref: '#/paths/~1exporters~1{name}~1pause/put' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + reset_exporter_by_name: + operation: + $ref: '#/paths/~1exporters~1{name}~1reset/put' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + resume_exporter_by_name: + operation: + $ref: '#/paths/~1exporters~1{name}~1resume/put' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/exporters/methods/get_exporter_info_by_name + - $ref: '#/components/x-stackQL-resources/exporters/methods/list_exporters' + insert: + - $ref: >- + #/components/x-stackQL-resources/exporters/methods/register_exporter + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/exporters/methods/delete_exporter' + replace: + - $ref: >- + #/components/x-stackQL-resources/exporters/methods/update_exporter_info + exporter_status: + id: confluent.schema_registry.exporter_status + name: exporter_status + title: Exporter Status + methods: + get_exporter_status_by_name: + operation: + $ref: '#/paths/~1exporters~1{name}~1status/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/exporter_status/methods/get_exporter_status_by_name + insert: [] + update: [] + delete: [] + replace: [] + exporter_configs: + id: confluent.schema_registry.exporter_configs + name: exporter_configs + title: Exporter Configs + methods: + get_exporter_config_by_name: + operation: + $ref: '#/paths/~1exporters~1{name}~1config/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + update_exporter_config_by_name: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exporters~1{name}~1config/put' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/exporter_configs/methods/get_exporter_config_by_name + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/exporter_configs/methods/update_exporter_config_by_name + contexts: + id: confluent.schema_registry.contexts + name: contexts + title: Contexts + methods: + list_contexts: + operation: + $ref: '#/paths/~1contexts/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + objectKey: $ + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/contexts/methods/list_contexts' + insert: [] + update: [] + delete: [] + replace: [] + modes: + id: confluent.schema_registry.modes + name: modes + title: Modes + methods: + get_mode: + operation: + $ref: '#/paths/~1mode~1{subject}/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + update_mode: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1mode~1{subject}/put' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + delete_subject_mode: + operation: + $ref: '#/paths/~1mode~1{subject}/delete' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + get_top_level_mode: + operation: + $ref: '#/paths/~1mode/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + update_top_level_mode: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1mode/put' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/modes/methods/get_mode' + - $ref: '#/components/x-stackQL-resources/modes/methods/get_top_level_mode' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/modes/methods/delete_subject_mode' + replace: + - $ref: '#/components/x-stackQL-resources/modes/methods/update_mode' + - $ref: >- + #/components/x-stackQL-resources/modes/methods/update_top_level_mode + schemas: + id: confluent.schema_registry.schemas + name: schemas + title: Schemas + methods: + get_schema: + operation: + $ref: '#/paths/~1schemas~1ids~1{id}/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + get_schema_only: + operation: + $ref: '#/paths/~1schemas~1ids~1{id}~1schema/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + get_schemas: + operation: + $ref: '#/paths/~1schemas/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + objectKey: $ + get_schema_only_1: + operation: + $ref: '#/paths/~1subjects~1{subject}~1versions~1{version}~1schema/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schemas/methods/get_schema' + - $ref: '#/components/x-stackQL-resources/schemas/methods/get_schemas' + insert: [] + update: [] + delete: [] + replace: [] + types: + id: confluent.schema_registry.types + name: types + title: Types + methods: + get_schema_types: + operation: + $ref: '#/paths/~1schemas~1types/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + objectKey: $ + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/types/methods/get_schema_types' + insert: [] + update: [] + delete: [] + replace: [] + subjects: + id: confluent.schema_registry.subjects + name: subjects + title: Subjects + methods: + get_subjects: + operation: + $ref: '#/paths/~1schemas~1ids~1{id}~1subjects/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + objectKey: $ + look_up_schema_under_subject: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1subjects~1{subject}/post' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + delete_subject: + operation: + $ref: '#/paths/~1subjects~1{subject}/delete' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1subjects/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + objectKey: $ + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subjects/methods/get_subjects' + - $ref: '#/components/x-stackQL-resources/subjects/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/subjects/methods/delete_subject' + replace: [] + versions: + id: confluent.schema_registry.versions + name: versions + title: Versions + methods: + get_versions: + operation: + $ref: '#/paths/~1schemas~1ids~1{id}~1versions/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + objectKey: $ + get_schema_by_version: + operation: + $ref: '#/paths/~1subjects~1{subject}~1versions~1{version}/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + delete_schema_version: + operation: + $ref: '#/paths/~1subjects~1{subject}~1versions~1{version}/delete' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + list_versions: + operation: + $ref: '#/paths/~1subjects~1{subject}~1versions/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + objectKey: $ + register: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1subjects~1{subject}~1versions/post' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/versions/methods/get_schema_by_version + - $ref: '#/components/x-stackQL-resources/versions/methods/get_versions' + - $ref: '#/components/x-stackQL-resources/versions/methods/list_versions' + insert: + - $ref: '#/components/x-stackQL-resources/versions/methods/register' + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/versions/methods/delete_schema_version + replace: [] + subjects_referenced_by: + id: confluent.schema_registry.subjects_referenced_by + name: subjects_referenced_by + title: Subjects Referenced By + methods: + get_referenced_by: + operation: + $ref: >- + #/paths/~1subjects~1{subject}~1versions~1{version}~1referencedby/get + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + objectKey: $ + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/subjects_referenced_by/methods/get_referenced_by + insert: [] + update: [] + delete: [] + replace: [] + latest_version: + id: confluent.schema_registry.latest_version + name: latest_version + title: Latest Version + methods: + get_latest_with_metadata: + operation: + $ref: '#/paths/~1subjects~1{subject}~1metadata/get' + response: + mediaType: application/vnd.schemaregistry.v1+json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/latest_version/methods/get_latest_with_metadata + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/schema_registry_clusters.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/schema_registry_clusters.yaml new file mode 100644 index 0000000..2989e81 --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/schema_registry_clusters.yaml @@ -0,0 +1,4282 @@ +openapi: 3.0.0 +info: + title: schema_registry_clusters API + description: confluent schema_registry_clusters API + version: 1.0.0 +paths: + /srcm/v2/regions: + get: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: listSrcmV2Regions + summary: List of Regions + description: >- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all regions. + parameters: + - name: spec.cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for spec.cloud. + - name: spec.region_name + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-2 + description: Filter the results by exact match for spec.region_name. + - name: spec.packages + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - ESSENTIALS + - ADVANCED + description: >- + Filter the results by exact match for spec.packages. Pass multiple + times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Regions (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Region. + content: + application/json: + schema: + type: object + description: >- + `Region` objects represent cloud provider regions available + when placing Schema Registry clusters. + + The API allows you to list Schema Registry regions. + + + + Related guides: + + * [Confluent Cloud providers and region + support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Regions Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RegionList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Region` objects represent cloud provider regions + available when placing Schema Registry clusters. + + The API allows you to list Schema Registry regions. + + + + Related guides: + + * [Confluent Cloud providers and region + support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Regions Model + + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Region + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.RegionSpec' + required: + - id + - metadata + - spec + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Deprecated + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + /srcm/v2/regions/{id}: + get: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: getSrcmV2Region + summary: Read a Region + description: >- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a region. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the region. + tags: + - Regions (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Region. + content: + application/json: + schema: + type: object + description: >- + `Region` objects represent cloud provider regions available + when placing Schema Registry clusters. + + The API allows you to list Schema Registry regions. + + + + Related guides: + + * [Confluent Cloud providers and region + support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Regions Model + + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.RegionSpec' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Deprecated + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + /srcm/v2/clusters: + get: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: listSrcmV2Clusters + summary: List of Clusters + description: >- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Clusters (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on + Confluent Cloud. + + + The API allows you to list, create, read, and delete your + Schema Registry clusters. + + + + Related guides: + + * [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Clusters Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on + Confluent Cloud. + + + The API allows you to list, create, read, and delete + your Schema Registry clusters. + + + + Related guides: + + * [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Clusters Model + + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: createSrcmV2Cluster + summary: Create a Cluster + description: >- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a cluster. + tags: + - Clusters (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on + Confluent Cloud. + + + The API allows you to list, create, read, and delete your Schema + Registry clusters. + + + + Related guides: + + * [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Clusters Model + + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + required: + - spec + responses: + '202': + description: A Cluster is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/srcm/v2/clusters/{id} + description: Cluster resource uri + content: + application/json: + schema: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on + Confluent Cloud. + + + The API allows you to list, create, read, and delete your + Schema Registry clusters. + + + + Related guides: + + * [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Clusters Model + + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Deprecated + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + /srcm/v2/clusters/{id}: + get: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: getSrcmV2Cluster + summary: Read a Cluster + description: >- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on + Confluent Cloud. + + + The API allows you to list, create, read, and delete your + Schema Registry clusters. + + + + Related guides: + + * [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Clusters Model + + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: updateSrcmV2Cluster + summary: Update a Cluster + description: >+ + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a cluster. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on + Confluent Cloud. + + + The API allows you to list, create, read, and delete your Schema + Registry clusters. + + + + Related guides: + + * [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Clusters Model + + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + required: + - spec + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on + Confluent Cloud. + + + The API allows you to list, create, read, and delete your + Schema Registry clusters. + + + + Related guides: + + * [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Clusters Model + + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: deleteSrcmV2Cluster + summary: Delete a Cluster + description: >- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Cluster is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Deprecated + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + /srcm/v3/clusters: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listSrcmV3Clusters + summary: List of Clusters + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Clusters (srcm/v3) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on + Confluent Cloud. + + + The API allows you to list and read your Schema Registry + clusters. + + + + Related guide: [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + + ## The Clusters Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - srcm/v3 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on + Confluent Cloud. + + + The API allows you to list and read your Schema Registry + clusters. + + + + Related guide: [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + + ## The Clusters Model + + + properties: + api_version: + type: string + enum: + - srcm/v3 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v3.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v3.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /srcm/v3/clusters/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getSrcmV3Cluster + summary: Read a Cluster + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (srcm/v3) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on + Confluent Cloud. + + + The API allows you to list and read your Schema Registry + clusters. + + + + Related guide: [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + + ## The Clusters Model + + + properties: + api_version: + type: string + enum: + - srcm/v3 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v3.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v3.ClusterStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + MultipleSearchFilter: + description: Filter a collection by a string search for one or more values + type: array + items: + type: string + srcm.v2.RegionList: + type: object + description: >- + `Region` objects represent cloud provider regions available when placing + Schema Registry clusters. + + The API allows you to list Schema Registry regions. + + + + Related guides: + + * [Confluent Cloud providers and region + support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Regions Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RegionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Region` objects represent cloud provider regions available when + placing Schema Registry clusters. + + The API allows you to list Schema Registry regions. + + + + Related guides: + + * [Confluent Cloud providers and region + support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Regions Model + + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.RegionSpec' + required: + - id + - metadata + - spec + uniqueItems: true + srcm.v2.Region: + type: object + description: >- + `Region` objects represent cloud provider regions available when placing + Schema Registry clusters. + + The API allows you to list Schema Registry regions. + + + + Related guides: + + * [Confluent Cloud providers and region + support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Regions Model + + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.RegionSpec' + srcm.v2.ClusterList: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on Confluent + Cloud. + + + The API allows you to list, create, read, and delete your Schema + Registry clusters. + + + + Related guides: + + * [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Clusters Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on Confluent + Cloud. + + + The API allows you to list, create, read, and delete your Schema + Registry clusters. + + + + Related guides: + + * [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Clusters Model + + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + srcm.v2.Cluster: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on Confluent + Cloud. + + + The API allows you to list, create, read, and delete your Schema + Registry clusters. + + + + Related guides: + + * [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + * [srcm/v3 Migration + Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + + ## The Clusters Model + + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + srcm.v3.ClusterList: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on Confluent + Cloud. + + + The API allows you to list and read your Schema Registry clusters. + + + + Related guide: [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + + ## The Clusters Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - srcm/v3 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on Confluent + Cloud. + + + The API allows you to list and read your Schema Registry clusters. + + + + Related guide: [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + + ## The Clusters Model + + + properties: + api_version: + type: string + enum: + - srcm/v3 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v3.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v3.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + srcm.v3.Cluster: + type: object + description: >- + `Clusters` objects represent Schema Registry Clusters on Confluent + Cloud. + + + The API allows you to list and read your Schema Registry clusters. + + + + Related guide: [Confluent Cloud Schema Registry Cluster + APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + + ## The Clusters Model + + + properties: + api_version: + type: string + enum: + - srcm/v3 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v3.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v3.ClusterStatus' + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + srcm.v2.RegionSpec: + type: object + description: The desired state of the Region + properties: + display_name: + type: string + description: The display name. + example: Ohio (us-east-2) + x-immutable: true + readOnly: true + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + readOnly: true + region_name: + type: string + description: The region name. + example: us-east-2 + x-immutable: true + readOnly: true + packages: + type: array + items: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: >- + List of Stream Governance packages allowing placement in this + region. + example: + - ESSENTIALS + - ADVANCED + x-immutable: true + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + srcm.v2.ClusterSpec: + type: object + description: The desired state of the Cluster + properties: + display_name: + type: string + description: The cluster name. + example: Stream Governance package + x-immutable: true + readOnly: true + package: + type: string + description: > + The billing package. + + + Note: Clusters can be upgraded from ESSENTIALS to ADVANCED, but + cannot be + + downgraded from ADVANCED to ESSENTIALS. + x-extensible-enum: + - ESSENTIALS + - ADVANCED + example: ESSENTIALS + http_endpoint: + type: string + description: The cluster HTTP request URL. + format: uri + example: https://psrc-00000.us-central1.gcp.confluent.cloud + x-immutable: true + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + region: + description: The region to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + srcm.v2.ClusterStatus: + type: object + required: + - phase + description: The status of the Cluster + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PROVISIONED + - FAILED + description: > + The lifecyle phase of the cluster: + + PROVISIONED: cluster is provisioned; + + PROVISIONING: cluster provisioning is in progress; + + FAILED: provisioning failed + + Note: Schema Registry Cluster Management is handled through the + org/v2 Environments API as of srcm/v3. + readOnly: true + example: PROVISIONED + readOnly: true + srcm.v3.ClusterSpec: + type: object + description: The desired state of the Cluster + properties: + display_name: + type: string + description: The cluster name. + example: Stream Governance package + x-immutable: true + readOnly: true + package: + type: string + description: > + The billing package. + + + Note: Clusters can be upgraded from ESSENTIALS to ADVANCED, but + cannot be + + downgraded from ADVANCED to ESSENTIALS. + x-extensible-enum: + - ESSENTIALS + - ADVANCED + example: ESSENTIALS + http_endpoint: + type: string + description: The cluster HTTP request URL. + format: uri + example: https://psrc-00000.us-central1.gcp.confluent.cloud + x-immutable: true + readOnly: true + catalog_http_endpoint: + type: string + description: The cluster's catalog HTTP request URL. + format: uri + example: https://psrc-00000.us-central1.gcp.confluent.cloud + x-immutable: true + readOnly: true + private_http_endpoint: + type: string + description: > + The cluster's private HTTP request URL. + + + DEPRECATED - Please use the + `private_networking_config.regional_endpoints` attribute instead, + + which supersedes the `private_http_endpoint` attribute. + format: uri + example: https://lsrc-abc.us-central-1.aws.private.confluent.cloud + x-immutable: true + readOnly: true + private_networking_config: + type: object + description: Available HTTP request URLs for private connectivity. + properties: + regional_endpoints: + type: object + description: >- + A map of region identifiers to their corresponding private HTTP + request URL. + additionalProperties: + type: string + format: uri + example: + regional_endpoints: + us-central-1: https://lsrc-abc.us-central-1.aws.private.confluent.cloud + us-west-2: https://lsrc-abc.us-west-2.aws.private.confluent.cloud + x-immutable: true + readOnly: true + cloud: + type: string + description: The cloud service provider in which the cluster is running. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: GCP + x-immutable: true + region: + type: string + description: The cloud service provider region where the cluster is running. + example: us-east4 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + srcm.v3.ClusterStatus: + type: object + required: + - phase + description: The status of the Cluster + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PROVISIONED + - FAILED + description: | + The lifecyle phase of the cluster: + + PROVISIONED: cluster is provisioned; + + PROVISIONING: cluster provisioning is in progress; + + FAILED: provisioning failed + readOnly: true + example: PROVISIONED + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + GlobalObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + x-stackQL-resources: + regions: + id: confluent.schema_registry_clusters.regions + name: regions + title: Regions + methods: + list_srcm_v2_regions: + operation: + $ref: '#/paths/~1srcm~1v2~1regions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_srcm_v2_region: + operation: + $ref: '#/paths/~1srcm~1v2~1regions~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/regions/methods/get_srcm_v2_region + - $ref: >- + #/components/x-stackQL-resources/regions/methods/list_srcm_v2_regions + insert: [] + update: [] + delete: [] + replace: [] + v2_clusters: + id: confluent.schema_registry_clusters.v2_clusters + name: v2_clusters + title: V2 Clusters + methods: + list_srcm_v2_clusters: + operation: + $ref: '#/paths/~1srcm~1v2~1clusters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_srcm_v2_cluster: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1srcm~1v2~1clusters/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_srcm_v2_cluster: + operation: + $ref: '#/paths/~1srcm~1v2~1clusters~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_srcm_v2_cluster: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1srcm~1v2~1clusters~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_srcm_v2_cluster: + operation: + $ref: '#/paths/~1srcm~1v2~1clusters~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/v2_clusters/methods/get_srcm_v2_cluster + - $ref: >- + #/components/x-stackQL-resources/v2_clusters/methods/list_srcm_v2_clusters + insert: + - $ref: >- + #/components/x-stackQL-resources/v2_clusters/methods/create_srcm_v2_cluster + update: + - $ref: >- + #/components/x-stackQL-resources/v2_clusters/methods/update_srcm_v2_cluster + delete: + - $ref: >- + #/components/x-stackQL-resources/v2_clusters/methods/delete_srcm_v2_cluster + replace: [] + v3_clusters: + id: confluent.schema_registry_clusters.v3_clusters + name: v3_clusters + title: V3 Clusters + methods: + list_srcm_v3_clusters: + operation: + $ref: '#/paths/~1srcm~1v3~1clusters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_srcm_v3_cluster: + operation: + $ref: '#/paths/~1srcm~1v3~1clusters~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/v3_clusters/methods/get_srcm_v3_cluster + - $ref: >- + #/components/x-stackQL-resources/v3_clusters/methods/list_srcm_v3_clusters + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/share_group.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/share_group.yaml new file mode 100644 index 0000000..cbc4bec --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/share_group.yaml @@ -0,0 +1,973 @@ +openapi: 3.0.0 +info: + title: share_group API + description: confluent share_group API + version: 1.0.0 +paths: + /kafka/v3/clusters/{cluster_id}/share-groups: + get: + summary: List Share Groups + operationId: listKafkaShareGroups + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the list of share groups that belong to the specified + + Kafka cluster. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListShareGroupsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}: + get: + summary: Get Share Group + operationId: getKafkaShareGroup + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the share group specified by the ``group_id``. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetShareGroupResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Delete Share Group + operationId: deleteKafkaShareGroup + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Delete the share group specified by the ``group_id``. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers: + get: + summary: List Share Group Consumers + operationId: listKafkaShareGroupConsumers + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return a list of consumers that belong to the specified share + + group. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListShareGroupConsumersResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}: + get: + summary: Get Share Group Consumer + operationId: getKafkaShareGroupConsumer + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the consumer specified by the ``consumer_id``. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetShareGroupConsumerResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConsumerId' + /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}/assignments: + get: + summary: List Share Group Consumer Assignments + operationId: listKafkaShareGroupConsumerAssignments + description: >- + [![Generally + Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the consumer assignments specified by the ``consumer_id``. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListShareGroupConsumerAssignmentsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConsumerId' +components: + schemas: + ShareGroupDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ShareGroupData' + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + ShareGroupData: + type: object + required: + - kind + - metadata + - cluster_id + - share_group_id + - state + - coordinator + - consumers + - consumer_count + - partition_count + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + share_group_id: + type: string + state: + $ref: '#/components/schemas/ShareGroupState' + coordinator: + $ref: '#/components/schemas/Relationship' + consumers: + $ref: '#/components/schemas/Relationship' + consumer_count: + type: integer + format: int32 + description: Number of consumers in this share group + partition_count: + type: integer + format: int32 + description: >- + Total number of partitions assigned to this share group across all + consumers + assigned_topic_partitions: + type: array + items: + $ref: '#/components/schemas/ShareGroupTopicPartitionData' + description: >- + List of topic-partitions assigned to this share group, including + those from empty groups + ShareGroupConsumerDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ShareGroupConsumerData' + ShareGroupConsumerData: + type: object + required: + - kind + - metadata + - cluster_id + - group_id + - consumer_id + - client_id + - assignments + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + group_id: + type: string + consumer_id: + type: string + client_id: + type: string + assignments: + $ref: '#/components/schemas/Relationship' + ShareGroupConsumerAssignmentDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ShareGroupConsumerAssignmentData' + ResourceCollection: + type: object + required: + - kind + - metadata + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + Resource: + type: object + required: + - kind + - metadata + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + ShareGroupState: + type: string + x-extensible-enum: + - UNKNOWN + - PREPARING_REBALANCE + - COMPLETING_REBALANCE + - STABLE + - DEAD + - EMPTY + Relationship: + type: object + required: + - related + properties: + related: + type: string + ShareGroupTopicPartitionData: + type: object + required: + - kind + - metadata + - topic_name + - partition_id + - partition + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + topic_name: + type: string + description: The name of the topic + partition_id: + type: integer + format: int32 + description: The partition ID + partition: + $ref: '#/components/schemas/Relationship' + description: Link to the topic partition + ShareGroupConsumerAssignmentData: + type: object + required: + - kind + - metadata + - cluster_id + - group_id + - consumer_id + - topic_name + - partition_id + - partition + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + group_id: + type: string + consumer_id: + type: string + topic_name: + type: string + partition_id: + type: integer + partition: + $ref: '#/components/schemas/Relationship' + ResourceCollectionMetadata: + type: object + required: + - self + properties: + self: + type: string + next: + type: string + nullable: true + ResourceMetadata: + type: object + required: + - self + properties: + self: + type: string + resource_name: + type: string + nullable: true + responses: + ListShareGroupsResponse: + description: The list of share groups. + content: + application/json: + schema: + $ref: '#/components/schemas/ShareGroupDataList' + example: + kind: KafkaShareGroupList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups + next: null + data: + - kind: KafkaShareGroup + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1 + cluster_id: cluster-1 + share_group_id: share-group-1 + state: STABLE + coordinator: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + consumers: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers + consumer_count: 2 + partition_count: 3 + assigned_topic_partitions: + - kind: KafkaShareGroupTopicPartition + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/assigned-topic-partitions/topic-1/0 + resource_name: >- + crn:///kafka=cluster-1/share-group=share-group-1/topic-partition=topic-1:0 + topic_name: topic-1 + partition_id: 0 + partition: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0 + - kind: KafkaShareGroup + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-2 + resource_name: crn:///kafka=cluster-1/share-group=share-group-2 + cluster_id: cluster-1 + share_group_id: share-group-2 + state: EMPTY + coordinator: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 + consumers: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-2/consumers + consumer_count: 2 + partition_count: 3 + assigned_topic_partitions: + - kind: KafkaShareGroupTopicPartition + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-2/assigned-topic-partitions/topic-1/0 + resource_name: >- + crn:///kafka=cluster-1/share-group=share-group-2/topic-partition=topic-1:0 + topic_name: topic-1 + partition_id: 0 + partition: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0 + BadRequestErrorResponse: + description: >- + Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + bad_request_cannot_deserialize: + description: >- + Thrown when trying to deserialize an integer from non-integer + data. + value: + error_code: 400 + message: >- + Cannot deserialize value of type `java.lang.Integer` from + String "A": not a valid `java.lang.Integer` value + unsupported_version_exception: + description: >- + Thrown when the version of this API is not supported in the + underlying Kafka cluster. + value: + error_code: 40035 + message: >- + The version of this API is not supported in the underlying + Kafka cluster. + UnauthorizedErrorResponse: + description: >- + Indicates a client authentication error. Kafka authentication failures + will contain error code 40101 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + kafka_authentication_failed: + description: >- + Thrown when using Basic authentication with wrong Kafka + credentials. + value: + error_code: 40101 + message: Authentication failed + ForbiddenErrorResponse: + description: >- + Indicates a client authorization error. Kafka authorization failures + will contain error code 40301 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + kafka_authorization_failed: + description: >- + Thrown when the caller is not authorized to perform the + underlying operation. + value: + error_code: 40301 + message: Request is not authorized + TooManyRequestsErrorResponse: + description: >- + Indicates that a rate limit threshold has been reached, and the client + should retry again later. + content: + text/html: + schema: + type: string + example: + description: A sample response from Jetty's DoSFilter. + value: >- + Error 429 Too Many + Requests

HTTP ERROR 429 Too Many + Requests

+ + +
URI:/v3/clusters/my-cluster
STATUS:429
MESSAGE: Too Many + Requests
SERVLET: default
+ ServerErrorResponse: + description: >- + A server-side problem that might not be addressable from the client + side. Retriable Kafka errors will contain error code 50003 in the + response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + generic_internal_server_error: + description: Thrown for generic HTTP 500 errors. + value: + error_code: 500 + message: Internal Server Error + GetShareGroupResponse: + description: The share group. + content: + application/json: + schema: + $ref: '#/components/schemas/ShareGroupData' + example: + kind: KafkaShareGroup + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1 + cluster_id: cluster-1 + share_group_id: share-group-1 + state: STABLE + coordinator: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + consumers: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers + consumer_count: 2 + partition_count: 3 + assigned_topic_partitions: + - kind: KafkaShareGroupTopicPartition + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/assigned-topic-partitions/topic-1/0 + resource_name: >- + crn:///kafka=cluster-1/share-group=share-group-1/topic-partition=topic-1:0 + topic_name: topic-1 + partition_id: 0 + partition: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0 + - kind: KafkaShareGroupTopicPartition + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/assigned-topic-partitions/topic-1/1 + resource_name: >- + crn:///kafka=cluster-1/share-group=share-group-1/topic-partition=topic-1:1 + topic_name: topic-1 + partition_id: 1 + partition: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + NoContentResponse: + description: Operation succeeded, no content in the response + NotFoundErrorResponse: + description: >- + Indicates attempted access to an unreachable or non-existing resource + like e.g. an unknown topic or partition. GET requests to endpoints not + allowed in the accesslists will also result in this response. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + endpoint_not_found: + description: Thrown for generic HTTP 404 errors. + value: + error_code: 404 + message: HTTP 404 Not Found + cluster_not_found: + description: Thrown when using a non-existing cluster ID. + value: + error_code: 404 + message: Cluster my-cluster cannot be found. + unknown_topic_or_partition: + description: Thrown when using a non-existing topic name or partition ID. + value: + error_code: 40403 + message: This server does not host this topic-partition. + ListShareGroupConsumersResponse: + description: The list of consumers. + content: + application/json: + schema: + $ref: '#/components/schemas/ShareGroupConsumerDataList' + example: + kind: KafkaShareConsumerList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers + next: null + data: + - kind: KafkaShareGroupConsumer + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1 + resource_name: >- + crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-1 + client_id: client-1 + assignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments + - kind: KafkaShareGroupConsumer + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-2 + resource_name: >- + crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-2 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-2 + client_id: client-2 + assignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-2/assignments + - kind: KafkaShareGroupConsumer + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-3 + resource_name: >- + crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-3 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-3 + client_id: client-3 + assignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-3/assignments + GetShareGroupConsumerResponse: + description: The consumer. + content: + application/json: + schema: + $ref: '#/components/schemas/ShareGroupConsumerData' + example: + kind: KafkaShareGroupConsumer + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1 + resource_name: >- + crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-1 + client_id: client-1 + assignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments + ListShareGroupConsumerAssignmentsResponse: + description: The list of share group assignments. + content: + application/json: + schema: + $ref: '#/components/schemas/ShareGroupConsumerAssignmentDataList' + example: + kind: KafkaConsumerAssignmentList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments + next: null + data: + - kind: KafkaShareGroupConsumerAssignment + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments/topic-1/partitions/1 + resource_name: >- + crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1/assignment=topic=1/partition=1 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-1 + topic_name: topic-1 + partition_id: 1 + partition: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + - kind: KafkaShareGroupConsumerAssignment + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments/topic-2/partitions/2 + resource_name: >- + crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1/assignment=topic=2/partition=2 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-1 + topic_name: topic-2 + partition_id: 2 + partition: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions/2 + - kind: KafkaShareGroupConsumerAssignment + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments/topic-3/partitions/3 + resource_name: >- + crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1/assignment=topic=3/partition=3 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-1 + topic_name: topic-3 + partition_id: 3 + partition: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions/3 + parameters: + ClusterId: + name: cluster_id + description: The Kafka cluster ID. + in: path + required: true + schema: + type: string + example: cluster-1 + GroupId: + name: group_id + description: The group ID. + in: path + required: true + schema: + type: string + example: group-1 + ConsumerId: + name: consumer_id + description: The consumer ID. + in: path + required: true + schema: + type: string + example: consumer-1 + x-stackQL-resources: + share_groups: + id: confluent.share_group.share_groups + name: share_groups + title: Share Groups + methods: + list_kafka_share_groups: + operation: + $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1share-groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_kafka_share_group: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1share-groups~1{group_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_kafka_share_group: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1share-groups~1{group_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/share_groups/methods/get_kafka_share_group + - $ref: >- + #/components/x-stackQL-resources/share_groups/methods/list_kafka_share_groups + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/share_groups/methods/delete_kafka_share_group + replace: [] + consumers: + id: confluent.share_group.consumers + name: consumers + title: Consumers + methods: + list_kafka_share_group_consumers: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1share-groups~1{group_id}~1consumers/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_kafka_share_group_consumer: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1share-groups~1{group_id}~1consumers~1{consumer_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/consumers/methods/get_kafka_share_group_consumer + - $ref: >- + #/components/x-stackQL-resources/consumers/methods/list_kafka_share_group_consumers + insert: [] + update: [] + delete: [] + replace: [] + consumer_assignments: + id: confluent.share_group.consumer_assignments + name: consumer_assignments + title: Consumer Assignments + methods: + list_kafka_share_group_consumer_assignments: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1share-groups~1{group_id}~1consumers~1{consumer_id}~1assignments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/consumer_assignments/methods/list_kafka_share_group_consumer_assignments + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/sql.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/sql.yaml new file mode 100644 index 0000000..78dba70 --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/sql.yaml @@ -0,0 +1,9298 @@ +openapi: 3.0.0 +info: + title: sql API + description: confluent sql API + version: 1.0.0 +paths: + /sql/v1/organizations/{organization_id}/environments/{environment_id}/connections: + get: + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1Connections + summary: List of Connections + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered and paginated list of all Connections. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: spec.connection_type + in: query + required: false + schema: + type: string + x-extensible-enum: + - AZUREML + - AZUREOPENAI + - A2A + - ANTHROPIC + - BEDROCK + - CONFLUENT_JDBC + - COSMOSDB + - COUCHBASE + - ELASTIC + - FIREWORKSAI + - GOOGLEAI + - MCP_SERVER + - MONGODB + - OPENAI + - PINECONE + - REST + - S3VECTORS + - SAGEMAKER + - VERTEXAI + description: Filter the results by exact match for spec.connection_type + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Connections (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Connections. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.ConnectionList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Preview + x-self-access: false + x-request-access-name: SQL API v1 + operationId: createSqlv1Connection + summary: Create a Connection + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a Connection. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + tags: + - Connections (sql/v1) + security: + - resource-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Connection` models a reusable endpoint and auth token to + authenticate the caller to + + use that endpoint. + + Only `OrganizationAdmins` and `EnvironmentAdmins` will have the + permissions to create, update and delete `Connections`. + + `FlinkDevelopers` and `ModelResourceOwners` can later reference + a `Connection` resource within their Model + + creation statements. + + The API allows you to list, create, read, and delete your + connections. + + ## The Connections Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Connection + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: my-openai-connection + description: >- + The user provided name of the resource, unique within this + environment. + pattern: >- + [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)* + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ConnectionSpec' + status: + $ref: '#/components/schemas/sql.v1.ConnectionStatus' + required: + - spec + - name + responses: + '201': + description: A Connection has been successfully created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: >- + https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{name} + description: Connection resource uri + content: + application/json: + schema: + type: object + description: >- + `Connection` models a reusable endpoint and auth token to + authenticate the caller to + + use that endpoint. + + Only `OrganizationAdmins` and `EnvironmentAdmins` will have + the permissions to create, update and delete `Connections`. + + `FlinkDevelopers` and `ModelResourceOwners` can later + reference a `Connection` resource within their Model + + creation statements. + + The API allows you to list, create, read, and delete your + connections. + + ## The Connections Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Connection + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: my-openai-connection + description: >- + The user provided name of the resource, unique within this + environment. + pattern: >- + [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)* + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ConnectionSpec' + status: + $ref: '#/components/schemas/sql.v1.ConnectionStatus' + required: + - spec + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + /sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}: + get: + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1Connection + summary: Read a Connection + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a Connection. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: connection_name + in: path + required: true + schema: + type: string + description: >- + The user provided name of the Connection. Unique within a region + within an org and env. + tags: + - Connections (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Connection. + content: + application/json: + schema: + type: object + description: >- + `Connection` models a reusable endpoint and auth token to + authenticate the caller to + + use that endpoint. + + Only `OrganizationAdmins` and `EnvironmentAdmins` will have + the permissions to create, update and delete `Connections`. + + `FlinkDevelopers` and `ModelResourceOwners` can later + reference a `Connection` resource within their Model + + creation statements. + + The API allows you to list, create, read, and delete your + connections. + + ## The Connections Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Connection + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: my-openai-connection + description: >- + The user provided name of the resource, unique within this + environment. + pattern: >- + [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)* + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ConnectionSpec' + status: + $ref: '#/components/schemas/sql.v1.ConnectionStatus' + required: + - api_version + - kind + - metadata + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Preview + x-self-access: false + x-request-access-name: SQL API v1 + operationId: deleteSqlv1Connection + summary: Delete a Connection + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a statement. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: connection_name + in: path + required: true + schema: + type: string + description: The unique identifier for the connection. + tags: + - Connections (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: A Connection has been deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + x-lifecycle-stage: Preview + x-self-access: false + x-request-access-name: SQL API v1 + operationId: updateSqlv1Connection + summary: Update a Connection + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a connection. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: connection_name + in: path + required: true + schema: + type: string + description: The unique identifier for the connection. + tags: + - Connections (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: A Connection has been updated. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Connection` models a reusable endpoint and auth token to + authenticate the caller to + + use that endpoint. + + Only `OrganizationAdmins` and `EnvironmentAdmins` will have the + permissions to create, update and delete `Connections`. + + `FlinkDevelopers` and `ModelResourceOwners` can later reference + a `Connection` resource within their Model + + creation statements. + + The API allows you to list, create, read, and delete your + connections. + + ## The Connections Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Connection + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: my-openai-connection + description: >- + The user provided name of the resource, unique within this + environment. + pattern: >- + [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)* + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ConnectionSpec' + status: + $ref: '#/components/schemas/sql.v1.ConnectionStatus' + required: + - spec + - name + - metadata + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name}/results: + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1StatementResult + summary: Read Statement Result + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Read Statement Result. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: >- + It contains the field offset in the CollectSinkFunction protocol. On + the first request, it should be unset. The offset is assumed to + start at 0. + tags: + - Statement Results (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: Statement Result. + content: + application/json: + schema: + type: object + description: >- + `Statement Result` represents a resource used to model results + of SQL statements. + + The API allows you to read your SQL statement result. + required: + - api_version + - kind + - metadata + - data + - results + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementResult + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements + next: + description: >- + A URL that can be followed to get the next batch of + results. + type: string + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + results: + type: object + description: >- + A results property that contains a data property that + contains an array of results. + properties: + data: + type: array + description: > + A data property that contains an array of results. + Each entry in the array is a separate result. + + + The value of `op` attribute (if present) represents + the kind of change that a row can describe in a + changelog: + + + `0`: represents `INSERT` (`+I`), i.e. insertion + operation; + + + `1`: represents `UPDATE_BEFORE` (`-U`), i.e. update + operation with the previous content of the updated + row. + + This kind should occur together with `UPDATE_AFTER` + for modelling an update that needs to retract + + the previous row first. It is useful in cases of a + non-idempotent update, i.e., an update of a row that + is not + + uniquely identifiable by a key; + + + `2`: represents `UPDATE_AFTER` (`+U`), i.e. update + operation with new content of the updated row; + + This kind CAN occur together with `UPDATE_BEFORE` for + modelling an update that + + needs to retract the previous row first or it + describes an idempotent update, i.e., an + + update of a row that is uniquely identifiable by a + key; + + + `3`: represents `DELETE` (`-D`), i.e. deletion + operation; + + + Defaults to `0`. + items: {} + example: + - op: 0 + row: + - '101' + - Jay + - - null + - abc + - - null + - '456' + - 1990-01-12 12:00.12 + - - - null + - Alice + - - '42' + - Bob + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements: + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1Statements + summary: List of Statements + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all statements. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: spec.compute_pool_id + in: query + required: false + schema: + type: string + example: lfcp-00000 + description: >- + Filter the results by exact match for spec.compute_pool_id. + + When creating statements, if compute_pool_id is not specified, the + statement will use the default compute pool. The default pool is + automatically determined by the system. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + - name: label_selector + in: query + required: false + schema: + type: string + style: form + explode: false + description: A comma-separated label selector to filter the statements. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: Statements. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.StatementList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: createSqlv1Statement + summary: Create a Statement + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a statement. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Statement` represents a core resource used to model SQL + statements for execution. + + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt + to handle session + + management or any higher-level functionality. + + The API allows you to list, create, read, and delete your + statements. + + ## The Statements Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Statement + readOnly: true + metadata: + description: The metadata of the statement. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: >- + A system generated globally unique identifier for this + resource. + resource_version: + type: string + example: a23av + description: >- + A system generated string that uniquely identifies the + version of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + resource_name: + example: '' + readOnly: true + type: object + name: + type: string + example: sql123 + description: >- + The user provided name of the resource, unique within this + environment. + pattern: >- + [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)* + x-immutable: true + maxLength: 100 + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + spec: + $ref: '#/components/schemas/sql.v1.StatementSpec' + status: + $ref: '#/components/schemas/sql.v1.StatementStatus' + result: + $ref: '#/components/schemas/sql.v1.StatementResult' + required: + - spec + - name + responses: + '201': + description: A Statement is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: >- + https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name} + description: Statement resource uri + content: + application/json: + schema: + type: object + description: >- + `Statement` represents a core resource used to model SQL + statements for execution. + + A statement generalizes DDL, DML, DQL, etc., but doesn’t + attempt to handle session + + management or any higher-level functionality. + + The API allows you to list, create, read, and delete your + statements. + + ## The Statements Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Statement + readOnly: true + metadata: + description: The metadata of the statement. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: >- + A system generated globally unique identifier for this + resource. + resource_version: + type: string + example: a23av + description: >- + A system generated string that uniquely identifies the + version of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + resource_name: + example: '' + readOnly: true + type: object + name: + type: string + example: sql123 + description: >- + The user provided name of the resource, unique within this + environment. + pattern: >- + [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)* + x-immutable: true + maxLength: 100 + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + spec: + $ref: '#/components/schemas/sql.v1.StatementSpec' + status: + $ref: '#/components/schemas/sql.v1.StatementStatus' + result: + $ref: '#/components/schemas/sql.v1.StatementResult' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1Statement + summary: Read a Statement + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a statement. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: statement_name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: Statement. + content: + application/json: + schema: + type: object + description: >- + `Statement` represents a core resource used to model SQL + statements for execution. + + A statement generalizes DDL, DML, DQL, etc., but doesn’t + attempt to handle session + + management or any higher-level functionality. + + The API allows you to list, create, read, and delete your + statements. + + ## The Statements Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Statement + readOnly: true + metadata: + description: The metadata of the statement. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: >- + A system generated globally unique identifier for this + resource. + resource_version: + type: string + example: a23av + description: >- + A system generated string that uniquely identifies the + version of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + resource_name: + example: '' + readOnly: true + type: object + name: + type: string + example: sql123 + description: >- + The user provided name of the resource, unique within this + environment. + pattern: >- + [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)* + x-immutable: true + maxLength: 100 + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + spec: + $ref: '#/components/schemas/sql.v1.StatementSpec' + status: + $ref: '#/components/schemas/sql.v1.StatementStatus' + result: + $ref: '#/components/schemas/sql.v1.StatementResult' + required: + - api_version + - kind + - metadata + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: deleteSqlv1Statement + summary: Delete a Statement + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a statement. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: statement_name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '202': + description: A Statement is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: updateSqlv1Statement + summary: Update a Statement + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a statement. + + The request will fail with a 409 Conflict error if the Statement has + changed since it was fetched. + + In this case, do a GET, reapply the modifications, and try the update + again. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: statement_name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '202': + description: A Statement is being updated. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Statement` represents a core resource used to model SQL + statements for execution. + + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt + to handle session + + management or any higher-level functionality. + + The API allows you to list, create, read, and delete your + statements. + + ## The Statements Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Statement + readOnly: true + metadata: + description: The metadata of the statement. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: >- + A system generated globally unique identifier for this + resource. + resource_version: + type: string + example: a23av + description: >- + A system generated string that uniquely identifies the + version of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + resource_name: + example: '' + readOnly: true + type: object + name: + type: string + example: sql123 + description: >- + The user provided name of the resource, unique within this + environment. + pattern: >- + [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)* + x-immutable: true + maxLength: 100 + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + spec: + $ref: '#/components/schemas/sql.v1.StatementSpec' + status: + $ref: '#/components/schemas/sql.v1.StatementStatus' + result: + $ref: '#/components/schemas/sql.v1.StatementResult' + required: + - spec + - name + - metadata + patch: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: patchSqlv1Statement + summary: Patch a Statement + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to patch a statement. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: statement_name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/PatchRequest' + responses: + '200': + description: Patched Statement. + content: + application/json: + schema: + type: object + description: >- + `Statement` represents a core resource used to model SQL + statements for execution. + + A statement generalizes DDL, DML, DQL, etc., but doesn’t + attempt to handle session + + management or any higher-level functionality. + + The API allows you to list, create, read, and delete your + statements. + + ## The Statements Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Statement + readOnly: true + metadata: + description: The metadata of the statement. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: >- + A system generated globally unique identifier for this + resource. + resource_version: + type: string + example: a23av + description: >- + A system generated string that uniquely identifies the + version of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + resource_name: + example: '' + readOnly: true + type: object + name: + type: string + example: sql123 + description: >- + The user provided name of the resource, unique within this + environment. + pattern: >- + [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)* + x-immutable: true + maxLength: 100 + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + spec: + $ref: '#/components/schemas/sql.v1.StatementSpec' + status: + $ref: '#/components/schemas/sql.v1.StatementStatus' + result: + $ref: '#/components/schemas/sql.v1.StatementResult' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}/exceptions: + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1StatementExceptions + summary: List of Statement Exceptions + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a list of the 10 most recent statement exceptions. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: statement_name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + tags: + - Statement Exceptions (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: Statement Exceptions. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.StatementExceptionList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + /sql/v1/organizations/{organization_id}/environments/{environment_id}/materialized-tables: + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1MaterializedTables + summary: List all materialized tables + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted and paginated list of all materialized tables. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: page_size + in: query + required: false + schema: + type: integer + format: int32 + default: 10 + maximum: 100 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Materialized Tables (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: A list of Materialized Tables. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.MaterializedTableList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables: + post: + x-lifecycle-stage: General Availability + operationId: createSqlv1MaterializedTable + summary: Create a materialized table + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Create a new Materialized Table. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + tags: + - Materialized Tables (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + description: Represents a Materialized Table resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - MaterializedTable + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: >- + The user-provided name of the resource, unique within this + environment. + pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$ + maxLength: 100 + example: high-value-orders + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.MaterializedTableSpec' + status: + readOnly: true + type: object + description: The status of the Materialized Table. + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - RUNNING + - COMPLETED + - DELETING + - FAILING + - FAILED + - CREATING + - ALTERING + - DEGRADED + - STOPPING + - STOPPED + description: The lifecycle phase of the materialized table. + example: RUNNING + detail: + type: string + description: Optional. Human-readable description of phase. + example: Materialized table is running. + warnings: + type: array + description: >- + List of warnings encountered during materialized table + execution. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTableWarning' + creation_statement: + type: string + description: >- + Entire Materialized Table statement as submitted by user + e.g CREATE OR ALTER MATERIALIZED TABLE ... + example: >- + CREATE OR ALTER MATERIALIZED TABLE high-value-orders AS + SELECT user_id, product_id, price, quantity FROM orders + WHERE price > 1000; + scaling_status: + $ref: '#/components/schemas/sql.v1.ScalingStatus' + version: + type: integer + format: int32 + minimum: 1 + description: >- + Represents the evolution history of the Materialized + Table. The current value indicates the latest version. + example: 3 + latest_version: + type: integer + format: int32 + minimum: 1 + description: >- + Represents the latest submitted version of the + Materialized Table. When a query evolution is accepted, + `latest_version` is incremented immediately and will be + greater than `version` until the new query is fully + activated. + example: 4 + responses: + '201': + description: Materialized Table is being created + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: >- + https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name} + description: Materialized Table uri + content: + application/json: + schema: + type: object + description: Represents a Materialized Table resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + - status + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - MaterializedTable + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: >- + The user-provided name of the resource, unique within this + environment. + pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$ + maxLength: 100 + example: high-value-orders + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.MaterializedTableSpec' + status: + readOnly: true + type: object + description: The status of the Materialized Table. + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - RUNNING + - COMPLETED + - DELETING + - FAILING + - FAILED + - CREATING + - ALTERING + - DEGRADED + - STOPPING + - STOPPED + description: The lifecycle phase of the materialized table. + example: RUNNING + detail: + type: string + description: Optional. Human-readable description of phase. + example: Materialized table is running. + warnings: + type: array + description: >- + List of warnings encountered during materialized table + execution. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTableWarning' + creation_statement: + type: string + description: >- + Entire Materialized Table statement as submitted by + user e.g CREATE OR ALTER MATERIALIZED TABLE ... + example: >- + CREATE OR ALTER MATERIALIZED TABLE high-value-orders + AS SELECT user_id, product_id, price, quantity FROM + orders WHERE price > 1000; + scaling_status: + $ref: '#/components/schemas/sql.v1.ScalingStatus' + version: + type: integer + format: int32 + minimum: 1 + description: >- + Represents the evolution history of the Materialized + Table. The current value indicates the latest version. + example: 3 + latest_version: + type: integer + format: int32 + minimum: 1 + description: >- + Represents the latest submitted version of the + Materialized Table. When a query evolution is + accepted, `latest_version` is incremented immediately + and will be greater than `version` until the new query + is fully activated. + example: 4 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}: + get: + x-lifecycle-stage: General Availability + operationId: getSqlv1MaterializedTable + summary: Read a materialized table + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a specific Materialized Table by name. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: table_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Materialized Table + tags: + - Materialized Tables (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: The requested Materialized Table. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.MaterializedTable' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + x-lifecycle-stage: General Availability + operationId: updateSqlv1MaterializedTable + summary: Update/Evolve a materialized table + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a Materialized Table's mutable fields. + + Mutable fields include: `query`, `stopped`, `compute_pool_id`, + `principal`, `columns`, `watermark`, `constraints` and `table_options`. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: table_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Materialized Table + tags: + - Materialized Tables (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + description: The Materialized Table resource with updated spec fields. + required: true + content: + application/json: + schema: + type: object + description: Represents a Materialized Table resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - MaterializedTable + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: >- + The user-provided name of the resource, unique within this + environment. + pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$ + maxLength: 100 + example: high-value-orders + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.MaterializedTableSpec' + status: + readOnly: true + type: object + description: The status of the Materialized Table. + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - RUNNING + - COMPLETED + - DELETING + - FAILING + - FAILED + - CREATING + - ALTERING + - DEGRADED + - STOPPING + - STOPPED + description: The lifecycle phase of the materialized table. + example: RUNNING + detail: + type: string + description: Optional. Human-readable description of phase. + example: Materialized table is running. + warnings: + type: array + description: >- + List of warnings encountered during materialized table + execution. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTableWarning' + creation_statement: + type: string + description: >- + Entire Materialized Table statement as submitted by user + e.g CREATE OR ALTER MATERIALIZED TABLE ... + example: >- + CREATE OR ALTER MATERIALIZED TABLE high-value-orders AS + SELECT user_id, product_id, price, quantity FROM orders + WHERE price > 1000; + scaling_status: + $ref: '#/components/schemas/sql.v1.ScalingStatus' + version: + type: integer + format: int32 + minimum: 1 + description: >- + Represents the evolution history of the Materialized + Table. The current value indicates the latest version. + example: 3 + latest_version: + type: integer + format: int32 + minimum: 1 + description: >- + Represents the latest submitted version of the + Materialized Table. When a query evolution is accepted, + `latest_version` is incremented immediately and will be + greater than `version` until the new query is fully + activated. + example: 4 + responses: + '200': + description: Materialized Table update accepted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.MaterializedTable' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + operationId: deleteSqlv1MaterializedTable + summary: Delete a materialized table + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Delete a specific Materialized Table by name. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: table_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Materialized Table + tags: + - Materialized Tables (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '202': + description: A Materialized Table is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions: + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1MaterializedTableVersions + summary: List all the versions of a materialized table + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted and paginated list of all versions for a specific + Materialized Table. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - in: path + name: table_name + required: true + schema: + type: string + description: The unique identifier for the Materialized Table. + - name: page_size + in: query + required: false + schema: + type: integer + format: int32 + default: 10 + maximum: 100 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Materialized Table Versions (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: A list of Materialized Table Versions. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.MaterializedTableVersionList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions/{version}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1MaterializedTableVersion + summary: Read a materialized table version + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a specific version of a Materialized Table. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - in: path + name: table_name + required: true + schema: + type: string + description: The unique identifier for the Materialized Table. + - in: path + name: version + required: true + schema: + type: integer + format: int32 + minimum: 1 + description: The version number of the Materialized Table. + tags: + - Materialized Table Versions (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: The requested Materialized Table Version. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.MaterializedTableVersion' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/agents: + get: + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1Agents + summary: List all agents + description: > + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted and paginated list of all agents. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: page_size + in: query + required: false + schema: + type: integer + format: int32 + default: 10 + maximum: 100 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Agents (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: A list of Agents. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.AgentList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents: + post: + x-lifecycle-stage: Preview + operationId: createSqlv1Agent + summary: Create an Agent + description: > + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create an Agent. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + tags: + - Agents (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: Represents an Agent resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Agent + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: >- + The user-provided name of the agent, unique within this + environment. + pattern: >- + [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)* + maxLength: 100 + example: chat-listener-agent + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.AgentSpec' + status: + readOnly: true + type: object + description: The status of the Agent. + properties: + phase: + type: string + x-extensible-enum: + - READY + - RUNNING + description: | + Describes the status of the agent: + + READY: The Agent is created; + + RUNNING: The Agent is created and running in a query; + example: RUNNING + responses: + '200': + description: Agent. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: >- + https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name} + description: Agent uri + content: + application/json: + schema: + type: object + description: Represents an Agent resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Agent + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: >- + The user-provided name of the agent, unique within this + environment. + pattern: >- + [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)* + maxLength: 100 + example: chat-listener-agent + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.AgentSpec' + status: + readOnly: true + type: object + description: The status of the Agent. + properties: + phase: + type: string + x-extensible-enum: + - READY + - RUNNING + description: | + Describes the status of the agent: + + READY: The Agent is created; + + RUNNING: The Agent is created and running in a query; + example: RUNNING + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name}: + get: + x-lifecycle-stage: Preview + operationId: getSqlv1Agent + summary: Read an Agent + description: > + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a specific Agent by name. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: agent_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Agent + tags: + - Agents (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: The requested Agent. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.Agent' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + x-lifecycle-stage: Preview + operationId: updateSqlv1Agent + summary: Alter an Agent + description: > + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update an Agent's mutable fields. + + Mutable fields include: `description`, `model`, `prompt`, and + `properties`. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: agent_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Agent + tags: + - Agents (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + description: The Agent resource with updated spec fields. + required: true + content: + application/json: + schema: + type: object + description: Represents an Agent resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Agent + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: >- + The user-provided name of the agent, unique within this + environment. + pattern: >- + [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)* + maxLength: 100 + example: chat-listener-agent + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.AgentSpec' + status: + readOnly: true + type: object + description: The status of the Agent. + properties: + phase: + type: string + x-extensible-enum: + - READY + - RUNNING + description: | + Describes the status of the agent: + + READY: The Agent is created; + + RUNNING: The Agent is created and running in a query; + example: RUNNING + responses: + '200': + description: Agent has been updated. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.Agent' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Preview + operationId: deleteSqlv1Agent + summary: Delete an Agent + description: > + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91)](#section/Versioning/API-Lifecycle-Policy) + + + Delete a specific Agent by name. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: agent_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Agent + tags: + - Agents (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: A Agent has been deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools: + post: + x-lifecycle-stage: Preview + x-self-access: false + x-request-access-name: SQL API v1 + operationId: createSqlv1Tool + summary: Create a Tool + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a Tool. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: database_name + required: true + schema: + type: string + description: The name of the database. + tags: + - Tools (sql/v1) + security: + - resource-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `Tool` models a reusable tool resource backed by a connection + that can be referenced + + by agents to perform actions. + + The API allows you to create your tools. + + ## The Tools Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Tool + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: linear-mcp-tool + description: >- + The user provided name of the tool, unique within this + environment. + pattern: '[a-z0-9_]([-a-z0-9_]*[a-z0-9_])?' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ToolSpec' + status: + $ref: '#/components/schemas/sql.v1.ToolStatus' + required: + - name + - spec + responses: + '200': + description: A Tool has been successfully created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: >- + https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools/{name} + description: Tool resource uri + content: + application/json: + schema: + type: object + description: >- + `Tool` models a reusable tool resource backed by a connection + that can be referenced + + by agents to perform actions. + + The API allows you to create your tools. + + ## The Tools Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Tool + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: linear-mcp-tool + description: >- + The user provided name of the tool, unique within this + environment. + pattern: '[a-z0-9_]([-a-z0-9_]*[a-z0-9_])?' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ToolSpec' + status: + $ref: '#/components/schemas/sql.v1.ToolStatus' + required: + - name + - spec + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + get: + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1Tools + summary: List of Tools + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all Tools. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: database_name + required: true + schema: + type: string + description: The name of the database. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Tools (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Tools. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.ToolList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools/{tool_name}: + get: + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1Tool + summary: Read a Tool + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a Tool. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: database_name + in: path + required: true + schema: + type: string + description: The name of the database. + - name: tool_name + in: path + required: true + schema: + type: string + description: The user provided name of the Tool. + tags: + - Tools (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Tool. + content: + application/json: + schema: + type: object + description: >- + `Tool` models a reusable tool resource backed by a connection + that can be referenced + + by agents to perform actions. + + The API allows you to create your tools. + + ## The Tools Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Tool + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: linear-mcp-tool + description: >- + The user provided name of the tool, unique within this + environment. + pattern: '[a-z0-9_]([-a-z0-9_]*[a-z0-9_])?' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ToolSpec' + status: + $ref: '#/components/schemas/sql.v1.ToolStatus' + required: + - api_version + - kind + - metadata + - name + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Preview + x-self-access: false + x-request-access-name: SQL API v1 + operationId: deleteSqlv1Tool + summary: Delete a Tool + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a Tool. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: database_name + in: path + required: true + schema: + type: string + description: The name of the database. + - name: tool_name + in: path + required: true + schema: + type: string + description: The user provided name of the Tool. + tags: + - Tools (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: A Tool has been deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 +components: + schemas: + sql.v1.ConnectionList: + type: object + description: >- + `Connection` models a reusable endpoint and auth token to authenticate + the caller to + + use that endpoint. + + Only `OrgAdmins` and `EnvAdmins` will have the permissions to create, + update and delete `Connections`. + + `FlinkDevelopers` and `ModelResourceOwners` can later reference a + `Connection` resource within their Model + + creation statements. + + The API allows you to list, create, read, and delete your connections. + + ## The Connection Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - ConnectionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + self: + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/connections + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Connection` models a reusable endpoint and auth token to + authenticate the caller to + + use that endpoint. + + Only `OrganizationAdmins` and `EnvironmentAdmins` will have the + permissions to create, update and delete `Connections`. + + `FlinkDevelopers` and `ModelResourceOwners` can later reference a + `Connection` resource within their Model + + creation statements. + + The API allows you to list, create, read, and delete your + connections. + + ## The Connections Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Connection + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: my-openai-connection + description: >- + The user provided name of the resource, unique within this + environment. + pattern: >- + [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)* + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ConnectionSpec' + status: + $ref: '#/components/schemas/sql.v1.ConnectionStatus' + required: + - api_version + - kind + - metadata + - spec + - status + - name + - organization_id + - environment_id + uniqueItems: true + sql.v1.Connection: + type: object + description: >- + `Connection` models a reusable endpoint and auth token to authenticate + the caller to + + use that endpoint. + + Only `OrganizationAdmins` and `EnvironmentAdmins` will have the + permissions to create, update and delete `Connections`. + + `FlinkDevelopers` and `ModelResourceOwners` can later reference a + `Connection` resource within their Model + + creation statements. + + The API allows you to list, create, read, and delete your connections. + + ## The Connections Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Connection + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: my-openai-connection + description: >- + The user provided name of the resource, unique within this + environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ConnectionSpec' + status: + $ref: '#/components/schemas/sql.v1.ConnectionStatus' + sql.v1.StatementResult: + type: object + description: >- + `Statement Result` represents a resource used to model results of SQL + statements. + + The API allows you to read your SQL statement result. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementResult + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements + next: + description: A URL that can be followed to get the next batch of results. + type: string + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + results: + type: object + description: >- + A results property that contains a data property that contains an + array of results. + properties: + data: + type: array + description: > + A data property that contains an array of results. Each entry in + the array is a separate result. + + + The value of `op` attribute (if present) represents the kind of + change that a row can describe in a changelog: + + + `0`: represents `INSERT` (`+I`), i.e. insertion operation; + + + `1`: represents `UPDATE_BEFORE` (`-U`), i.e. update operation + with the previous content of the updated row. + + This kind should occur together with `UPDATE_AFTER` for + modelling an update that needs to retract + + the previous row first. It is useful in cases of a + non-idempotent update, i.e., an update of a row that is not + + uniquely identifiable by a key; + + + `2`: represents `UPDATE_AFTER` (`+U`), i.e. update operation + with new content of the updated row; + + This kind CAN occur together with `UPDATE_BEFORE` for modelling + an update that + + needs to retract the previous row first or it describes an + idempotent update, i.e., an + + update of a row that is uniquely identifiable by a key; + + + `3`: represents `DELETE` (`-D`), i.e. deletion operation; + + + Defaults to `0`. + items: {} + example: + - op: 0 + row: + - '101' + - Jay + - - null + - abc + - - null + - '456' + - 1990-01-12 12:00.12 + - - - null + - Alice + - - '42' + - Bob + sql.v1.StatementList: + type: object + description: >- + `Statement` represents a core resource used to model SQL statements for + execution. + + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to + handle session + + management or any higher-level functionality. + + The API allows you to list, create, read, and delete your statements. + + ## The Statements Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + self: + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Statement` represents a core resource used to model SQL + statements for execution. + + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt + to handle session + + management or any higher-level functionality. + + The API allows you to list, create, read, and delete your + statements. + + ## The Statements Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Statement + readOnly: true + metadata: + description: The metadata of the statement. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: >- + A system generated globally unique identifier for this + resource. + resource_version: + type: string + example: a23av + description: >- + A system generated string that uniquely identifies the + version of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + resource_name: + example: '' + readOnly: true + type: object + name: + type: string + example: sql123 + description: >- + The user provided name of the resource, unique within this + environment. + pattern: >- + [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)* + x-immutable: true + maxLength: 100 + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + spec: + $ref: '#/components/schemas/sql.v1.StatementSpec' + status: + $ref: '#/components/schemas/sql.v1.StatementStatus' + result: + $ref: '#/components/schemas/sql.v1.StatementResult' + required: + - api_version + - kind + - metadata + - spec + - status + - name + - organization_id + - environment_id + uniqueItems: true + sql.v1.Statement: + type: object + description: >- + `Statement` represents a core resource used to model SQL statements for + execution. + + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to + handle session + + management or any higher-level functionality. + + The API allows you to list, create, read, and delete your statements. + + ## The Statements Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Statement + readOnly: true + metadata: + description: The metadata of the statement. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: A system generated globally unique identifier for this resource. + resource_version: + type: string + example: a23av + description: >- + A system generated string that uniquely identifies the version + of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + resource_name: + example: '' + readOnly: true + type: object + name: + type: string + example: sql123 + description: >- + The user provided name of the resource, unique within this + environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + spec: + $ref: '#/components/schemas/sql.v1.StatementSpec' + status: + $ref: '#/components/schemas/sql.v1.StatementStatus' + result: + $ref: '#/components/schemas/sql.v1.StatementResult' + PatchRequest: + type: array + description: >- + PatchRequest represent a json-patch request to be applied to the + Statement. See https://tools.ietf.org/html/rfc6902 + items: + oneOf: + - $ref: '#/components/schemas/JsonPatchRequestAddReplace' + - $ref: '#/components/schemas/JsonPatchRequestRemove' + - $ref: '#/components/schemas/JsonPatchRequestMoveCopy' + sql.v1.StatementExceptionList: + type: object + description: >- + StatementExceptionList is a list of exceptions coming from FAILED or + FAILING Statements created by + + the SQL Statements API. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementExceptionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/sql123/exceptions + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + properties: + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementException + name: + type: string + description: Name of the SQL statement exception. + example: java.lang.RuntimeException + readOnly: true + message: + type: string + description: Error message of the statement exception. + example: 'java.lang.RuntimeException: An error occurred' + readOnly: true + timestamp: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: >- + The date and time at which the exception occurred. It is + represented in RFC3339 format and is in UTC. + readOnly: true + x-enable-objectmeta: true + sql.v1.MaterializedTableList: + type: object + description: A list of Materialized Table resources. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + readOnly: true + kind: + type: string + enum: + - MaterializedTableList + readOnly: true + metadata: + $ref: '#/components/schemas/ListMeta' + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTable' + uniqueItems: true + sql.v1.MaterializedTable: + type: object + description: Represents a Materialized Table resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - MaterializedTable + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: >- + The user-provided name of the resource, unique within this + environment. + pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$ + maxLength: 100 + example: high-value-orders + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.MaterializedTableSpec' + status: + readOnly: true + type: object + description: The status of the Materialized Table. + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - RUNNING + - COMPLETED + - DELETING + - FAILING + - FAILED + - CREATING + - ALTERING + - DEGRADED + - STOPPING + - STOPPED + description: The lifecycle phase of the materialized table. + example: RUNNING + detail: + type: string + description: Optional. Human-readable description of phase. + example: Materialized table is running. + warnings: + type: array + description: >- + List of warnings encountered during materialized table + execution. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTableWarning' + creation_statement: + type: string + description: >- + Entire Materialized Table statement as submitted by user e.g + CREATE OR ALTER MATERIALIZED TABLE ... + example: >- + CREATE OR ALTER MATERIALIZED TABLE high-value-orders AS SELECT + user_id, product_id, price, quantity FROM orders WHERE price > + 1000; + scaling_status: + $ref: '#/components/schemas/sql.v1.ScalingStatus' + version: + type: integer + format: int32 + minimum: 1 + description: >- + Represents the evolution history of the Materialized Table. The + current value indicates the latest version. + example: 3 + latest_version: + type: integer + format: int32 + minimum: 1 + description: >- + Represents the latest submitted version of the Materialized + Table. When a query evolution is accepted, `latest_version` is + incremented immediately and will be greater than `version` until + the new query is fully activated. + example: 4 + sql.v1.MaterializedTableVersionList: + type: object + description: A list of Materialized Table Version resources. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + readOnly: true + kind: + type: string + enum: + - MaterializedTableVersionList + readOnly: true + metadata: + $ref: '#/components/schemas/ListMeta' + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTableVersion' + uniqueItems: true + sql.v1.MaterializedTableVersion: + type: object + description: Represents a specific version of a Materialized Table resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - MaterializedTableVersion + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + name: + type: string + description: | + The resource version name, unique within the Kafka cluster. + Name conforms to DNS Subdomain (RFC 1123). + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + maxLength: 100 + example: mt-123-v4 + readOnly: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.MaterializedTableVersionSpec' + sql.v1.AgentList: + type: object + description: A list of Agent resources. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + readOnly: true + kind: + type: string + enum: + - AgentList + readOnly: true + metadata: + $ref: '#/components/schemas/ListMeta' + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + $ref: '#/components/schemas/sql.v1.Agent' + uniqueItems: true + sql.v1.Agent: + type: object + description: Represents an Agent resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Agent + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: The user-provided name of the agent, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + maxLength: 100 + example: chat-listener-agent + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.AgentSpec' + status: + readOnly: true + type: object + description: The status of the Agent. + properties: + phase: + type: string + x-extensible-enum: + - READY + - RUNNING + description: | + Describes the status of the agent: + + READY: The Agent is created; + + RUNNING: The Agent is created and running in a query; + example: RUNNING + sql.v1.Tool: + type: object + description: >- + `Tool` models a reusable tool resource backed by a connection that can + be referenced + + by agents to perform actions. + + The API allows you to create your tools. + + ## The Tools Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Tool + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: linear-mcp-tool + description: The user provided name of the tool, unique within this environment. + pattern: '[a-z0-9_]([-a-z0-9_]*[a-z0-9_])?' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ToolSpec' + status: + $ref: '#/components/schemas/sql.v1.ToolStatus' + sql.v1.ToolList: + type: object + description: >- + `Tool` models a reusable tool resource backed by a connection that can + be referenced + + by agents to perform actions. + + The API allows you to create your tools. + + ## The Tool Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - ToolList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + self: + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/organizations/org-abc/environments/env-123/databases/my-database/tools + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Tool` models a reusable tool resource backed by a connection that + can be referenced + + by agents to perform actions. + + The API allows you to create your tools. + + ## The Tools Model + + + properties: + api_version: + type: string + enum: + - sql/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Tool + readOnly: true + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: linear-mcp-tool + description: >- + The user provided name of the tool, unique within this + environment. + pattern: '[a-z0-9_]([-a-z0-9_]*[a-z0-9_])?' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ToolSpec' + status: + $ref: '#/components/schemas/sql.v1.ToolStatus' + required: + - api_version + - kind + - metadata + - name + - spec + - status + - organization_id + - environment_id + uniqueItems: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + sql.v1.ConnectionSpec: + type: object + description: Encapsulates the model provider access details + properties: + connection_type: + type: string + example: OPENAI + description: The type of this connection. + x-immutable: true + x-extensible-enum: + - AZUREML + - AZUREOPENAI + - A2A + - ANTHROPIC + - BEDROCK + - CONFLUENT_JDBC + - COSMOSDB + - COUCHBASE + - ELASTIC + - FIREWORKSAI + - GOOGLEAI + - MCP_SERVER + - MONGODB + - OPENAI + - PINECONE + - REST + - S3VECTORS + - SAGEMAKER + - VERTEXAI + endpoint: + type: string + example: https://api.openai.com/v1/chat/completions + description: The endpoint that is used to run model inferencing. + maxLength: 16384 + x-immutable: true + auth_data: + type: object + description: > + The vendor specific authentication token details + + + The contents are stored as opaque bytes given in plaintext by an + EnvAdmin. + + In future, we would support more secure methods for distributing + authentication tokens. + discriminator: + propertyName: kind + mapping: + PlaintextProvider: '#/components/schemas/sql.v1.PlaintextProvider' + x-immutable: false + properties: + kind: + description: | + Plaintext Provider Kind Type + type: string + enum: + - PlaintextProvider + x-immutable: true + data: + description: > + Authentication token in plaintext JSON string. + + For composite tokens, provide them as JSON. + + This is sensitive piece of information stored as opaque bytes in + an encrypted form with single level of encryption. + + + Scoped to an endpoint of a `Connection` resource. + type: string + format: byte + x-enable-listmeta: true + x-enable-objectmeta: true + sql.v1.ConnectionStatus: + type: object + required: + - phase + description: The status of the Connection + properties: + phase: + type: string + x-extensible-enum: + - ACTIVE + - UNREACHABLE + - INVALID_AUTH + description: | + Describes the status of the connection: + + READY: The Connection is usable; + + UNREACHABLE: The Connection endpoint is unreachable; + + INVALID_AUTH: The Connection auth token is invalid; + example: READY + readOnly: true + detail: + type: string + description: Details about why connection transitioned into a given status. + example: 'Lookup failed: ai.openai.com' + readOnly: true + readOnly: true + ResultListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements + next: + description: A URL that can be followed to get the next batch of results. + type: string + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + sql.v1.StatementResultResults: + type: object + description: >- + A results property that contains a data property that contains an array + of results. + properties: + data: + type: array + description: > + A data property that contains an array of results. Each entry in the + array is a separate result. + + + The value of `op` attribute (if present) represents the kind of + change that a row can describe in a changelog: + + + `0`: represents `INSERT` (`+I`), i.e. insertion operation; + + + `1`: represents `UPDATE_BEFORE` (`-U`), i.e. update operation with + the previous content of the updated row. + + This kind should occur together with `UPDATE_AFTER` for modelling an + update that needs to retract + + the previous row first. It is useful in cases of a non-idempotent + update, i.e., an update of a row that is not + + uniquely identifiable by a key; + + + `2`: represents `UPDATE_AFTER` (`+U`), i.e. update operation with + new content of the updated row; + + This kind CAN occur together with `UPDATE_BEFORE` for modelling an + update that + + needs to retract the previous row first or it describes an + idempotent update, i.e., an + + update of a row that is uniquely identifiable by a key; + + + `3`: represents `DELETE` (`-D`), i.e. deletion operation; + + + Defaults to `0`. + items: {} + example: + - op: 0 + row: + - '101' + - Jay + - - null + - abc + - - null + - '456' + - 1990-01-12 12:00.12 + - - - null + - Alice + - - '42' + - Bob + StatementObjectMeta: + description: The metadata of the statement. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: A system generated globally unique identifier for this resource. + resource_version: + type: string + example: a23av + description: >- + A system generated string that uniquely identifies the version of + this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + readOnly: true + type: object + sql.v1.StatementSpec: + type: object + description: The specs of the Statement + properties: + statement: + type: string + example: SELECT * FROM TABLE WHERE VALUE1 = VALUE2; + description: The raw SQL text statement. + x-immutable: true + maxLength: 131072 + properties: + type: object + example: + sql.current-catalog: my_environment + sql.current-database: my_kafka_cluster + description: A map (key-value pairs) of statement properties. + additionalProperties: + type: string + maxProperties: 8192 + compute_pool_id: + type: string + example: fcp-00000 + description: >- + The id associated with the compute pool in context. + + If not specified, the statement will use the default compute pool. + The default pool is automatically determined by the system. + maxLength: 255 + principal: + type: string + example: sa-abc123 + description: The id of a principal this statement runs as. + maxLength: 255 + x-immutable: true + stopped: + type: boolean + description: Indicates whether the statement should be stopped. + example: false + execution_mode: + type: string + example: streaming + description: > + The execution mode of the statement. + + + Note - The attribute is in a [Early Access + lifecycle](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + maxLength: 255 + readOnly: true + x-enable-listmeta: true + x-enable-objectmeta: true + sql.v1.StatementStatus: + type: object + required: + - phase + description: The status of the Statement + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - RUNNING + - COMPLETED + - DELETING + - FAILING + - FAILED + - STOPPING + - STOPPED + - DEGRADED + description: > + The lifecycle phase of the submitted SQL statement: + + + PENDING: SQL statement is pending execution; + + + RUNNING: SQL statement execution is in progress; + + + COMPLETED: SQL statement is completed; + + + DELETING: SQL statement deletion is in progress; + + + FAILING: SQL statement is failing; + + + FAILED: SQL statement execution has failed; + + + STOPPING: SQL statement is being stopped; + + + STOPPED: SQL statement execution has successfully been stopped; + + + DEGRADED: SQL statement is experiencing reduced performance or + partial failure; + example: RUNNING + readOnly: true + scaling_status: + $ref: '#/components/schemas/sql.v1.ScalingStatus' + state_limit_status: + $ref: '#/components/schemas/sql.v1.StateLimitStatus' + detail: + type: string + description: Details about the execution status of this statement. + example: Statement is running successfully + readOnly: true + warnings: + type: array + description: List of warnings encountered during statement execution. + items: + $ref: '#/components/schemas/sql.v1.StatementWarning' + readOnly: true + traits: + $ref: '#/components/schemas/sql.v1.StatementTraits' + network_kind: + type: string + x-extensible-enum: + - PUBLIC + - PRIVATE + description: | + The networking type used by the submitted SQL statement: + + PUBLIC: SQL statement is using public networking; + + PRIVATE: SQL statement is using private networking; + example: PUBLIC + readOnly: true + latest_offsets: + type: object + additionalProperties: + type: string + description: > + The last Kafka offsets that a statement has processed. Represented + by a mapping from Kafka topic to a + + string representation of partitions mapped to offsets. + example: + topic-1: partition:0,offset:100;partition:1,offset:200 + topic-2: partition:0,offset:50 + readOnly: true + latest_offsets_timestamp: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: >- + The date and time at which the Kafka topic offsets were added to the + statement status. It is represented in RFC3339 format and is in UTC. + readOnly: true + end_time: + type: string + format: date-time + example: '2025-03-19T01:02:03-04:05' + description: > + The date and time in UTC (represented as RFC3339 format) at which + the statement reached its final terminal state. + + This field is set when the Phase is COMPLETED, FAILED, or STOPPED. + + + Note - The attribute is in a [Early Access + lifecycle](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + duration: + type: string + format: duration + example: PT2H30M + description: > + The total elapsed time (represented as ISO 8601 format) from when + the statement transitioned from + + PENDING to RUNNING until it reached a final terminal state. This + field is calculated and set when + + the Phase is COMPLETED, FAILED, or STOPPED. + + + Note - The attribute is in a [Early Access + lifecycle](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + affected_resource: + type: object + description: > + A reference to the resource created by this statement, if any. This + field is set when a statement + + (e.g., CREATE MATERIALIZED TABLE) results in a new user-facing + resource. + + + Note - The attribute is in a [Early Access + lifecycle](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + required: + - kind + - environment_id + - resource_name + properties: + kind: + type: string + x-extensible-enum: + - MATERIALIZED_TABLE + description: The kind of resource that was created. + example: MATERIALIZED_TABLE + environment_id: + type: string + description: >- + The unique identifier for the environment containing the + resource. + example: env-abc + database_id: + type: string + description: | + The unique identifier for the database containing the resource. + Only present for resource kinds that are scoped to a database. + example: lkc-123 + resource_name: + type: string + description: The name of the created resource, unique within its scope. + example: my-materialized-table + readOnly: true + JsonPatchRequestAddReplace: + type: object + description: This option is used to add or replace a value for a field + additionalProperties: false + required: + - value + - op + - path + properties: + path: + description: A JSON Pointer path. + type: string + value: + description: The value to add, replace or test. + op: + description: The operation to perform. + type: string + enum: + - ADD + - REPLACE + - TEST + JsonPatchRequestRemove: + type: object + description: This option is used to remove a field + additionalProperties: false + required: + - op + - path + properties: + path: + description: A JSON Pointer path. + type: string + op: + description: The operation to perform. + type: string + enum: + - REMOVE + JsonPatchRequestMoveCopy: + type: object + description: This option is used to move or copy a field + additionalProperties: false + required: + - from + - op + - path + properties: + path: + description: A JSON Pointer path. + type: string + op: + description: The operation to perform. + type: string + enum: + - MOVE + - COPY + from: + description: A JSON Pointer path. + type: string + ExceptionListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + example: >- + https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/sql123/exceptions + sql.v1.StatementException: + type: object + properties: + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementException + name: + type: string + description: Name of the SQL statement exception. + example: java.lang.RuntimeException + readOnly: true + message: + type: string + description: Error message of the statement exception. + example: 'java.lang.RuntimeException: An error occurred' + readOnly: true + timestamp: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: >- + The date and time at which the exception occurred. It is represented + in RFC3339 format and is in UTC. + readOnly: true + x-enable-objectmeta: true + sql.v1.MaterializedTableSpec: + type: object + description: The specifications of the Materialized Table. + properties: + kafka_cluster_id: + type: string + description: >- + The ID of the Kafka cluster hosting the Materialized Table's topic. + + This value must match the `kafka_cluster_id` path parameter. + + It is immutable after creation and is ignored or rejected on update + if changed. + example: lkc-12345 + x-immutable: true + compute_pool_id: + type: string + description: >- + The id associated with the compute pool in context. + + If not specified, the materialized table will use the default + compute pool. The default pool is automatically determined by the + system. + example: lfcp-123 + principal: + type: string + description: The id of a principal this Materialized Table query runs as. + example: sa-abc123 + maxLength: 255 + stopped: + type: boolean + description: Indicates whether the Materialized Table query should be stopped. + example: false + table_options: + type: object + description: >- + Defines configuration properties for the table, equivalent to the + SQL 'WITH' clause + additionalProperties: + type: string + maxProperties: 8192 + session_options: + type: object + description: >- + Session configurations equivalent to the SQL 'SET' statement. Only + applicable on creation; ignored on update. + additionalProperties: + type: string + maxProperties: 8192 + x-immutable: true + columns: + type: array + description: >- + Details of each column in Materialized Table resource. If columns + are not specified, we infer from query. If it's specified it must be + compatible with the types in the query. + items: + $ref: '#/components/schemas/sql.v1.ColumnDetails' + watermark: + $ref: '#/components/schemas/sql.v1.Watermark' + constraints: + type: array + description: Specify table constraints. + items: + $ref: '#/components/schemas/sql.v1.Constraint' + distribution: + description: Only applicable on creation; ignored on update. + x-immutable: true + type: object + properties: + kind: + type: string + x-extensible-enum: + - HASH + description: The kind of distribution. + example: HASH + keys: + type: array + items: + type: string + example: + - user_id + bucket_count: + type: integer + format: int32 + minimum: 1 + default: 6 + description: The number of buckets. + example: 12 + query: + type: string + description: >- + Contains the query section (usually starting with a SELECT) of the + latest Materialized Table. + example: >- + SELECT user_id, product_id, price, quantity FROM orders WHERE price + > 1000; + maxLength: 131072 + sql.v1.MaterializedTableStatus: + type: object + description: The status of the Materialized Table. + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - RUNNING + - COMPLETED + - DELETING + - FAILING + - FAILED + - CREATING + - ALTERING + - DEGRADED + - STOPPING + - STOPPED + description: The lifecycle phase of the materialized table. + example: RUNNING + detail: + type: string + description: Optional. Human-readable description of phase. + example: Materialized table is running. + warnings: + type: array + description: List of warnings encountered during materialized table execution. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTableWarning' + creation_statement: + type: string + description: >- + Entire Materialized Table statement as submitted by user e.g CREATE + OR ALTER MATERIALIZED TABLE ... + example: >- + CREATE OR ALTER MATERIALIZED TABLE high-value-orders AS SELECT + user_id, product_id, price, quantity FROM orders WHERE price > 1000; + scaling_status: + $ref: '#/components/schemas/sql.v1.ScalingStatus' + version: + type: integer + format: int32 + minimum: 1 + description: >- + Represents the evolution history of the Materialized Table. The + current value indicates the latest version. + example: 3 + latest_version: + type: integer + format: int32 + minimum: 1 + description: >- + Represents the latest submitted version of the Materialized Table. + When a query evolution is accepted, `latest_version` is incremented + immediately and will be greater than `version` until the new query + is fully activated. + example: 4 + sql.v1.MaterializedTableVersionSpec: + type: object + description: The specifications of the Materialized Table Version. + required: + - version + - statement + properties: + version: + type: integer + format: int32 + minimum: 1 + description: The version number of the Materialized Table. + example: 4 + readOnly: true + statement: + type: string + description: > + The full SQL statement for the materialized table as generated by + SHOW CREATE MATERIALIZED TABLE at the time of the evolution. + example: >- + CREATE OR ALTER MATERIALIZED TABLE orders AS SELECT user_id, + product_id, price FROM orders; + readOnly: true + maxLength: 131072 + changes: + type: array + description: Changes affecting resources since the previous version. + items: + $ref: '#/components/schemas/sql.v1.ResourceChange' + readOnly: true + sql.v1.AgentSpec: + type: object + description: The specifications of the Agent. + properties: + description: + type: string + example: An agent that listens to chat messages and creates issues + description: The description of the agent. + model: + type: string + example: chat_listener + description: The name of the model the agent uses for inferencing. + prompt: + type: string + example: >- + Create an issue from the content using + bebb0fa3-e084-412d-a000-b02280558318 as the team ID + description: The instruction prompt that guides the agent's behavior. + maxLength: 65536 + tools: + type: array + description: The list of tools available to the agent. + items: + type: string + example: + - linear-mcp-tool + properties: + type: object + description: A set of key-value option pairs that configure the agent's behavior. + additionalProperties: + type: string + example: + max_iterations: '5' + sql.v1.AgentStatus: + type: object + description: The status of the Agent. + properties: + phase: + type: string + x-extensible-enum: + - READY + - RUNNING + description: | + Describes the status of the agent: + + READY: The Agent is created; + + RUNNING: The Agent is created and running in a query; + example: RUNNING + sql.v1.ToolSpec: + type: object + description: >- + The spec of the Tool. A tool must reference either a `connection` (for + MCP or A2A tools) + + or a `function` (for function-based tools), but not both. + properties: + connection: + type: string + example: linear-mcp-connection-streamable + description: >- + The name of the connection this tool uses. Required for MCP and A2A + tools. Mutually exclusive with function. + function: + type: string + example: convert_to_celsius + description: >- + The name of the function this tool wraps. Required for + function-based tools. Mutually exclusive with connection. + comment: + type: string + description: An optional comment describing the tool. + maxLength: 4096 + options: + type: object + description: >- + A set of key-value option pairs that configure the tool's behavior. + + Supported options vary by tool type: + + - MCP tools: type, allowed_tools, request_timeout, max_retries, + headers + + - A2A tools: type, agent_card_path, request_timeout, max_retries + + - Function tools: type, description + additionalProperties: + type: string + example: + type: mcp + allowed_tools: create_issue, list_issues + request_timeout: '30' + x-enable-listmeta: true + x-enable-objectmeta: true + sql.v1.ToolStatus: + type: object + required: + - phase + description: The status of the Tool + properties: + phase: + type: string + x-extensible-enum: + - ACTIVE + - INACTIVE + - ERROR + description: | + Describes the status of the tool: + + ACTIVE: The Tool is usable; + + INACTIVE: The Tool is not currently active; + + ERROR: The Tool encountered an error; + example: ACTIVE + readOnly: true + detail: + type: string + description: Details about why the tool transitioned into a given status. + example: Tool is ready + readOnly: true + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + sql.v1.PlaintextProvider: + type: object + description: > + Describes a sensitive piece of information passed in plaintext. + + + Confluent only accepts authentication tokens of supported model + providers from OrgAdmins and EnvAdmins. + + For now, only 'PlainText' provider is supported. It stores + authentication token details as opaque bytes in an encrypted form. + + This option offers limited security as it only provides a single level + of encryption. + properties: + kind: + description: | + Plaintext Provider Kind Type + type: string + enum: + - PlaintextProvider + x-immutable: true + data: + description: > + Authentication token in plaintext JSON string. + + For composite tokens, provide them as JSON. + + This is sensitive piece of information stored as opaque bytes in an + encrypted form with single level of encryption. + + + Scoped to an endpoint of a `Connection` resource. + type: string + format: byte + sql.v1.ScalingStatus: + description: Scaling status for this statement. + type: object + properties: + scaling_state: + description: > + OK: The statement runs at the right scale. + + + PENDING_SCALE_DOWN: The statement requires less resources, and will + be scaled down in the near future. + + + PENDING_SCALE_UP: The statement requires more resources, and will be + scaled up in the near future. + + + POOL_EXHAUSTED: The statement requires more resources, but not + enough resources are available. + example: OK + readOnly: true + type: string + x-extensible-enum: + - OK + - PENDING_SCALE_DOWN + - PENDING_SCALE_UP + - POOL_EXHAUSTED + last_updated: + description: The last time the scaling status was updated. + example: '1996-03-19T05:07:03.000Z' + format: date-time + readOnly: true + type: string + readOnly: true + sql.v1.StateLimitStatus: + description: State limit status for this statement. + properties: + state_limit_state: + description: > + OK: The statement is within state limits. + + + APPROACHING_SOFT_LIMIT: The statement is approaching soft state + limits. + + + EXCEEDING_SOFT_LIMIT: The statement is exceeding soft state limits. + + + APPROACHING_HARD_LIMIT: The statement is approaching hard state + limits. + + + EXCEEDING_HARD_LIMIT: The statement is exceeding hard state limits. + example: OK + readOnly: true + type: string + x-extensible-enum: + - OK + - APPROACHING_SOFT_LIMIT + - EXCEEDING_SOFT_LIMIT + - APPROACHING_HARD_LIMIT + - EXCEEDING_HARD_LIMIT + last_updated: + description: The last time the state limit status was updated. + example: '1996-03-19T05:07:03.000Z' + format: date-time + readOnly: true + type: string + detail: + description: Details about why state limit status is in its current state. + example: The statement is within state limits. + type: string + readOnly: true + readOnly: true + type: object + sql.v1.StatementWarning: + type: object + description: Represents a non-fatal issue encountered during statement processing. + required: + - severity + - created_at + - reason + - message + properties: + severity: + $ref: '#/components/schemas/sql.v1.WarningSeverity' + created_at: + type: string + format: date-time + description: >- + The timestamp when the warning was created. It is represented in + RFC3339 format and is in UTC. + example: '2025-11-10T16:20:00Z' + readOnly: true + reason: + type: string + description: >- + A machine-readable short, upper case summary delimited by + underscore. + example: MISSING_WINDOW_START_END + message: + type: string + description: A human-readable string containing the description of the warning. + example: >- + The statement is missing window start and end bounds which may lead + to unbounded state growth. + sql.v1.StatementTraits: + type: object + description: >- + StatementTraits contains detailed information about the properties of a + Statement + properties: + sql_kind: + type: string + description: >- + Categorizes the SQL statement. The result is Confluent-specific but + inspired by SQL. It uses underscores for separating concepts e.g. + "CREATE_TABLE". + example: SELECT + is_bounded: + type: boolean + description: Indicates the special case where results of a statement are bounded. + is_append_only: + type: boolean + description: >- + Indicates the special case where results of a statement are + insert/append only. + upsert_columns: + type: array + description: Defines the column indices clients can use as upsert keys. + items: + type: integer + schema: + $ref: '#/components/schemas/sql.v1.ResultSchema' + connection_refs: + type: array + description: >- + The names of connections that the SQL statement references (e.g., in + FROM clauses). + items: + type: string + example: + - my-postgres-connection + - my-kafka-connection + readOnly: true + sql.v1.ColumnDetails: + type: object + description: Details of a column in the Materialized Table. + discriminator: + propertyName: kind + mapping: + Physical: '#/components/schemas/sql.v1.PhysicalColumn' + Metadata: '#/components/schemas/sql.v1.MetadataColumn' + Computed: '#/components/schemas/sql.v1.ComputedColumn' + required: + - name + - type + - kind + - metadata_key + - expression + properties: + name: + type: string + description: The name of the column. + type: + $ref: '#/components/schemas/DataType' + comment: + type: string + description: A comment or description for the column. + kind: + type: string + description: The kind of column. + enum: + - Physical + example: Physical + metadata_key: + type: string + description: The system metadata key to reference. + example: offset + virtual: + type: boolean + description: Indicates if the metadata column is virtual. + default: false + example: true + expression: + type: string + description: The SQL expression used to compute the column value. + example: quantity * price + sql.v1.Watermark: + type: object + description: Watermark strategy for the Materialized Table resource. + properties: + column: + type: string + example: event_timestamp + expression: + type: string + example: event_timestamp - INTERVAL '5' SECOND + sql.v1.Constraint: + type: object + description: A constraint on the materialized table. + properties: + name: + type: string + example: pk_orders + type: + type: string + x-extensible-enum: + - PRIMARY_KEY + description: The type of constraint. + example: PRIMARY_KEY + columns: + type: array + items: + type: string + example: + - user_id + - product_id + enforced: + type: boolean + description: Whether the constraint is enforced. + default: false + sql.v1.Distribution: + type: object + description: Distribution (bucket by) strategy. + properties: + kind: + type: string + x-extensible-enum: + - HASH + description: The kind of distribution. + example: HASH + keys: + type: array + items: + type: string + example: + - user_id + bucket_count: + type: integer + format: int32 + minimum: 1 + default: 6 + description: The number of buckets. + example: 12 + sql.v1.MaterializedTableWarning: + type: object + description: >- + Represents a non-fatal issue encountered during materialized table + processing. + required: + - severity + - created_at + - reason + - message + properties: + severity: + $ref: '#/components/schemas/sql.v1.WarningSeverity' + created_at: + type: string + format: date-time + description: >- + The timestamp when the warning was created. It is represented in + RFC3339 format and is in UTC. + example: '2025-11-10T16:20:00Z' + readOnly: true + reason: + type: string + description: >- + A machine-readable short, upper case summary delimited by + underscore. + example: MISSING_WINDOW_START_END + message: + type: string + description: A human-readable string containing the description of the warning. + example: >- + The statement is missing window start and end bounds which may lead + to unbounded state growth. + sql.v1.ResourceChange: + type: object + description: Details of a change to a specific resource. + required: + - kind + - environment_locator + - database_locator + - name + - details + properties: + kind: + type: string + x-extensible-enum: + - MATERIALIZED_TABLE + - TABLE + - VIEW + - FUNCTION + description: The type of resource that was changed. + example: MATERIALIZED_TABLE + environment_locator: + type: string + description: >- + The environment containing the resource. Can be either the + environment name or ID, depending on how it is referenced in the SQL + statement text. + example: env-abc + database_locator: + type: string + description: >- + The database containing the resource. Can be either the database + name or ID, depending on how it is referenced in the SQL statement + text. + example: lkc-123 + name: + type: string + description: >- + The name of the resource, unique within its scope (environment and + database). + example: orders + details: + type: array + description: Human-readable descriptions of the changes made to this resource. + items: + type: string + example: + - 'Column ''product_name: VARCHAR'' added' + - 'Column ''product_id: BIGINT'' added' + readOnly: true + sql.v1.WarningSeverity: + type: string + x-extensible-enum: + - LOW + - MODERATE + - CRITICAL + description: > + Indicates the severity of the warning. + + + LOW: Indicates a low severity warning and for informing the user. + + + MODERATE: Indicates a moderate severity warning and may require user + action. Could cause degraded statements if certain conditions apply. + + + CRITICAL: Indicates a critical severity warning and requires user + action. It will cause degraded statements eventually. + example: MODERATE + sql.v1.ResultSchema: + type: object + description: The table columns of the results schema. + properties: + columns: + type: array + description: The properties of each SQL column in the schema. + items: + $ref: '#/components/schemas/ColumnDetails' + sql.v1.PhysicalColumn: + description: >- + Physical columns define the structure of the table and the data types of + its fields. + type: object + required: + - name + - type + - kind + properties: + name: + type: string + description: The name of the column. + type: + $ref: '#/components/schemas/DataType' + comment: + type: string + description: A comment or description for the column. + kind: + type: string + description: The kind of column. + enum: + - Physical + example: Physical + sql.v1.MetadataColumn: + description: Metadata columns reference system properties. + type: object + required: + - name + - type + - kind + - metadata_key + properties: + name: + type: string + description: The name of the column. + type: + $ref: '#/components/schemas/DataType' + comment: + type: string + description: A comment or description for the column. + kind: + type: string + description: The kind of column. + enum: + - Metadata + example: Metadata + metadata_key: + type: string + description: The system metadata key to reference. + example: offset + virtual: + type: boolean + description: Indicates if the metadata column is virtual. + default: false + example: true + sql.v1.ComputedColumn: + description: Computed columns are generated via an expression. + type: object + required: + - name + - type + - kind + - expression + properties: + name: + type: string + description: The name of the column. + type: + $ref: '#/components/schemas/DataType' + comment: + type: string + description: A comment or description for the column. + kind: + type: string + description: The kind of column. + enum: + - Computed + example: Computed + expression: + type: string + description: The SQL expression used to compute the column value. + example: quantity * price + virtual: + type: boolean + description: Indicates if the computed column is virtual. + default: false + example: true + ColumnDetails: + type: object + description: A column in the results schema. + required: + - name + - type + properties: + name: + type: string + description: The name of the SQL table column. + example: Column_Name + type: + description: >- + JSON object in TableSchema format; describes the data returned by + the results serving API. + example: + type: CHAR + nullable: true + length: 8 + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + sql.v1.ColumnCommon: + type: object + required: + - name + - type + properties: + name: + type: string + description: The name of the column. + type: + $ref: '#/components/schemas/DataType' + comment: + type: string + description: A comment or description for the column. + DataType: + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + element_type: + description: The type of the element in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: >- + The type of the element in the data type (if + applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: >- + The fields of the element in the data type (if + applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: >- + The fractional precision of the data type (if + applicable). + class_name: + type: string + description: >- + The class name of the structured data type (if + applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + RowFieldType: + type: object + properties: + name: + type: string + description: The name of the field. + field_type: + description: The data type of the field. + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: >- + The type of the element in the data type (if + applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: >- + The fields of the element in the data type (if + applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: >- + The fractional precision of the data type (if + applicable). + class_name: + type: string + description: >- + The class name of the structured data type (if + applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + element_type: + description: The type of the element in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: >- + The type of the element in the data type (if + applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: >- + The fields of the element in the data type (if + applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: >- + The fractional precision of the data type (if + applicable). + class_name: + type: string + description: >- + The class name of the structured data type (if + applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: >- + The type of the key in the data type (if + applicable). + value_type: + description: >- + The type of the value in the data type (if + applicable). + element_type: + description: >- + The type of the element in the data type (if + applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: >- + The fields of the element in the data type (if + applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: >- + The fractional precision of the data type (if + applicable). + class_name: + type: string + description: >- + The class name of the structured data type (if + applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: >- + The type of the element in the data type (if + applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: >- + The fields of the element in the data type (if + applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: >- + The fractional precision of the data type (if + applicable). + class_name: + type: string + description: >- + The class name of the structured data type (if + applicable). + required: + - type + - nullable + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + description: + type: string + description: The description of the field. + required: + - name + - field_type + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + x-stackQL-resources: + connections: + id: confluent.sql.connections + name: connections + title: Connections + methods: + list_sqlv1_connections: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1connections/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_sqlv1_connection: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1connections/post + response: + mediaType: application/json + openAPIDocKey: '201' + get_sqlv1_connection: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1connections~1{connection_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_sqlv1_connection: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1connections~1{connection_name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + update_sqlv1_connection: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1connections~1{connection_name}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/get_sqlv1_connection + - $ref: >- + #/components/x-stackQL-resources/connections/methods/list_sqlv1_connections + insert: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/create_sqlv1_connection + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/delete_sqlv1_connection + replace: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/update_sqlv1_connection + statement_results: + id: confluent.sql.statement_results + name: statement_results + title: Statement Results + methods: + get_sqlv1_statement_result: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1statements~1{name}~1results/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/statement_results/methods/get_sqlv1_statement_result + insert: [] + update: [] + delete: [] + replace: [] + statements: + id: confluent.sql.statements + name: statements + title: Statements + methods: + list_sqlv1_statements: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1statements/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_sqlv1_statement: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1statements/post + response: + mediaType: application/json + openAPIDocKey: '201' + get_sqlv1_statement: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1statements~1{statement_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_sqlv1_statement: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1statements~1{statement_name}/delete + response: + mediaType: application/json + openAPIDocKey: '202' + update_sqlv1_statement: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1statements~1{statement_name}/put + response: + mediaType: application/json + openAPIDocKey: '202' + patch_sqlv1_statement: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1statements~1{statement_name}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/statements/methods/get_sqlv1_statement + - $ref: >- + #/components/x-stackQL-resources/statements/methods/list_sqlv1_statements + insert: + - $ref: >- + #/components/x-stackQL-resources/statements/methods/create_sqlv1_statement + update: + - $ref: >- + #/components/x-stackQL-resources/statements/methods/patch_sqlv1_statement + delete: + - $ref: >- + #/components/x-stackQL-resources/statements/methods/delete_sqlv1_statement + replace: + - $ref: >- + #/components/x-stackQL-resources/statements/methods/update_sqlv1_statement + statement_exceptions: + id: confluent.sql.statement_exceptions + name: statement_exceptions + title: Statement Exceptions + methods: + get_sqlv1_statement_exceptions: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1statements~1{statement_name}~1exceptions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/statement_exceptions/methods/get_sqlv1_statement_exceptions + insert: [] + update: [] + delete: [] + replace: [] + materialized_tables: + id: confluent.sql.materialized_tables + name: materialized_tables + title: Materialized Tables + methods: + list_sqlv1_materialized_tables: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1materialized-tables/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_sqlv1_materialized_table: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1databases~1{kafka_cluster_id}~1materialized-tables/post + response: + mediaType: application/json + openAPIDocKey: '201' + get_sqlv1_materialized_table: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1databases~1{kafka_cluster_id}~1materialized-tables~1{table_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_sqlv1_materialized_table: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1databases~1{kafka_cluster_id}~1materialized-tables~1{table_name}/put + response: + mediaType: application/json + openAPIDocKey: '200' + delete_sqlv1_materialized_table: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1databases~1{kafka_cluster_id}~1materialized-tables~1{table_name}/delete + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/materialized_tables/methods/get_sqlv1_materialized_table + - $ref: >- + #/components/x-stackQL-resources/materialized_tables/methods/list_sqlv1_materialized_tables + insert: + - $ref: >- + #/components/x-stackQL-resources/materialized_tables/methods/create_sqlv1_materialized_table + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/materialized_tables/methods/delete_sqlv1_materialized_table + replace: + - $ref: >- + #/components/x-stackQL-resources/materialized_tables/methods/update_sqlv1_materialized_table + materialized_table_versions: + id: confluent.sql.materialized_table_versions + name: materialized_table_versions + title: Materialized Table Versions + methods: + list_sqlv1_materialized_table_versions: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1databases~1{kafka_cluster_id}~1materialized-tables~1{table_name}~1versions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_sqlv1_materialized_table_version: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1databases~1{kafka_cluster_id}~1materialized-tables~1{table_name}~1versions~1{version}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/materialized_table_versions/methods/get_sqlv1_materialized_table_version + - $ref: >- + #/components/x-stackQL-resources/materialized_table_versions/methods/list_sqlv1_materialized_table_versions + insert: [] + update: [] + delete: [] + replace: [] + agents: + id: confluent.sql.agents + name: agents + title: Agents + methods: + list_sqlv1_agents: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1agents/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_sqlv1_agent: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1databases~1{kafka_cluster_id}~1agents/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_sqlv1_agent: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1databases~1{kafka_cluster_id}~1agents~1{agent_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_sqlv1_agent: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1databases~1{kafka_cluster_id}~1agents~1{agent_name}/put + response: + mediaType: application/json + openAPIDocKey: '200' + delete_sqlv1_agent: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1databases~1{kafka_cluster_id}~1agents~1{agent_name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/agents/methods/get_sqlv1_agent' + - $ref: '#/components/x-stackQL-resources/agents/methods/list_sqlv1_agents' + insert: + - $ref: '#/components/x-stackQL-resources/agents/methods/create_sqlv1_agent' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/agents/methods/delete_sqlv1_agent' + replace: + - $ref: '#/components/x-stackQL-resources/agents/methods/update_sqlv1_agent' + tools: + id: confluent.sql.tools + name: tools + title: Tools + methods: + create_sqlv1_tool: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1databases~1{database_name}~1tools/post + response: + mediaType: application/json + openAPIDocKey: '200' + list_sqlv1_tools: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1databases~1{database_name}~1tools/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_sqlv1_tool: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1databases~1{database_name}~1tools~1{tool_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_sqlv1_tool: + operation: + $ref: >- + #/paths/~1sql~1v1~1organizations~1{organization_id}~1environments~1{environment_id}~1databases~1{database_name}~1tools~1{tool_name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tools/methods/get_sqlv1_tool' + - $ref: '#/components/x-stackQL-resources/tools/methods/list_sqlv1_tools' + insert: + - $ref: '#/components/x-stackQL-resources/tools/methods/create_sqlv1_tool' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/tools/methods/delete_sqlv1_tool' + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/stream_sharing.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/stream_sharing.yaml new file mode 100644 index 0000000..86e51df --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/stream_sharing.yaml @@ -0,0 +1,8214 @@ +openapi: 3.0.0 +info: + title: stream_sharing API + description: confluent stream_sharing API + version: 1.0.0 +paths: + /cdx/v1/provider-shared-resources: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCdxV1ProviderSharedResources + summary: List of Provider Shared Resources + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all provider shared + resources. + parameters: + - name: stream_share + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: ss-1234 + description: Filter the results by exact match for stream_share. + - name: crn + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: >- + crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + description: Filter the results by exact match for crn. + - name: include_deleted + in: query + required: false + schema: + $ref: '#/components/schemas/BooleanFilter' + description: Include deactivated shared resources + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Provider Shared Resource. + content: + application/json: + schema: + type: object + description: >- + `ProviderSharedResource` object contains details of the data + stream + + (topic, schema registry subjects, sharing metadata) that you + have shared through Stream Sharing. + + + + ## The Provider Shared Resources Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderSharedResourceList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `ProviderSharedResource` object contains details of the + data stream + + (topic, schema registry subjects, sharing metadata) that + you have shared through Stream Sharing. + + + + ## The Provider Shared Resources Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - ProviderSharedResource + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + crn: + type: string + description: Deprecated please use resources attribute. + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic + x-immutable: true + resources: + type: array + minItems: 1 + description: List of resource crns that are shared together + items: + type: string + description: crn that specifies the shared resource + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + display_name: + type: string + description: Shared resource display name + example: Stock Trades + description: + type: string + description: Description of shared resource + example: >- + This topic provides realtime data for the orders + placed through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: >- + List of schemas in JSON format. This field is work + in progress and subject to changes. + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of contact person from the organization + logo_url: + type: string + format: uri + description: Resource logo url + example: >- + https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo + readOnly: true + organization_name: + description: >- + Organization to which the shared resource belongs. + Deprecated + example: ABC Corp + x-immutable: true + readOnly: true + environment_name: + type: string + description: >- + The environment name of the shared resource. + Deprecated + example: Public Env + x-immutable: true + readOnly: true + cluster_name: + type: string + description: >- + The cluster display name of the shared resource. + Deprecated + example: Published Trades + x-immutable: true + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: >- + Environment of the referred resource, if + env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - display_name + - organization_name + - environment_name + - cluster_name + - cloud_cluster + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/provider-shared-resources/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCdxV1ProviderSharedResource + summary: Read a Provider Shared Resource + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a provider shared resource. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider shared resource. + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Provider Shared Resource. + content: + application/json: + schema: + type: object + description: >- + `ProviderSharedResource` object contains details of the data + stream + + (topic, schema registry subjects, sharing metadata) that you + have shared through Stream Sharing. + + + + ## The Provider Shared Resources Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderSharedResource + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + crn: + type: string + description: Deprecated please use resources attribute. + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic + x-immutable: true + resources: + type: array + minItems: 1 + description: List of resource crns that are shared together + items: + type: string + description: crn that specifies the shared resource + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + display_name: + type: string + description: Shared resource display name + example: Stock Trades + description: + type: string + description: Description of shared resource + example: >- + This topic provides realtime data for the orders placed + through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: >- + List of schemas in JSON format. This field is work in + progress and subject to changes. + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of contact person from the organization + logo_url: + type: string + format: uri + description: Resource logo url + example: >- + https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo + readOnly: true + organization_name: + description: >- + Organization to which the shared resource belongs. + Deprecated + example: ABC Corp + x-immutable: true + readOnly: true + environment_name: + type: string + description: The environment name of the shared resource. Deprecated + example: Public Env + x-immutable: true + readOnly: true + cluster_name: + type: string + description: >- + The cluster display name of the shared resource. + Deprecated + example: Published Trades + x-immutable: true + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - display_name + - organization_name + - environment_name + - cluster_name + - cloud_cluster + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateCdxV1ProviderSharedResource + summary: Update a Provider Shared Resource + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a provider shared resource. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider shared resource. + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cdx.v1.ProviderSharedResource' + responses: + '200': + description: Provider Shared Resource. + content: + application/json: + schema: + type: object + description: >- + `ProviderSharedResource` object contains details of the data + stream + + (topic, schema registry subjects, sharing metadata) that you + have shared through Stream Sharing. + + + + ## The Provider Shared Resources Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderSharedResource + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + crn: + type: string + description: Deprecated please use resources attribute. + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic + x-immutable: true + resources: + type: array + minItems: 1 + description: List of resource crns that are shared together + items: + type: string + description: crn that specifies the shared resource + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + display_name: + type: string + description: Shared resource display name + example: Stock Trades + description: + type: string + description: Description of shared resource + example: >- + This topic provides realtime data for the orders placed + through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: >- + List of schemas in JSON format. This field is work in + progress and subject to changes. + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of contact person from the organization + logo_url: + type: string + format: uri + description: Resource logo url + example: >- + https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo + readOnly: true + organization_name: + description: >- + Organization to which the shared resource belongs. + Deprecated + example: ABC Corp + x-immutable: true + readOnly: true + environment_name: + type: string + description: The environment name of the shared resource. Deprecated + example: Public Env + x-immutable: true + readOnly: true + cluster_name: + type: string + description: >- + The cluster display name of the shared resource. + Deprecated + example: Published Trades + x-immutable: true + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - display_name + - organization_name + - environment_name + - cluster_name + - cloud_cluster + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/provider-shared-resources/{id}/images/{file_name}: + post: + summary: Upload image for shared resource + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Upload the image file for the shared resource + requestBody: + content: + image/*: + schema: + type: string + format: base64 + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ProviderSharedResource + operationId: upload_imageCdxV1ProviderSharedResource + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider shared resource. + - name: file_name + in: path + required: true + schema: + type: string + description: The File Name + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '201': + description: image uploaded + headers: + Location: + schema: + type: string + format: uri + example: https://some-subdomain.confluent.cloud/path/to/resource + description: A URL that allows access to the image file + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + get: + summary: Get image for shared resource + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Returns the image file for the shared resource + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ProviderSharedResource + operationId: view_imageCdxV1ProviderSharedResource + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider shared resource. + - name: file_name + in: path + required: true + schema: + type: string + description: The File Name + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: returns the image file + content: + image/*: + schema: + type: string + format: binary + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + summary: Delete the shared resource's image + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Deletes the image file for the shared resource + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ProviderSharedResource + operationId: delete_imageCdxV1ProviderSharedResource + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider shared resource. + - name: file_name + in: path + required: true + schema: + type: string + description: The File Name + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/provider-shares: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCdxV1ProviderShares + summary: List of Provider Shares + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all provider shares. + parameters: + - name: shared_resource + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: sr-1234 + description: Filter the results by exact match for shared_resource. + - name: crn + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: >- + crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + description: Filter the results by exact match for crn. + - name: include_deleted + in: query + required: false + schema: + $ref: '#/components/schemas/BooleanFilter' + description: Include deactivated shares + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Provider Shares (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Provider Share. + content: + application/json: + schema: + type: object + description: >- + `ProviderShare` object respresents the share that you have + created through Stream Sharing. + + + + Related guide: [Provider Stream Shares in Confluent + Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares). + + + ## The Provider Shares Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderShareList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `ProviderShare` object respresents the share that you + have created through Stream Sharing. + + + + Related guide: [Provider Stream Shares in Confluent + Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares). + + + ## The Provider Shares Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - ProviderShare + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + consumer_user_name: + type: string + description: Name of the consumer + example: John Doe + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user. Deprecated + example: Jane Doe + readOnly: true + delivery_method: + description: Method by which the invite will be delivered + type: string + x-extensible-enum: + - EMAIL + example: EMAIL + x-immutable: true + consumer_restriction: + description: >- + Restrictions on the consumer that can redeem this + token + discriminator: + propertyName: kind + mapping: + Email: >- + #/components/schemas/cdx.v1.EmailConsumerRestriction + x-immutable: true + type: object + required: + - kind + - email + properties: + kind: + description: The resource kind + type: string + enum: + - Email + email: + type: string + format: email + description: Email based matching for the consumers + invited_at: + type: string + format: date-time + description: The date and time at which consumer was invited + example: '2006-01-02T15:04:05-07:00' + readOnly: true + invite_expires_at: + type: string + format: date-time + description: >- + The date and time at which the invitation will + expire. Only for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + redeemed_at: + type: string + format: date-time + description: The date and time at which the invite was redeemed + example: '2006-01-02T15:04:05-07:00' + readOnly: true + provider_user: + description: The provider user/inviter + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + service_account: + description: The service account associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: >- + Environment of the referred resource, if + env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ProviderShareStatus' + required: + - id + - metadata + - provider_user_name + - delivery_method + - invited_at + - invite_expires_at + - provider_user + - cloud_cluster + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + summary: Create a provider share + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Creates a share based on delivery method. + requestBody: + content: + application/json: + schema: + type: object + description: Create share request + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CreateProviderShareRequest + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + delivery_method: + type: string + description: Method by which the invite will be delivered + x-extensible-enum: + - EMAIL + example: EMAIL + consumer_restriction: + description: Restrictions on the consumer that can redeem this token + discriminator: + propertyName: kind + mapping: + Email: '#/components/schemas/cdx.v1.EmailConsumerRestriction' + type: object + required: + - kind + - email + properties: + kind: + description: The resource kind + type: string + enum: + - Email + email: + type: string + format: email + description: Email based matching for the consumers + resources: + type: array + minItems: 1 + description: List of resource crns to be shared + items: + type: string + description: crn that specifies the sharedresource + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + required: + - delivery_method + - consumer_restriction + - resources + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createCdxV1ProviderShare + tags: + - Provider Shares (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '201': + description: | + Response is the provider share + headers: + Location: + schema: + type: string + format: uri + example: https://some-subdomain.confluent.cloud/path/to/resource + description: A URL that allows access to the resourced named by the crn + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/cdx.v1.ProviderShare' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/provider-shares/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCdxV1ProviderShare + summary: Read a Provider Share + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a provider share. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider share. + tags: + - Provider Shares (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Provider Share. + content: + application/json: + schema: + type: object + description: >- + `ProviderShare` object respresents the share that you have + created through Stream Sharing. + + + + Related guide: [Provider Stream Shares in Confluent + Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares). + + + ## The Provider Shares Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderShare + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + consumer_user_name: + type: string + description: Name of the consumer + example: John Doe + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user. Deprecated + example: Jane Doe + readOnly: true + delivery_method: + description: Method by which the invite will be delivered + type: string + x-extensible-enum: + - EMAIL + example: EMAIL + x-immutable: true + consumer_restriction: + description: Restrictions on the consumer that can redeem this token + discriminator: + propertyName: kind + mapping: + Email: '#/components/schemas/cdx.v1.EmailConsumerRestriction' + x-immutable: true + type: object + required: + - kind + - email + properties: + kind: + description: The resource kind + type: string + enum: + - Email + email: + type: string + format: email + description: Email based matching for the consumers + invited_at: + type: string + format: date-time + description: The date and time at which consumer was invited + example: '2006-01-02T15:04:05-07:00' + readOnly: true + invite_expires_at: + type: string + format: date-time + description: >- + The date and time at which the invitation will expire. + Only for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + redeemed_at: + type: string + format: date-time + description: The date and time at which the invite was redeemed + example: '2006-01-02T15:04:05-07:00' + readOnly: true + provider_user: + description: The provider user/inviter + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + service_account: + description: The service account associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ProviderShareStatus' + required: + - api_version + - kind + - id + - provider_user_name + - delivery_method + - invited_at + - invite_expires_at + - provider_user + - cloud_cluster + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteCdxV1ProviderShare + summary: Delete a Provider Share + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a provider share. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider share. + tags: + - Provider Shares (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Provider Share is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/provider-shares/{id}:resend: + post: + summary: Resend + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Resend provider share + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ProviderShare + operationId: resendCdxV1ProviderShare + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider share. + tags: + - Provider Shares (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/consumer-shared-resources: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCdxV1ConsumerSharedResources + summary: List of Consumer Shared Resources + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all consumer shared + resources. + parameters: + - name: stream_share + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: ss-1234 + description: Filter the results by exact match for stream_share. + - name: include_deleted + in: query + required: false + schema: + $ref: '#/components/schemas/BooleanFilter' + description: Include deactivated shared resources + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Consumer Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Consumer Shared Resource. + content: + application/json: + schema: + type: object + description: >- + `ConsumerSharedResource` object contains details of the data + stream + + (topic, schema registry subjects, sharing metadata) that you + received through Stream Sharing. + + + + ## The Consumer Shared Resources Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerSharedResourceList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `ConsumerSharedResource` object contains details of the + data stream + + (topic, schema registry subjects, sharing metadata) that + you received through Stream Sharing. + + + + ## The Consumer Shared Resources Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - ConsumerSharedResource + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: >- + The cloud service provider of the provider shared + cluster. + x-extensible-enum: + - AWS + - AZURE + - GCP + example: AWS + x-immutable: true + readOnly: true + network_connection_types: + type: array + description: > + The network connection types of the provider shared + cluster. If the shared cluster is on public + internet, + + then the list will be empty + items: + $ref: '#/components/schemas/cdx.v1.ConnectionType' + uniqueItems: true + x-immutable: true + readOnly: true + display_name: + type: string + description: Consumer resource display name + example: Stock Trades + x-immutable: true + readOnly: true + description: + type: string + description: Description of consumer resource + example: >- + This topic provides realtime data for the orders + placed through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: >- + List of schemas in JSON format. This field is work + in progress and subject to changes. + x-immutable: true + readOnly: true + organization_name: + type: string + description: Shared resource's organization name + example: ABC Corp + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + x-immutable: true + readOnly: true + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of the shared resource's organization contact + x-immutable: true + readOnly: true + logo_url: + type: string + format: uri + description: Resource logo url + example: >- + https://confluent.cloud/api/cdx/v1/consumer-shared-resources/sr-123/images/logo + x-immutable: true + readOnly: true + required: + - id + - metadata + - cloud + - display_name + - organization_name + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/consumer-shared-resources/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCdxV1ConsumerSharedResource + summary: Read a Consumer Shared Resource + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a consumer shared resource. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the consumer shared resource. + tags: + - Consumer Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Consumer Shared Resource. + content: + application/json: + schema: + type: object + description: >- + `ConsumerSharedResource` object contains details of the data + stream + + (topic, schema registry subjects, sharing metadata) that you + received through Stream Sharing. + + + + ## The Consumer Shared Resources Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerSharedResource + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider of the provider shared cluster. + x-extensible-enum: + - AWS + - AZURE + - GCP + example: AWS + x-immutable: true + readOnly: true + network_connection_types: + type: array + description: > + The network connection types of the provider shared + cluster. If the shared cluster is on public internet, + + then the list will be empty + items: + $ref: '#/components/schemas/cdx.v1.ConnectionType' + uniqueItems: true + x-immutable: true + readOnly: true + display_name: + type: string + description: Consumer resource display name + example: Stock Trades + x-immutable: true + readOnly: true + description: + type: string + description: Description of consumer resource + example: >- + This topic provides realtime data for the orders placed + through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: >- + List of schemas in JSON format. This field is work in + progress and subject to changes. + x-immutable: true + readOnly: true + organization_name: + type: string + description: Shared resource's organization name + example: ABC Corp + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + x-immutable: true + readOnly: true + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of the shared resource's organization contact + x-immutable: true + readOnly: true + logo_url: + type: string + format: uri + description: Resource logo url + example: >- + https://confluent.cloud/api/cdx/v1/consumer-shared-resources/sr-123/images/logo + x-immutable: true + readOnly: true + required: + - api_version + - kind + - id + - cloud + - display_name + - organization_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/consumer-shared-resources/{id}/images/{file_name}: + get: + summary: Get image for shared resource + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Returns the image file for the shared resource + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ConsumerSharedResource + operationId: imageCdxV1ConsumerSharedResource + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the consumer shared resource. + - name: file_name + in: path + required: true + schema: + type: string + description: The File Name + tags: + - Consumer Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Returns the image file's binary content + content: + image/*: + schema: + type: string + format: binary + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/consumer-shared-resources/{id}:network: + get: + summary: Get shared resource's network configuration + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Returns network information of the shared resource + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ConsumerSharedResource + operationId: networkCdxV1ConsumerSharedResource + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the consumer shared resource. + tags: + - Consumer Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: The network information of the shared resource + content: + application/json: + schema: + $ref: '#/components/schemas/cdx.v1.Network' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/consumer-shares: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCdxV1ConsumerShares + summary: List of Consumer Shares + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all consumer shares. + parameters: + - name: shared_resource + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: sr-1234 + description: Filter the results by exact match for shared_resource. + - name: include_deleted + in: query + required: false + schema: + $ref: '#/components/schemas/BooleanFilter' + description: Include deactivated shares + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Consumer Shares (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Consumer Share. + content: + application/json: + schema: + type: object + description: >- + `ConsumerShare` object respresents the share that you received + through Stream Sharing. + + + + Related guide: [Consumer Stream Shares in Confluent + Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html). + + + ## The Consumer Shares Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerShareList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `ConsumerShare` object respresents the share that you + received through Stream Sharing. + + + + Related guide: [Consumer Stream Shares in Confluent + Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html). + + + ## The Consumer Shares Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - ConsumerShare + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + provider_organization_name: + type: string + description: Provider organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user + example: Jane Doe + readOnly: true + invite_expires_at: + type: string + format: date-time + description: >- + The date and time at which the invitation will + expire. Only for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name. Deprecated + example: Nasdaq + readOnly: true + consumer_user_name: + type: string + description: Name of the consumer. Deprecated + example: John Doe + readOnly: true + consumer_user: + description: The consumer user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ConsumerShareStatus' + required: + - id + - metadata + - provider_organization_name + - provider_user_name + - consumer_user + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/consumer-shares/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCdxV1ConsumerShare + summary: Read a Consumer Share + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a consumer share. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the consumer share. + tags: + - Consumer Shares (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Consumer Share. + content: + application/json: + schema: + type: object + description: >- + `ConsumerShare` object respresents the share that you received + through Stream Sharing. + + + + Related guide: [Consumer Stream Shares in Confluent + Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html). + + + ## The Consumer Shares Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerShare + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + provider_organization_name: + type: string + description: Provider organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user + example: Jane Doe + readOnly: true + invite_expires_at: + type: string + format: date-time + description: >- + The date and time at which the invitation will expire. + Only for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name. Deprecated + example: Nasdaq + readOnly: true + consumer_user_name: + type: string + description: Name of the consumer. Deprecated + example: John Doe + readOnly: true + consumer_user: + description: The consumer user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ConsumerShareStatus' + required: + - api_version + - kind + - id + - provider_organization_name + - provider_user_name + - consumer_user + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteCdxV1ConsumerShare + summary: Delete a Consumer Share + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a consumer share. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the consumer share. + tags: + - Consumer Shares (cdx/v1) + security: + - cloud-api-key: [] + responses: + '204': + description: A Consumer Share is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/shared-tokens:resources: + post: + summary: Validate token to view shared resources + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Validate and decrypt the shared token and view token's shared resources + requestBody: + content: + application/json: + schema: + type: object + description: >- + Encrypted Token shared with consumer + + + + ## The Shared Tokens Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - SharedToken + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + token: + type: string + description: The encrypted token + required: + - token + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.SharedToken + operationId: resourcesCdxV1SharedToken + tags: + - Shared Tokens (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: > + Consumer validates share token and view consumer resources before + redeeming in the workflow + content: + application/json: + schema: + type: object + properties: + consumer_shared_resources: + type: array + items: + $ref: '#/components/schemas/cdx.v1.ConsumerSharedResource' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/shared-tokens:redeem: + post: + summary: Redeem token + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Redeem the shared token for shared topic and cluster access information + requestBody: + content: + application/json: + schema: + type: object + description: Redeem share with token request parameters + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RedeemTokenRequest + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + token: + type: string + description: The encrypted token + aws_account: + type: string + description: Consumer's AWS account ID for PrivateLink access. + example: '000000000000' + azure_subscription: + type: string + description: Consumer's Azure subscription ID for PrivateLink access. + example: 00000000-0000-0000-0000-000000000000 + gcp_project: + type: string + minLength: 1 + description: >- + Consumer's GCP project ID for Private Service Connect + access. + required: + - token + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.SharedToken + operationId: redeemCdxV1SharedToken + tags: + - Shared Tokens (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: | + Consumer redeems shared token + content: + application/json: + schema: + $ref: '#/components/schemas/cdx.v1.RedeemTokenResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/opt-in: + get: + summary: Read the organization's stream sharing opt-in settings + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Returns the organization's stream sharing opt-in settings. + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCdxV1OptIn + tags: + - Opt Ins (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Opt In. + content: + application/json: + schema: + type: object + description: >- + Stream sharing opt in options + + + ## The Opt Ins Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OptIn + stream_share_enabled: + type: boolean + description: Enable stream sharing for the organization + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + summary: Set the organization's stream sharing opt-in settings + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Updates the organization's stream sharing opt-in settings. + + + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateCdxV1OptIn + tags: + - Opt Ins (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cdx.v1.OptIn' + responses: + '200': + description: Opt In. + content: + application/json: + schema: + type: object + description: >- + Stream sharing opt in options + + + ## The Opt Ins Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OptIn + stream_share_enabled: + type: boolean + description: Enable stream sharing for the organization + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + BooleanFilter: + type: boolean + description: Filter for whether this value is true or false. + cdx.v1.ProviderSharedResourceList: + type: object + description: >- + `ProviderSharedResource` object contains details of the data stream + + (topic, schema registry subjects, sharing metadata) that you have shared + through Stream Sharing. + + + + ## The Provider Shared Resources Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderSharedResourceList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `ProviderSharedResource` object contains details of the data + stream + + (topic, schema registry subjects, sharing metadata) that you have + shared through Stream Sharing. + + + + ## The Provider Shared Resources Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderSharedResource + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + crn: + type: string + description: Deprecated please use resources attribute. + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic + x-immutable: true + resources: + type: array + minItems: 1 + description: List of resource crns that are shared together + items: + type: string + description: crn that specifies the shared resource + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + display_name: + type: string + description: Shared resource display name + example: Stock Trades + description: + type: string + description: Description of shared resource + example: >- + This topic provides realtime data for the orders placed + through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: >- + List of schemas in JSON format. This field is work in progress + and subject to changes. + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of contact person from the organization + logo_url: + type: string + format: uri + description: Resource logo url + example: >- + https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo + readOnly: true + organization_name: + description: Organization to which the shared resource belongs. Deprecated + example: ABC Corp + x-immutable: true + readOnly: true + environment_name: + type: string + description: The environment name of the shared resource. Deprecated + example: Public Env + x-immutable: true + readOnly: true + cluster_name: + type: string + description: The cluster display name of the shared resource. Deprecated + example: Published Trades + x-immutable: true + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - display_name + - organization_name + - environment_name + - cluster_name + - cloud_cluster + uniqueItems: true + cdx.v1.ProviderSharedResource: + type: object + description: >- + `ProviderSharedResource` object contains details of the data stream + + (topic, schema registry subjects, sharing metadata) that you have shared + through Stream Sharing. + + + + ## The Provider Shared Resources Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderSharedResource + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + crn: + type: string + description: Deprecated please use resources attribute. + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic + x-immutable: true + resources: + type: array + minItems: 1 + description: List of resource crns that are shared together + items: + type: string + description: crn that specifies the shared resource + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + display_name: + type: string + description: Shared resource display name + example: Stock Trades + description: + type: string + description: Description of shared resource + example: >- + This topic provides realtime data for the orders placed through the + website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: >- + List of schemas in JSON format. This field is work in progress and + subject to changes. + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of contact person from the organization + logo_url: + type: string + format: uri + description: Resource logo url + example: >- + https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo + readOnly: true + organization_name: + description: Organization to which the shared resource belongs. Deprecated + example: ABC Corp + x-immutable: true + readOnly: true + environment_name: + type: string + description: The environment name of the shared resource. Deprecated + example: Public Env + x-immutable: true + readOnly: true + cluster_name: + type: string + description: The cluster display name of the shared resource. Deprecated + example: Published Trades + x-immutable: true + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cdx.v1.ProviderShareList: + type: object + description: >- + `ProviderShare` object respresents the share that you have created + through Stream Sharing. + + + + Related guide: [Provider Stream Shares in Confluent + Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares). + + + ## The Provider Shares Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderShareList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `ProviderShare` object respresents the share that you have created + through Stream Sharing. + + + + Related guide: [Provider Stream Shares in Confluent + Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares). + + + ## The Provider Shares Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderShare + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + consumer_user_name: + type: string + description: Name of the consumer + example: John Doe + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user. Deprecated + example: Jane Doe + readOnly: true + delivery_method: + description: Method by which the invite will be delivered + type: string + x-extensible-enum: + - EMAIL + example: EMAIL + x-immutable: true + consumer_restriction: + description: Restrictions on the consumer that can redeem this token + discriminator: + propertyName: kind + mapping: + Email: '#/components/schemas/cdx.v1.EmailConsumerRestriction' + x-immutable: true + type: object + required: + - kind + - email + properties: + kind: + description: The resource kind + type: string + enum: + - Email + email: + type: string + format: email + description: Email based matching for the consumers + invited_at: + type: string + format: date-time + description: The date and time at which consumer was invited + example: '2006-01-02T15:04:05-07:00' + readOnly: true + invite_expires_at: + type: string + format: date-time + description: >- + The date and time at which the invitation will expire. Only + for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + redeemed_at: + type: string + format: date-time + description: The date and time at which the invite was redeemed + example: '2006-01-02T15:04:05-07:00' + readOnly: true + provider_user: + description: The provider user/inviter + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + service_account: + description: The service account associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ProviderShareStatus' + required: + - id + - metadata + - provider_user_name + - delivery_method + - invited_at + - invite_expires_at + - provider_user + - cloud_cluster + - status + uniqueItems: true + cdx.v1.CreateProviderShareRequest: + type: object + description: Create share request + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CreateProviderShareRequest + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + delivery_method: + type: string + description: Method by which the invite will be delivered + x-extensible-enum: + - EMAIL + example: EMAIL + consumer_restriction: + description: Restrictions on the consumer that can redeem this token + discriminator: + propertyName: kind + mapping: + Email: '#/components/schemas/cdx.v1.EmailConsumerRestriction' + type: object + required: + - kind + - email + properties: + kind: + description: The resource kind + type: string + enum: + - Email + email: + type: string + format: email + description: Email based matching for the consumers + resources: + type: array + minItems: 1 + description: List of resource crns to be shared + items: + type: string + description: crn that specifies the sharedresource + format: uri + pattern: ^crn://.+$ + example: >- + crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + cdx.v1.ProviderShare: + type: object + description: >- + `ProviderShare` object respresents the share that you have created + through Stream Sharing. + + + + Related guide: [Provider Stream Shares in Confluent + Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares). + + + ## The Provider Shares Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderShare + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + consumer_user_name: + type: string + description: Name of the consumer + example: John Doe + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user. Deprecated + example: Jane Doe + readOnly: true + delivery_method: + description: Method by which the invite will be delivered + type: string + x-extensible-enum: + - EMAIL + example: EMAIL + x-immutable: true + consumer_restriction: + description: Restrictions on the consumer that can redeem this token + discriminator: + propertyName: kind + mapping: + Email: '#/components/schemas/cdx.v1.EmailConsumerRestriction' + x-immutable: true + type: object + required: + - kind + - email + properties: + kind: + description: The resource kind + type: string + enum: + - Email + email: + type: string + format: email + description: Email based matching for the consumers + invited_at: + type: string + format: date-time + description: The date and time at which consumer was invited + example: '2006-01-02T15:04:05-07:00' + readOnly: true + invite_expires_at: + type: string + format: date-time + description: >- + The date and time at which the invitation will expire. Only for + invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + redeemed_at: + type: string + format: date-time + description: The date and time at which the invite was redeemed + example: '2006-01-02T15:04:05-07:00' + readOnly: true + provider_user: + description: The provider user/inviter + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + service_account: + description: The service account associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ProviderShareStatus' + cdx.v1.ConsumerSharedResourceList: + type: object + description: >- + `ConsumerSharedResource` object contains details of the data stream + + (topic, schema registry subjects, sharing metadata) that you received + through Stream Sharing. + + + + ## The Consumer Shared Resources Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerSharedResourceList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `ConsumerSharedResource` object contains details of the data + stream + + (topic, schema registry subjects, sharing metadata) that you + received through Stream Sharing. + + + + ## The Consumer Shared Resources Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerSharedResource + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider of the provider shared cluster. + x-extensible-enum: + - AWS + - AZURE + - GCP + example: AWS + x-immutable: true + readOnly: true + network_connection_types: + type: array + description: > + The network connection types of the provider shared cluster. + If the shared cluster is on public internet, + + then the list will be empty + items: + $ref: '#/components/schemas/cdx.v1.ConnectionType' + uniqueItems: true + x-immutable: true + readOnly: true + display_name: + type: string + description: Consumer resource display name + example: Stock Trades + x-immutable: true + readOnly: true + description: + type: string + description: Description of consumer resource + example: >- + This topic provides realtime data for the orders placed + through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: >- + List of schemas in JSON format. This field is work in progress + and subject to changes. + x-immutable: true + readOnly: true + organization_name: + type: string + description: Shared resource's organization name + example: ABC Corp + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + x-immutable: true + readOnly: true + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of the shared resource's organization contact + x-immutable: true + readOnly: true + logo_url: + type: string + format: uri + description: Resource logo url + example: >- + https://confluent.cloud/api/cdx/v1/consumer-shared-resources/sr-123/images/logo + x-immutable: true + readOnly: true + required: + - id + - metadata + - cloud + - display_name + - organization_name + uniqueItems: true + cdx.v1.ConsumerSharedResource: + type: object + description: >- + `ConsumerSharedResource` object contains details of the data stream + + (topic, schema registry subjects, sharing metadata) that you received + through Stream Sharing. + + + + ## The Consumer Shared Resources Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerSharedResource + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider of the provider shared cluster. + x-extensible-enum: + - AWS + - AZURE + - GCP + example: AWS + x-immutable: true + readOnly: true + network_connection_types: + type: array + description: > + The network connection types of the provider shared cluster. If the + shared cluster is on public internet, + + then the list will be empty + items: + $ref: '#/components/schemas/cdx.v1.ConnectionType' + uniqueItems: true + x-immutable: true + readOnly: true + display_name: + type: string + description: Consumer resource display name + example: Stock Trades + x-immutable: true + readOnly: true + description: + type: string + description: Description of consumer resource + example: >- + This topic provides realtime data for the orders placed through the + website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: >- + List of schemas in JSON format. This field is work in progress and + subject to changes. + x-immutable: true + readOnly: true + organization_name: + type: string + description: Shared resource's organization name + example: ABC Corp + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + x-immutable: true + readOnly: true + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of the shared resource's organization contact + x-immutable: true + readOnly: true + logo_url: + type: string + format: uri + description: Resource logo url + example: >- + https://confluent.cloud/api/cdx/v1/consumer-shared-resources/sr-123/images/logo + x-immutable: true + readOnly: true + cdx.v1.Network: + type: object + description: >- + The shared cluster's network configurations for consumer to setup + private link + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + kafka_bootstrap_url: + type: string + format: uri + description: The kafka cluster bootstrap url + example: SASL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + x-immutable: true + readOnly: true + zones: + type: array + items: + type: string + uniqueItems: true + minItems: 3 + maxItems: 3 + description: > + The 3 availability zones for this network. They can optionally be + specified for AWS networks + + used with PrivateLink. Otherwise, they are automatically chosen by + Confluent Cloud. + + + On AWS, zones are AWS [AZ + IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) + (e.g. use1-az3) + + On GCP, zones are GCP + [zones](https://cloud.google.com/compute/docs/regions-zones) + (e.g. us-central1-c). + + On Azure, zones are Confluent-chosen names (e.g. 1, 2, 3) since + Azure does not + have universal zone identifiers. + example: + - use1-az1 + - use1-az2 + - use1-az3 + x-immutable: true + dns_domain: + type: string + description: The root DNS domain for the network if applicable. + example: 00000.us-east-1.aws.glb.confluent.cloud + readOnly: true + zonal_subdomains: + type: object + additionalProperties: + type: string + description: > + The DNS subdomain for each zone. Present on networks that support + PrivateLink. Keys are zones and + + values are DNS domains. + example: + use1-az1: use1-az1.00000.us-east-1.aws.confluent.cloud + use1-az4: use1-az4.00000.us-east-1.aws.confluent.cloud + use1-az5: use1-az5.00000.us-east-1.aws.confluent.cloud + readOnly: true + cloud: + description: >- + The cloud-specific network details. These will be populated when the + network reaches the READY state. + discriminator: + propertyName: kind + mapping: + AwsNetwork: '#/components/schemas/cdx.v1.AwsNetwork' + AzureNetwork: '#/components/schemas/cdx.v1.AzureNetwork' + GcpNetwork: '#/components/schemas/cdx.v1.GcpNetwork' + readOnly: true + type: object + required: + - kind + properties: + kind: + description: Network kind type. + type: string + enum: + - AwsNetwork + private_link_endpoint_service: + type: string + description: >- + The AWS VPC endpoint service for the network (used for + PrivateLink) if available. + example: com.amazonaws.vpce.eu-west-3.vpce-00000000000000000 + readOnly: true + private_link_service_aliases: + type: object + description: > + The mapping of zones to PrivateLink Service Aliases if + available. Keys are zones + + and values are [Azure PrivateLink Service + + Aliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service) + additionalProperties: + type: string + example: + '1': >- + 0-00000-privatelink-1.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '2': >- + 0-00000-privatelink-2.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '3': >- + 0-00000-privatelink-3.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + readOnly: true + private_service_connect_service_attachments: + type: object + description: > + The mapping of zones to Private Service Connect Service + + Attachments if available. Keys are zones and values are + + [GCP Private Service Connect Service + + Attachment](https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#api_7) + additionalProperties: + type: string + example: + us-central1-a: >- + projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-a + us-central1-b: >- + projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-b + us-central1-c: >- + projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-c + readOnly: true + cdx.v1.ConsumerShareList: + type: object + description: >- + `ConsumerShare` object respresents the share that you received through + Stream Sharing. + + + + Related guide: [Consumer Stream Shares in Confluent + Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html). + + + ## The Consumer Shares Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerShareList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `ConsumerShare` object respresents the share that you received + through Stream Sharing. + + + + Related guide: [Consumer Stream Shares in Confluent + Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html). + + + ## The Consumer Shares Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerShare + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + provider_organization_name: + type: string + description: Provider organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user + example: Jane Doe + readOnly: true + invite_expires_at: + type: string + format: date-time + description: >- + The date and time at which the invitation will expire. Only + for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name. Deprecated + example: Nasdaq + readOnly: true + consumer_user_name: + type: string + description: Name of the consumer. Deprecated + example: John Doe + readOnly: true + consumer_user: + description: The consumer user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ConsumerShareStatus' + required: + - id + - metadata + - provider_organization_name + - provider_user_name + - consumer_user + - status + uniqueItems: true + cdx.v1.ConsumerShare: + type: object + description: >- + `ConsumerShare` object respresents the share that you received through + Stream Sharing. + + + + Related guide: [Consumer Stream Shares in Confluent + Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html). + + + ## The Consumer Shares Model + + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerShare + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + provider_organization_name: + type: string + description: Provider organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user + example: Jane Doe + readOnly: true + invite_expires_at: + type: string + format: date-time + description: >- + The date and time at which the invitation will expire. Only for + invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name. Deprecated + example: Nasdaq + readOnly: true + consumer_user_name: + type: string + description: Name of the consumer. Deprecated + example: John Doe + readOnly: true + consumer_user: + description: The consumer user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ConsumerShareStatus' + cdx.v1.SharedToken: + type: object + description: |- + Encrypted Token shared with consumer + + + ## The Shared Tokens Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - SharedToken + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + token: + type: string + description: The encrypted token + cdx.v1.RedeemTokenRequest: + type: object + description: Redeem share with token request parameters + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RedeemTokenRequest + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + token: + type: string + description: The encrypted token + aws_account: + type: string + description: Consumer's AWS account ID for PrivateLink access. + example: '000000000000' + azure_subscription: + type: string + description: Consumer's Azure subscription ID for PrivateLink access. + example: 00000000-0000-0000-0000-000000000000 + gcp_project: + type: string + minLength: 1 + description: Consumer's GCP project ID for Private Service Connect access. + cdx.v1.RedeemTokenResponse: + type: object + description: Share details for the consumer org or user + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RedeemTokenResponse + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + api_key: + type: string + description: The api key + readOnly: true + secret: + type: string + description: The api key secret + x-redact: true + readOnly: true + kafka_bootstrap_url: + type: string + format: uri + description: The kafka cluster bootstrap url + example: SASL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + x-immutable: true + readOnly: true + schema_registry_api_key: + type: string + description: The api key for schema registry + readOnly: true + schema_registry_secret: + type: string + description: The api key secret for schema registry + x-redact: true + readOnly: true + schema_registry_url: + type: string + format: uri + description: The schema registry endpoint url + example: https://psrc-xxxxx.us-west-2.aws.confluent.cloud + x-immutable: true + readOnly: true + resources: + type: array + minItems: 1 + description: List of shared resources + items: + type: object + discriminator: + propertyName: kind + mapping: + Topic: '#/components/schemas/cdx.v1.SharedTopic' + Group: '#/components/schemas/cdx.v1.SharedGroup' + Subject: '#/components/schemas/cdx.v1.SharedSubject' + oneOf: + - $ref: '#/components/schemas/cdx.v1.SharedTopic' + - $ref: '#/components/schemas/cdx.v1.SharedGroup' + - $ref: '#/components/schemas/cdx.v1.SharedSubject' + cdx.v1.OptIn: + type: object + description: |- + Stream sharing opt in options + + ## The Opt Ins Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OptIn + stream_share_enabled: + type: boolean + description: Enable stream sharing for the organization + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cdx.v1.Schema: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + EnvScopedObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cdx.v1.EmailConsumerRestriction: + type: object + description: Consumer restrictions limits by authenticated user's email + required: + - kind + - email + properties: + kind: + description: The resource kind + type: string + enum: + - Email + email: + type: string + format: email + description: Email based matching for the consumers + GlobalObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cdx.v1.ProviderShareStatus: + type: object + required: + - phase + description: The status of the Provider Share + properties: + phase: + type: string + x-extensible-enum: + - INVITED + - EXPIRED + - ACTIVE + - DEACTIVATED + description: Status of share + example: ACTIVE + readOnly: true + readOnly: true + cdx.v1.ConnectionType: + type: string + description: Network connection type. + x-extensible-enum: + - PRIVATELINK + example: PRIVATELINK + cdx.v1.AwsNetwork: + type: object + description: The AWS network details. + required: + - kind + properties: + kind: + description: Network kind type. + type: string + enum: + - AwsNetwork + private_link_endpoint_service: + type: string + description: >- + The AWS VPC endpoint service for the network (used for PrivateLink) + if available. + example: com.amazonaws.vpce.eu-west-3.vpce-00000000000000000 + readOnly: true + cdx.v1.AzureNetwork: + type: object + description: The Azure network details. + required: + - kind + properties: + kind: + description: Network kind type. + type: string + enum: + - AzureNetwork + private_link_service_aliases: + type: object + description: > + The mapping of zones to PrivateLink Service Aliases if available. + Keys are zones + + and values are [Azure PrivateLink Service + + Aliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service) + additionalProperties: + type: string + example: + '1': >- + 0-00000-privatelink-1.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '2': >- + 0-00000-privatelink-2.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '3': >- + 0-00000-privatelink-3.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + readOnly: true + cdx.v1.GcpNetwork: + type: object + description: The GCP network details. + required: + - kind + properties: + kind: + description: Network kind type. + type: string + enum: + - GcpNetwork + private_service_connect_service_attachments: + type: object + description: > + The mapping of zones to Private Service Connect Service + + Attachments if available. Keys are zones and values are + + [GCP Private Service Connect Service + + Attachment](https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#api_7) + additionalProperties: + type: string + example: + us-central1-a: >- + projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-a + us-central1-b: >- + projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-b + us-central1-c: >- + projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-c + readOnly: true + cdx.v1.ConsumerShareStatus: + type: object + required: + - phase + description: The status of the Consumer Share + properties: + phase: + type: string + description: Status of share + x-extensible-enum: + - INVITED + - EXPIRED + - ACTIVE + - DEACTIVATED + example: ACTIVE + readOnly: true + readOnly: true + cdx.v1.SharedTopic: + type: object + description: The shared resource details + required: + - kind + - topic + properties: + kind: + description: The shared resource kind + type: string + enum: + - Topic + topic: + type: string + description: The topic name + cdx.v1.SharedGroup: + type: object + description: The shared consumer group + required: + - kind + - group_prefix + properties: + kind: + description: The resource kind + type: string + enum: + - Group + group_prefix: + type: string + description: The consumer group prefix + cdx.v1.SharedSubject: + type: object + description: The shared resource details + required: + - kind + - subject + properties: + kind: + description: The shared resource kind + type: string + enum: + - Subject + subject: + type: string + description: The subject name + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + x-stackQL-resources: + provider_shared_resources: + id: confluent.stream_sharing.provider_shared_resources + name: provider_shared_resources + title: Provider Shared Resources + methods: + list_cdx_v1_provider_shared_resources: + operation: + $ref: '#/paths/~1cdx~1v1~1provider-shared-resources/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_cdx_v1_provider_shared_resource: + operation: + $ref: '#/paths/~1cdx~1v1~1provider-shared-resources~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_cdx_v1_provider_shared_resource: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cdx~1v1~1provider-shared-resources~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + upload_image_cdx_v1_provider_shared_resource: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1cdx~1v1~1provider-shared-resources~1{id}~1images~1{file_name}/post + response: + mediaType: application/json + openAPIDocKey: '201' + view_image_cdx_v1_provider_shared_resource: + operation: + $ref: >- + #/paths/~1cdx~1v1~1provider-shared-resources~1{id}~1images~1{file_name}/get + response: + mediaType: image/* + openAPIDocKey: '200' + delete_image_cdx_v1_provider_shared_resource: + operation: + $ref: >- + #/paths/~1cdx~1v1~1provider-shared-resources~1{id}~1images~1{file_name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/provider_shared_resources/methods/get_cdx_v1_provider_shared_resource + - $ref: >- + #/components/x-stackQL-resources/provider_shared_resources/methods/list_cdx_v1_provider_shared_resources + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/provider_shared_resources/methods/update_cdx_v1_provider_shared_resource + delete: + - $ref: >- + #/components/x-stackQL-resources/provider_shared_resources/methods/delete_image_cdx_v1_provider_shared_resource + replace: [] + provider_shares: + id: confluent.stream_sharing.provider_shares + name: provider_shares + title: Provider Shares + methods: + list_cdx_v1_provider_shares: + operation: + $ref: '#/paths/~1cdx~1v1~1provider-shares/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_cdx_v1_provider_share: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cdx~1v1~1provider-shares/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_cdx_v1_provider_share: + operation: + $ref: '#/paths/~1cdx~1v1~1provider-shares~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_cdx_v1_provider_share: + operation: + $ref: '#/paths/~1cdx~1v1~1provider-shares~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + resend_cdx_v1_provider_share: + operation: + $ref: '#/paths/~1cdx~1v1~1provider-shares~1{id}:resend/post' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/provider_shares/methods/get_cdx_v1_provider_share + - $ref: >- + #/components/x-stackQL-resources/provider_shares/methods/list_cdx_v1_provider_shares + insert: + - $ref: >- + #/components/x-stackQL-resources/provider_shares/methods/create_cdx_v1_provider_share + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/provider_shares/methods/delete_cdx_v1_provider_share + replace: [] + consumer_shared_resources: + id: confluent.stream_sharing.consumer_shared_resources + name: consumer_shared_resources + title: Consumer Shared Resources + methods: + list_cdx_v1_consumer_shared_resources: + operation: + $ref: '#/paths/~1cdx~1v1~1consumer-shared-resources/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_cdx_v1_consumer_shared_resource: + operation: + $ref: '#/paths/~1cdx~1v1~1consumer-shared-resources~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + image_cdx_v1_consumer_shared_resource: + operation: + $ref: >- + #/paths/~1cdx~1v1~1consumer-shared-resources~1{id}~1images~1{file_name}/get + response: + mediaType: image/* + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/consumer_shared_resources/methods/get_cdx_v1_consumer_shared_resource + - $ref: >- + #/components/x-stackQL-resources/consumer_shared_resources/methods/list_cdx_v1_consumer_shared_resources + insert: [] + update: [] + delete: [] + replace: [] + shared_resources_network_config: + id: confluent.stream_sharing.shared_resources_network_config + name: shared_resources_network_config + title: Shared Resources Network Config + methods: + network_cdx_v1_consumer_shared_resource: + operation: + $ref: '#/paths/~1cdx~1v1~1consumer-shared-resources~1{id}:network/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/shared_resources_network_config/methods/network_cdx_v1_consumer_shared_resource + insert: [] + update: [] + delete: [] + replace: [] + consumer_shares: + id: confluent.stream_sharing.consumer_shares + name: consumer_shares + title: Consumer Shares + methods: + list_cdx_v1_consumer_shares: + operation: + $ref: '#/paths/~1cdx~1v1~1consumer-shares/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_cdx_v1_consumer_share: + operation: + $ref: '#/paths/~1cdx~1v1~1consumer-shares~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_cdx_v1_consumer_share: + operation: + $ref: '#/paths/~1cdx~1v1~1consumer-shares~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/consumer_shares/methods/get_cdx_v1_consumer_share + - $ref: >- + #/components/x-stackQL-resources/consumer_shares/methods/list_cdx_v1_consumer_shares + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/consumer_shares/methods/delete_cdx_v1_consumer_share + replace: [] + shared_tokens: + id: confluent.stream_sharing.shared_tokens + name: shared_tokens + title: Shared Tokens + methods: + resources_cdx_v1_shared_token: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cdx~1v1~1shared-tokens:resources/post' + response: + mediaType: application/json + openAPIDocKey: '200' + redeem_cdx_v1_shared_token: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cdx~1v1~1shared-tokens:redeem/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + opt_ins: + id: confluent.stream_sharing.opt_ins + name: opt_ins + title: Opt Ins + methods: + get_cdx_v1_opt_in: + operation: + $ref: '#/paths/~1cdx~1v1~1opt-in/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_cdx_v1_opt_in: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cdx~1v1~1opt-in/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/opt_ins/methods/get_cdx_v1_opt_in' + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/opt_ins/methods/update_cdx_v1_opt_in + delete: [] + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/streams_group.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/streams_group.yaml new file mode 100644 index 0000000..fee4f30 --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/streams_group.yaml @@ -0,0 +1,1413 @@ +openapi: 3.0.0 +info: + title: streams_group API + description: confluent streams_group API + version: 1.0.0 +paths: + /kafka/v3/clusters/{cluster_id}/streams-groups: + get: + summary: List Streams Groups + operationId: listKafkaStreamsGroups + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the list of streams groups that belong to the specified Kafka + cluster + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListStreamsGroupsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}: + get: + summary: Get Streams Group + operationId: getKafkaStreamsGroup + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the streams group specified by the ``group_id``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsGroupResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/subtopologies: + get: + summary: List Streams Group Subtopologies + operationId: listKafkaStreamsGroupSubtopologies + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return a list of subtopologies that belong to the specified streams + group. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListStreamsGroupSubtopologiesResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/subtopologies/{subtopology_id}: + get: + summary: Get Streams Group Subtopology + operationId: getKafkaStreamsGroupSubtopology + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the subtopology specified by the ``subtopology_id``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsGroupSubtopologyResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/SubtopologyId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members: + get: + summary: List Streams Group Members + operationId: listKafkaStreamsGroupMembers + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return a list of members that belong to the specified streams group. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListStreamsGroupMembersResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}: + get: + summary: Get Streams Group Member + operationId: getKafkaStreamsGroupMember + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the members specified by the ``member_id``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsGroupMemberResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments: + get: + summary: Get Streams Group Member Assignments + operationId: getKafkaStreamsGroupMemberAssignments + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the assignments of the member specified by the ``member_id``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsGroupMemberAssignmentsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments: + get: + summary: Get Streams Group Member Target Assignments + operationId: getKafkaStreamsGroupMemberTargetAssignments + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the target assignments of the member specified by the + ``member_id``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsGroupMemberAssignmentsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}: + get: + summary: List Streams Group Assignments of a Specific Type + operationId: listKafkaStreamsGroupMemberAssignmentTasks + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the tasks of the member specified by the ``member_id``, and the + type ``assignments_type``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListStreamsTasksResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}: + get: + summary: List Streams Group Target Assignments of a Specific Type + operationId: listKafkaStreamsGroupMemberTargetAssignmentTasks + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the target tasks of the member specified by the ``member_id``, + and the type ``assignments_type``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListStreamsTasksResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}/subtopologies/{subtopology_id}: + get: + summary: >- + List Streams Group Assignments Task Partitions of a Specific Type and + Subtopology + operationId: getKafkaStreamsGroupMemberAssignmentTaskPartitions + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the tasks of the member specified by the ``member_id``, and the + type ``assignments_type``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsTaskResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + - $ref: '#/components/parameters/SubtopologyId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}/subtopologies/{subtopology_id}: + get: + summary: >- + List Streams Group Target Assignments Task Partitions of a Specific Type + and Subtopology + operationId: getKafkaStreamsGroupMemberTargetAssignmentTaskPartitions + description: >- + [![Early + Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the tasks of the member specified by the ``member_id``, and the + type ``assignments_type``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsTaskResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: >- + Confluent Cloud REST Endpoint. For example + https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + - $ref: '#/components/parameters/SubtopologyId' +components: + schemas: + StreamsGroupDataList: + description: The list of Streams groups. + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + description: The array of Streams group details. + items: + $ref: '#/components/schemas/StreamsGroupData' + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + StreamsGroupData: + description: The details of a Streams group. + type: object + required: + - kind + - metadata + - cluster_id + - group_id + - state + - member_count + - subtopology_count + - group_epoch + - topology_epoch + - target_assignment_epoch + - members + - subtopologies + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + description: The unique identifier of the Kafka cluster. + group_id: + type: string + description: The unique identifier of the Streams group. + state: + $ref: '#/components/schemas/StreamsGroupState' + member_count: + type: integer + description: The number of members in the Streams group. + subtopology_count: + type: integer + description: The number of subtopologies in the Streams group. + group_epoch: + type: integer + description: The epoch of the Streams group. + topology_epoch: + type: integer + description: The epoch of the Streams topology. + target_assignment_epoch: + type: integer + description: The epoch of the target assignment. + members: + $ref: '#/components/schemas/Relationship' + subtopologies: + $ref: '#/components/schemas/Relationship' + StreamsGroupSubtopologyDataList: + description: The list of Streams group subtopologies. + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + description: The array of Streams group subtopology details. + items: + $ref: '#/components/schemas/StreamsGroupSubtopologyData' + StreamsGroupSubtopologyData: + description: The details of a Streams group subtopology. + type: object + required: + - kind + - metadata + - cluster_id + - group_id + - subtopology_id + - source_topics + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + description: The unique identifier of the Kafka cluster. + group_id: + type: string + description: The unique identifier of the Streams group. + subtopology_id: + type: string + description: The unique identifier of the Streams subtopology. + source_topics: + type: array + description: The list of source topics for the subtopology. + items: + type: string + description: The name of a source topic. + StreamsGroupMemberDataList: + description: The list of Streams group members. + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + description: The array of Streams group member details. + items: + $ref: '#/components/schemas/StreamsGroupMemberData' + StreamsGroupMemberData: + description: The details of a Streams group member. + type: object + required: + - kind + - metadata + - cluster_id + - group_id + - member_id + - process_id + - client_id + - instance_id + - member_epoch + - topology_epoch + - is_classic + - assignments + - target_assignment + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + description: The unique identifier of the Kafka cluster. + group_id: + type: string + description: The unique identifier of the Streams group. + member_id: + type: string + description: The unique identifier of the Streams group member. + process_id: + type: string + description: The process identifier of the Streams group member. + client_id: + type: string + description: The client identifier of the Streams group member. + instance_id: + type: string + description: The instance identifier of the Streams group member. + member_epoch: + type: integer + description: The epoch of the Streams group member. + topology_epoch: + type: integer + description: The epoch of the Streams topology for the member. + is_classic: + type: boolean + description: The flag indicating if the member is a classic consumer. + assignments: + $ref: '#/components/schemas/Relationship' + target_assignment: + $ref: '#/components/schemas/Relationship' + StreamsGroupMemberAssignmentData: + description: The assignment details of a Streams group member. + type: object + required: + - kind + - metadata + - cluster_id + - group_id + - member_id + - active_tasks + - standby_tasks + - warmup_tasks + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + description: The unique identifier of the Kafka cluster. + group_id: + type: string + description: The unique identifier of the Streams group. + member_id: + type: string + description: The unique identifier of the Streams group member. + active_tasks: + $ref: '#/components/schemas/Relationship' + standby_tasks: + $ref: '#/components/schemas/Relationship' + warmup_tasks: + $ref: '#/components/schemas/Relationship' + AssignmentsType: + description: The type of the Streams task assignments. + type: string + x-extensible-enum: + - ACTIVE + - STANDBY + - WARMUP + StreamsTaskDataList: + description: The list of Streams tasks. + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + description: The array of Streams task details. + items: + $ref: '#/components/schemas/StreamsTaskData' + StreamsTaskData: + description: The details of a Streams task. + type: object + required: + - kind + - metadata + - subtopology_id + - partition_ids + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + subtopology_id: + type: string + description: The unique identifier of the Streams subtopology. + partition_ids: + type: array + description: The list of partition IDs assigned to the Streams task. + items: + type: integer + description: The partition ID. + ResourceCollection: + type: object + required: + - kind + - metadata + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + Resource: + type: object + required: + - kind + - metadata + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + StreamsGroupState: + description: The state of the Streams group. + type: string + x-extensible-enum: + - UNKNOWN + - PREPARING_REBALANCE + - COMPLETING_REBALANCE + - STABLE + - DEAD + - EMPTY + - ASSIGNING + - RECONCILING + - NOT_READY + Relationship: + type: object + required: + - related + properties: + related: + type: string + ResourceCollectionMetadata: + type: object + required: + - self + properties: + self: + type: string + next: + type: string + nullable: true + ResourceMetadata: + type: object + required: + - self + properties: + self: + type: string + resource_name: + type: string + nullable: true + responses: + ListStreamsGroupsResponse: + description: The list of streams groups. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupDataList' + example: + kind: KafkaStreamsGroupList + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups + next: null + data: + - kind: KafkaStreamsGroup + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1 + cluster_id: cluster-1 + group_id: streams-group-1 + group_epoch: 1 + target_assignment_epoch: 1 + topology_epoch: 1 + state: STABLE + member_count: 2 + subtopology_count: 1 + members: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members + subtopologies: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/subtopologies + BadRequestErrorResponse: + description: >- + Indicates a bad request error. It could be caused by an unexpected + request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + bad_request_cannot_deserialize: + description: >- + Thrown when trying to deserialize an integer from non-integer + data. + value: + error_code: 400 + message: >- + Cannot deserialize value of type `java.lang.Integer` from + String "A": not a valid `java.lang.Integer` value + unsupported_version_exception: + description: >- + Thrown when the version of this API is not supported in the + underlying Kafka cluster. + value: + error_code: 40035 + message: >- + The version of this API is not supported in the underlying + Kafka cluster. + UnauthorizedErrorResponse: + description: >- + Indicates a client authentication error. Kafka authentication failures + will contain error code 40101 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + kafka_authentication_failed: + description: >- + Thrown when using Basic authentication with wrong Kafka + credentials. + value: + error_code: 40101 + message: Authentication failed + ForbiddenErrorResponse: + description: >- + Indicates a client authorization error. Kafka authorization failures + will contain error code 40301 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + kafka_authorization_failed: + description: >- + Thrown when the caller is not authorized to perform the + underlying operation. + value: + error_code: 40301 + message: Request is not authorized + TooManyRequestsErrorResponse: + description: >- + Indicates that a rate limit threshold has been reached, and the client + should retry again later. + content: + text/html: + schema: + type: string + example: + description: A sample response from Jetty's DoSFilter. + value: >- + Error 429 Too Many + Requests

HTTP ERROR 429 Too Many + Requests

+ + +
URI:/v3/clusters/my-cluster
STATUS:429
MESSAGE: Too Many + Requests
SERVLET: default
+ ServerErrorResponse: + description: >- + A server-side problem that might not be addressable from the client + side. Retriable Kafka errors will contain error code 50003 in the + response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + generic_internal_server_error: + description: Thrown for generic HTTP 500 errors. + value: + error_code: 500 + message: Internal Server Error + GetStreamsGroupResponse: + description: The streams group. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupData' + example: + kind: KafkaStreamsGroup + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1 + cluster_id: cluster-1 + group_id: streams-group-1 + group_epoch: 1 + target_assignment_epoch: 1 + topology_epoch: 1 + state: STABLE + member_count: 2 + subtopology_count: 1 + members: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members + subtopologies: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/subtopologies + ListStreamsGroupSubtopologiesResponse: + description: The list of subtoplogies of the streams group + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupSubtopologyDataList' + example: + kind: KafkaStreamsGroupSubtopologyList + metadata: + self: >- + http://localhost:8082/v3/clusters/cluster-1/streams-groups/streams-group-1/subtopologies + data: + - kind: KafkaStreamsSubtopology + metadata: + self: >- + http://localhost:8082/v3/clusters/cluster-1/streams-groups/streams-group-1/subtopologies/subtopology-1 + resource_name: >- + crn:///kafka=cluster-1/streams-group=streams-group-1/subtopology=subtopology-1 + cluster_id: cluster-1 + group_id: streams-group-1 + subtopology_id: subtopology-1 + source_topics: + - topic-1 + - topic-2 + GetStreamsGroupSubtopologyResponse: + description: The streams group subtopology. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupSubtopologyData' + example: + kind: KafkaStreamsGroupSubtopology + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/subtopologies/subtopology-1 + resource_name: >- + crn:///kafka=cluster-1/streams-group=streams-group-1/subtopology=subtopology-1 + cluster_id: cluster-1 + group_id: streams-group-1 + subtopology_id: subtopology-1 + source_topics: + - topic-1 + - topic-2 + ListStreamsGroupMembersResponse: + description: The list of members of the streams group + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupMemberDataList' + example: + kind: KafkaStreamsGroupMemberList + metadata: + self: >- + http://localhost:8082/v3/clusters/cluster-1/streams-groups/streams-group-1/members + data: + - kind: KafkaStreamsMember + metadata: + self: >- + http://localhost:8082/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1 + resource_name: >- + crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1 + cluster_id: cluster-1 + group_id: streams-group-1 + member_id: member-1 + process_id: process-1 + client_id: client-1 + instance_id: instance-1 + member_epoch: 2 + topology_epoch: 1 + is_classic: false + assignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments + target_assignment: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/target-assignment + GetStreamsGroupMemberResponse: + description: The streams group member. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupMemberData' + example: + kind: KafkaStreamsGroupMember + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1 + resource_name: >- + crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1 + cluster_id: cluster-1 + group_id: streams-group-1 + member_id: member-1 + process_id: process-1 + client_id: client-1 + instance_id: instance-1 + member_epoch: 2 + topology_epoch: 1 + is_classic: false + assignments: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments + target_assignment: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/target-assignment + GetStreamsGroupMemberAssignmentsResponse: + description: The streams group member assignments. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupMemberAssignmentData' + example: + kind: KafkaStreamsGroupMemberAssignments + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments + resource_name: >- + crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1/assignments + cluster_id: cluster-1 + group_id: streams-group-1 + member_id: member-1 + active_tasks: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments/active + standby_tasks: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignment/standby + warmup_tasks: + related: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignment/warmup + ListStreamsTasksResponse: + description: The streams group member assignments of specific type. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsTaskDataList' + example: + kind: KafkaStreamsGroupMemberAssignments + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments/active/subtopologies/subtopology-1 + resource_name: >- + crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1/assignments=active/subtopology=subtopology-1 + data: + - kind: GetStreamsTaskResponse + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments/active/subtopologies/subtopology-1 + resource_name: >- + crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1/assignments=active/subtopology=subtopology-1 + subtopology_id: subtopology-1 + partition_ids: + - 0 + - 1 + - 2 + GetStreamsTaskResponse: + description: The partitions of a streams member task. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsTaskData' + example: + kind: KafkaStreamsGroupMemberAssignments + metadata: + self: >- + https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments/active/subtopologies/subtopology-1 + resource_name: >- + crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1/assignments=active/subtopology=subtopology-1 + subtopology_id: subtopology-1 + partition_ids: + - 0 + - 1 + - 2 + parameters: + ClusterId: + name: cluster_id + description: The Kafka cluster ID. + in: path + required: true + schema: + type: string + example: cluster-1 + GroupId: + name: group_id + description: The group ID. + in: path + required: true + schema: + type: string + example: group-1 + SubtopologyId: + name: subtopology_id + description: The streams subtopology ID. + in: path + required: true + schema: + type: string + example: subtopology-1 + MemberId: + name: member_id + description: The streams member ID. + in: path + required: true + schema: + type: string + example: member-1 + AssignmentsType: + name: assignments_type + description: The streams member Assignment type. + in: path + required: true + schema: + $ref: '#/components/schemas/AssignmentsType' + example: active + x-stackQL-resources: + streams_groups: + id: confluent.streams_group.streams_groups + name: streams_groups + title: Streams Groups + methods: + list_kafka_streams_groups: + operation: + $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1streams-groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_kafka_streams_group: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1streams-groups~1{group_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/streams_groups/methods/get_kafka_streams_group + - $ref: >- + #/components/x-stackQL-resources/streams_groups/methods/list_kafka_streams_groups + insert: [] + update: [] + delete: [] + replace: [] + subtopologies: + id: confluent.streams_group.subtopologies + name: subtopologies + title: Subtopologies + methods: + list_kafka_streams_group_subtopologies: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1streams-groups~1{group_id}~1subtopologies/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_kafka_streams_group_subtopology: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1streams-groups~1{group_id}~1subtopologies~1{subtopology_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/subtopologies/methods/get_kafka_streams_group_subtopology + - $ref: >- + #/components/x-stackQL-resources/subtopologies/methods/list_kafka_streams_group_subtopologies + insert: [] + update: [] + delete: [] + replace: [] + members: + id: confluent.streams_group.members + name: members + title: Members + methods: + list_kafka_streams_group_members: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1streams-groups~1{group_id}~1members/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_kafka_streams_group_member: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1streams-groups~1{group_id}~1members~1{member_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/members/methods/get_kafka_streams_group_member + - $ref: >- + #/components/x-stackQL-resources/members/methods/list_kafka_streams_group_members + insert: [] + update: [] + delete: [] + replace: [] + member_assignments: + id: confluent.streams_group.member_assignments + name: member_assignments + title: Member Assignments + methods: + get_kafka_streams_group_member_assignments: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1streams-groups~1{group_id}~1members~1{member_id}~1assignments/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/member_assignments/methods/get_kafka_streams_group_member_assignments + insert: [] + update: [] + delete: [] + replace: [] + member_target_assignments: + id: confluent.streams_group.member_target_assignments + name: member_target_assignments + title: Member Target Assignments + methods: + get_kafka_streams_group_member_target_assignments: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1streams-groups~1{group_id}~1members~1{member_id}~1target-assignments/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/member_target_assignments/methods/get_kafka_streams_group_member_target_assignments + insert: [] + update: [] + delete: [] + replace: [] + member_assignment_tasks: + id: confluent.streams_group.member_assignment_tasks + name: member_assignment_tasks + title: Member Assignment Tasks + methods: + list_kafka_streams_group_member_assignment_tasks: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1streams-groups~1{group_id}~1members~1{member_id}~1assignments~1{assignments_type}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/member_assignment_tasks/methods/list_kafka_streams_group_member_assignment_tasks + insert: [] + update: [] + delete: [] + replace: [] + member_target_assignment_tasks: + id: confluent.streams_group.member_target_assignment_tasks + name: member_target_assignment_tasks + title: Member Target Assignment Tasks + methods: + list_kafka_streams_group_member_target_assignment_tasks: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1streams-groups~1{group_id}~1members~1{member_id}~1target-assignments~1{assignments_type}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/member_target_assignment_tasks/methods/list_kafka_streams_group_member_target_assignment_tasks + insert: [] + update: [] + delete: [] + replace: [] + member_assignment_task_partitions: + id: confluent.streams_group.member_assignment_task_partitions + name: member_assignment_task_partitions + title: Member Assignment Task Partitions + methods: + get_kafka_streams_group_member_assignment_task_partitions: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1streams-groups~1{group_id}~1members~1{member_id}~1assignments~1{assignments_type}~1subtopologies~1{subtopology_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/member_assignment_task_partitions/methods/get_kafka_streams_group_member_assignment_task_partitions + insert: [] + update: [] + delete: [] + replace: [] + member_target_assignment_task_partitions: + id: confluent.streams_group.member_target_assignment_task_partitions + name: member_target_assignment_task_partitions + title: Member Target Assignment Task Partitions + methods: + get_kafka_streams_group_member_target_assignment_task_partitions: + operation: + $ref: >- + #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1streams-groups~1{group_id}~1members~1{member_id}~1target-assignments~1{assignments_type}~1subtopologies~1{subtopology_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/member_target_assignment_task_partitions/methods/get_kafka_streams_group_member_target_assignment_task_partitions + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/sts.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/sts.yaml new file mode 100644 index 0000000..3fa2d1e --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/sts.yaml @@ -0,0 +1,572 @@ +openapi: 3.0.0 +info: + title: sts API + description: confluent sts API + version: 1.0.0 +paths: + /sts/v1/oauth2/token: + post: + description: > + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Use this operation to exchange an access token (JWT) issued by an + external identity provider for + + an access token (JWT) issued by Confluent.This enables the use of + external identities + + to access Confluent Cloud APIs. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + description: token exchange request parameters + properties: + api_version: + type: string + enum: + - sts/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TokenExchangeRequest + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + grant_type: + type: string + x-extensible-enum: + - urn:ietf:params:oauth:grant-type:token-exchange + description: > + The grant type. Must be + urn:ietf:params:oauth:grant-type:token-exchange, which + indicates a token exchange. + example: urn:ietf:params:oauth:grant-type:token-exchange + subject_token: + type: string + description: >- + Confluent Cloud only accepts JSON Web Token (JWT) access + tokens from customer identity provider + example: test_jwt_token + identity_pool_id: + type: string + description: > + Identity pool is a group of external identities that are + assigned a certain level of access based on policy + example: pool_1 + subject_token_type: + type: string + x-extensible-enum: + - urn:ietf:params:oauth:token-type:jwt + description: > + An identifier for the type of requested security token. + Supported values + + is urn:ietf:params:oauth:token-type:jwt. + example: urn:ietf:params:oauth:token-type:jwt + requested_token_type: + type: string + x-extensible-enum: + - urn:ietf:params:oauth:token-type:access_token + description: > + An identifier for the type of requested security token. + + Supported values is + urn:ietf:params:oauth:token-type:access_token. + example: urn:ietf:params:oauth:token-type:access_token + expires_in: + type: integer + format: int32 + description: > + The amount of time, in seconds, between the time when the + access token was issued + + and the time when the access token will expire + default: 900 + maximum: 900 + required: + - subject_token + - grant_type + - identity_pool_id + - subject_token_type + - requested_token_type + x-lifecycle-stage: General Availability + x-self-access: true + x-name: sts.v1.OauthToken + operationId: exchangeStsV1OauthToken + summary: Exchange an OAuth Token + tags: + - OAuth Tokens (sts/v1) + responses: + '200': + description: | + access token used to access public control plane api + content: + application/json: + schema: + $ref: '#/components/schemas/sts.v1.TokenExchangeReply' + '400': + $ref: '#/components/responses/BadRequestError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + sts.v1.TokenExchangeRequest: + type: object + description: token exchange request parameters + properties: + api_version: + type: string + enum: + - sts/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TokenExchangeRequest + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + grant_type: + type: string + x-extensible-enum: + - urn:ietf:params:oauth:grant-type:token-exchange + description: > + The grant type. Must be + urn:ietf:params:oauth:grant-type:token-exchange, which indicates a + token exchange. + example: urn:ietf:params:oauth:grant-type:token-exchange + subject_token: + type: string + description: >- + Confluent Cloud only accepts JSON Web Token (JWT) access tokens from + customer identity provider + example: test_jwt_token + identity_pool_id: + type: string + description: > + Identity pool is a group of external identities that are assigned a + certain level of access based on policy + example: pool_1 + subject_token_type: + type: string + x-extensible-enum: + - urn:ietf:params:oauth:token-type:jwt + description: > + An identifier for the type of requested security token. Supported + values + + is urn:ietf:params:oauth:token-type:jwt. + example: urn:ietf:params:oauth:token-type:jwt + requested_token_type: + type: string + x-extensible-enum: + - urn:ietf:params:oauth:token-type:access_token + description: | + An identifier for the type of requested security token. + Supported values is urn:ietf:params:oauth:token-type:access_token. + example: urn:ietf:params:oauth:token-type:access_token + expires_in: + type: integer + format: int32 + description: > + The amount of time, in seconds, between the time when the access + token was issued + + and the time when the access token will expire + default: 900 + maximum: 900 + sts.v1.TokenExchangeReply: + type: object + description: token exchange response + required: + - access_token + - issued_token_type + - token_type + - expires_in + properties: + access_token: + type: string + description: > + An JWT access token, issued by Confluent, in response to the token + exchange request. + + Client application could use the access token to access confluent + public api + issued_token_type: + type: string + x-extensible-enum: + - urn:ietf:params:oauth:token-type:access_token + description: >- + The token type. Always matches the value of requested_token_type + from the request. + example: urn:ietf:params:oauth:token-type:access_token + token_type: + type: string + x-extensible-enum: + - Bearer + description: >- + Indicates the token type value. The only type that Confluent + supports is Bearer + example: Bearer + expires_in: + type: integer + format: int32 + description: The length of time, in seconds, that the access token is valid. + example: 3600 + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + x-stackQL-resources: + oauth_tokens: + id: confluent.sts.oauth_tokens + name: oauth_tokens + title: Oauth Tokens + methods: + exchange_sts_v1_oauth_token: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1sts~1v1~1oauth2~1token/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/tableflow.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/tableflow.yaml new file mode 100644 index 0000000..052f0f9 --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/tableflow.yaml @@ -0,0 +1,5415 @@ +openapi: 3.0.0 +info: + title: tableflow API + description: confluent tableflow API + version: 1.0.0 +paths: + /tableflow/v1/regions: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listTableflowV1Regions + summary: List of Regions + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all regions. + parameters: + - name: cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for cloud. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Regions (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Region. + content: + application/json: + schema: + type: object + description: >- + `Region` objects represent cloud provider regions where + Tableflow can be enabled. + + This API allows you to list all supported Tableflow regions. + + + + ## The Regions Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RegionList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `Region` objects represent cloud provider regions where + Tableflow can be enabled. + + This API allows you to list all supported Tableflow + regions. + + + + ## The Regions Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - Region + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: + - AWS + example: AWS + x-immutable: true + readOnly: true + region: + type: string + description: The cloud service provider region. + example: us-east-2 + x-immutable: true + readOnly: true + required: + - id + - metadata + - cloud + - region + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /tableflow/v1/tableflow-topics: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listTableflowV1TableflowTopics + summary: List of Tableflow Topics + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all tableflow topics. + parameters: + - name: spec.table_formats + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - DELTA + - ICEBERG + description: >- + Filter the results by exact match for spec.table_formats. Pass + multiple times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Filter the results by exact match for spec.kafka_cluster. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Tableflow Topics (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Tableflow Topic. + content: + application/json: + schema: + type: object + description: >- + A Tableflow Topic represents configuration related to a + Tableflow enabled kafka topic + + + + ## The Tableflow Topics Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopicList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + A Tableflow Topic represents configuration related to a + Tableflow enabled kafka topic + + + + ## The Tableflow Topics Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: >- + #/components/schemas/tableflow.v1.TableflowTopicStatus + required: + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createTableflowV1TableflowTopic + summary: Create a Tableflow Topic + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a tableflow topic. + tags: + - Tableflow Topics (tableflow/v1) + security: + - resource-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + A Tableflow Topic represents configuration related to a + Tableflow enabled kafka topic + + + + ## The Tableflow Topics Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + required: + - spec + responses: + '202': + description: A Tableflow Topic is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/tableflow/v1/tableflow-topics/{id} + description: TableflowTopic resource uri + content: + application/json: + schema: + type: object + description: >- + A Tableflow Topic represents configuration related to a + Tableflow enabled kafka topic + + + + ## The Tableflow Topics Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /tableflow/v1/tableflow-topics/{display_name}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getTableflowV1TableflowTopic + summary: Read a Tableflow Topic + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a tableflow topic. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Scope the operation to the given spec.kafka_cluster. + - name: display_name + in: path + required: true + schema: + type: string + description: The name of the Kafka topic for which Tableflow is enabled. + tags: + - Tableflow Topics (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Tableflow Topic. + content: + application/json: + schema: + type: object + description: >- + A Tableflow Topic represents configuration related to a + Tableflow enabled kafka topic + + + + ## The Tableflow Topics Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + required: + - api_version + - kind + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateTableflowV1TableflowTopic + summary: Update a Tableflow Topic + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a tableflow topic. + + parameters: + - name: display_name + in: path + required: true + schema: + type: string + description: The name of the Kafka topic for which Tableflow is enabled. + tags: + - Tableflow Topics (tableflow/v1) + security: + - resource-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + A Tableflow Topic represents configuration related to a + Tableflow enabled kafka topic + + + + ## The Tableflow Topics Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + required: + - spec + responses: + '200': + description: Tableflow Topic. + content: + application/json: + schema: + type: object + description: >- + A Tableflow Topic represents configuration related to a + Tableflow enabled kafka topic + + + + ## The Tableflow Topics Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + required: + - api_version + - kind + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteTableflowV1TableflowTopic + summary: Delete a Tableflow Topic + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a tableflow topic. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Scope the operation to the given spec.kafka_cluster. + - name: display_name + in: path + required: true + schema: + type: string + description: The name of the Kafka topic for which Tableflow is enabled. + tags: + - Tableflow Topics (tableflow/v1) + security: + - resource-api-key: [] + responses: + '204': + description: A Tableflow Topic is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /tableflow/v1/catalog-integrations: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listTableflowV1CatalogIntegrations + summary: List of Catalog Integrations + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all catalog integrations. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Filter the results by exact match for spec.kafka_cluster. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Catalog Integrations (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Catalog Integration. + content: + application/json: + schema: + type: object + description: >- + A Catalog Integration represents configuration related to a + catalog integration + + + + ## The Catalog Integrations Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegrationList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + A Catalog Integration represents configuration related + to a catalog integration + + + + ## The Catalog Integrations Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - CatalogIntegration + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources + must have, which includes all objects users must + create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at + which an object can be addressed. This URL + encodes the service location, API version, and + other particulars necessary to locate the + resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier + (URI) that is globally unique across space and + time. It is represented as a Confluent Resource + Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was + created. It is represented in RFC3339 format and + is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and + is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or + will be) deleted. It is represented in RFC3339 + format and is in UTC. + readOnly: true + type: object + spec: + $ref: >- + #/components/schemas/tableflow.v1.CatalogIntegrationSpec + status: + $ref: >- + #/components/schemas/tableflow.v1.CatalogIntegrationStatus + required: + - id + - metadata + - spec + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createTableflowV1CatalogIntegration + summary: Create a Catalog Integration + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a catalog integration. + tags: + - Catalog Integrations (tableflow/v1) + security: + - resource-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + A Catalog Integration represents configuration related to a + catalog integration + + + + ## The Catalog Integrations Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSpec' + status: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationStatus' + required: + - spec + responses: + '202': + description: A Catalog Integration is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: >- + https://api.confluent.cloud/tableflow/v1/catalog-integrations/{id} + description: CatalogIntegration resource uri + content: + application/json: + schema: + type: object + description: >- + A Catalog Integration represents configuration related to a + catalog integration + + + + ## The Catalog Integrations Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSpec' + status: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationStatus' + required: + - spec + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /tableflow/v1/catalog-integrations/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getTableflowV1CatalogIntegration + summary: Read a Catalog Integration + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a catalog integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Scope the operation to the given spec.kafka_cluster. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the catalog integration. + tags: + - Catalog Integrations (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Catalog Integration. + content: + application/json: + schema: + type: object + description: >- + A Catalog Integration represents configuration related to a + catalog integration + + + + ## The Catalog Integrations Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSpec' + status: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationStatus' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/tableflow.v1.CatalogIntegrationUpdateRequest + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateTableflowV1CatalogIntegration + summary: Update a Catalog Integration + description: >+ + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to update a catalog integration. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the catalog integration. + tags: + - Catalog Integrations (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Catalog Integration. + content: + application/json: + schema: + type: object + description: >- + A Catalog Integration represents configuration related to a + catalog integration + + + + ## The Catalog Integrations Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must + have, which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary + to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: >- + https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) + that is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It + is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last + updated. It is represented in RFC3339 format and is in + UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will + be) deleted. It is represented in RFC3339 format and + is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSpec' + status: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationStatus' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteTableflowV1CatalogIntegration + summary: Delete a Catalog Integration + description: >- + [![General + Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a catalog integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Scope the operation to the given spec.kafka_cluster. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the catalog integration. + tags: + - Catalog Integrations (tableflow/v1) + security: + - resource-api-key: [] + responses: + '204': + description: A Catalog Integration is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + tableflow.v1.RegionList: + type: object + description: >- + `Region` objects represent cloud provider regions where Tableflow can be + enabled. + + This API allows you to list all supported Tableflow regions. + + + + ## The Regions Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RegionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `Region` objects represent cloud provider regions where Tableflow + can be enabled. + + This API allows you to list all supported Tableflow regions. + + + + ## The Regions Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: + - AWS + example: AWS + x-immutable: true + readOnly: true + region: + type: string + description: The cloud service provider region. + example: us-east-2 + x-immutable: true + readOnly: true + required: + - id + - metadata + - cloud + - region + uniqueItems: true + MultipleSearchFilter: + description: Filter a collection by a string search for one or more values + type: array + items: + type: string + tableflow.v1.TableflowTopicList: + type: object + description: >- + A Tableflow Topic represents configuration related to a Tableflow + enabled kafka topic + + + + ## The Tableflow Topics Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopicList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + A Tableflow Topic represents configuration related to a Tableflow + enabled kafka topic + + + + ## The Tableflow Topics Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + required: + - metadata + - spec + - status + uniqueItems: true + tableflow.v1.TableflowTopic: + type: object + description: >- + A Tableflow Topic represents configuration related to a Tableflow + enabled kafka topic + + + + ## The Tableflow Topics Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + tableflow.v1.CatalogIntegrationList: + type: object + description: >- + A Catalog Integration represents configuration related to a catalog + integration + + + + ## The Catalog Integrations Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegrationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + A Catalog Integration represents configuration related to a + catalog integration + + + + ## The Catalog Integrations Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, + which includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an + object can be addressed. This URL encodes the service + location, API version, and other particulars necessary to + locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that + is globally unique across space and time. It is + represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. + It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) + deleted. It is represented in RFC3339 format and is in + UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSpec' + status: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationStatus' + required: + - id + - metadata + - spec + uniqueItems: true + tableflow.v1.CatalogIntegration: + type: object + description: >- + A Catalog Integration represents configuration related to a catalog + integration + + + + ## The Catalog Integrations Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegration + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSpec' + status: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationStatus' + tableflow.v1.CatalogIntegrationUpdateRequest: + type: object + description: The desired state of the Catalog Integration + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegrationUpdateRequest + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + type: object + description: The desired state of the Catalog Integration + required: + - environment + - kafka_cluster + properties: + display_name: + type: string + description: The name of the catalog integration + example: catalog_integration_1 + suspended: + type: boolean + description: Indicates whether the Catalog Integration should be suspended. + example: false + config: + type: object + description: The integration config + discriminator: + propertyName: kind + mapping: + AwsGlue: >- + #/components/schemas/tableflow.v1.CatalogIntegrationAwsGlueUpdateSpec + Snowflake: >- + #/components/schemas/tableflow.v1.CatalogIntegrationSnowflakeUpdateSpec + Unity: >- + #/components/schemas/tableflow.v1.CatalogIntegrationUnityUpdateSpec + required: + - kind + properties: + kind: + type: string + enum: + - AwsGlue + description: The type of the catalog integration. + x-immutable: true + endpoint: + description: >- + The catalog integration connection endpoint for Snowflake + Open Catalog. + type: string + example: https://vuser1_polaris.snowflakecomputing.com/ + client_id: + description: The client ID of the catalog integration. + type: string + client_secret: + description: The client secret of the catalog integration. + type: string + warehouse: + description: Warehouse name of the Snowflake Open Catalog. + type: string + allowed_scope: + description: Allowed scope of the Snowflake Open Catalog. + type: string + workspace_endpoint: + type: string + description: >- + The Databricks workspace URL associated with the Unity + Catalog. + example: https://user1.cloud.databricks.com + catalog_name: + type: string + description: The name of the catalog within Unity Catalog. + environment: + description: The environment to which the target Kafka cluster belongs. + example: + id: env-00000 + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + description: The kafka cluster of the topic for which Tableflow is enabled + example: + id: lkc-00000 + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + tableflow.v1.Region: + type: object + description: >- + `Region` objects represent cloud provider regions where Tableflow can be + enabled. + + This API allows you to list all supported Tableflow regions. + + + + ## The Regions Model + + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can + be addressed. This URL encodes the service location, API + version, and other particulars necessary to locate the resource + at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. + It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: + - AWS + example: AWS + x-immutable: true + readOnly: true + region: + type: string + description: The cloud service provider region. + example: us-east-2 + x-immutable: true + readOnly: true + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: >- + ObjectMeta is metadata that all persisted resources must have, which + includes all objects users must create. + required: + - self + properties: + self: + description: >- + Self is a Uniform Resource Locator (URL) at which an object can be + addressed. This URL encodes the service location, API version, and + other particulars necessary to locate the resource at a point in + time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: >- + Resource Name is a Uniform Resource Identifier (URI) that is + globally unique across space and time. It is represented as a + Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was created. It is + represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was last updated. It is + represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: >- + The date and time at which this object was (or will be) deleted. It + is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + tableflow.v1.TableflowTopicSpec: + type: object + description: The desired state of the Tableflow Topic + properties: + display_name: + type: string + description: The name of the Kafka topic for which Tableflow is enabled. + example: topic_1 + x-immutable: true + suspended: + type: boolean + description: >- + Indicates whether the Tableflow should be suspended. The API allows + setting it only to `false` i.e., to resume the Tableflow. Pausing + the Tableflow on-demand is not currently supported. + example: false + config: + type: object + description: The config for the Tableflow enabled topic + properties: + enable_compaction: + description: >- + This flag determines whether to enable compaction for the + Tableflow enabled topic. + type: boolean + example: true + x-immutable: true + readOnly: true + enable_partitioning: + description: >- + This flag determines whether to enable partitioning for the + Tableflow enabled topic. + type: boolean + example: true + x-immutable: true + readOnly: true + retention_ms: + description: > + The maximum age, in milliseconds, of snapshots (for Iceberg) or + versions (for Delta) + + to retain in the table for the Tableflow-enabled topic + (snapshot/version expiration). + + + The default value is "604800000" milliseconds (equivalent to 7 + days). + + + The minimum allowed value is "86400000" milliseconds (equivalent + to 24 hours). + type: string + format: int64 + example: '7776000000' + data_retention_ms: + description: > + The maximum age, in milliseconds, of data to retain in the table + for the Tableflow-enabled topic. + + + The minimum allowed non-zero value is "2592000000" milliseconds + (equivalent to 30 days). + + + Set to "0" to disable data retention (keep all data + indefinitely). + type: string + format: int64 + example: '2592000000' + record_failure_strategy: + description: > + The strategy to handle record failures in the Tableflow enabled + topic during materialization. + + + For `SKIP`, we skip the bad records and move to the next record, + + + and for `SUSPEND`, we suspend the materialization of the topic. + type: string + x-extensible-enum: + - SUSPEND + - SKIP + default: SUSPEND + deprecated: true + error_handling: + type: object + description: > + The error mode to handle record failures in the Tableflow + enabled topic during materialization. + + + for `SKIP`, we skip the bad records and move to the next record, + + + for `SUSPEND`, we suspend the materialization of the topic, + + + and for `LOG`, we log the bad records to the DLQ and continue + processing the rest of the records. + discriminator: + propertyName: mode + mapping: + SUSPEND: '#/components/schemas/tableflow.v1.ErrorHandlingSuspend' + SKIP: '#/components/schemas/tableflow.v1.ErrorHandlingSkip' + LOG: '#/components/schemas/tableflow.v1.ErrorHandlingLog' + properties: + mode: + type: string + enum: + - SUSPEND + description: > + The error handling mode for the Tableflow enabled topic. + + + In this mode, the materialization of the topic is suspended + in case of record failures. + target: + type: string + description: > + The topic to which the bad records will be logged in case of + `LOG` error handling mode. + + + Creates the topic if it doesn't already exist; otherwise, + the operation is idempotent and no action is taken. + + + Default topic is `error_log`. + default: error_log + required: + - mode + storage: + type: object + description: The storage config + discriminator: + propertyName: kind + mapping: + ByobAws: '#/components/schemas/tableflow.v1.ByobAwsSpec' + Managed: '#/components/schemas/tableflow.v1.ManagedStorageSpec' + AzureDataLakeStorageGen2: '#/components/schemas/tableflow.v1.AzureAdlsSpec' + x-immutable: true + required: + - kind + - bucket_name + - provider_integration_id + - storage_account_name + - container_name + properties: + kind: + type: string + enum: + - ByobAws + description: | + The storage type + x-immutable: true + bucket_name: + description: Bucket name + type: string + example: bucket_1 + x-immutable: true + bucket_region: + description: Bucket region + type: string + example: us-east-1 + x-immutable: true + readOnly: true + provider_integration_id: + type: string + description: The provider integration id + example: cspi-stgce89r7 + x-immutable: true + table_path: + type: string + description: >- + The current storage path where the data and metadata is stored + for this table + example: >- + s3://dummy-bucket-name-1/10011010/11101100/org-1/env-2/lkc-3/v1/tableId + readOnly: true + storage_account_name: + description: Storage Account Name + type: string + example: confluentstorage1 + x-immutable: true + container_name: + description: Container name + type: string + example: container-tableflow + x-immutable: true + storage_region: + description: Storage account region + type: string + example: centralus + readOnly: true + table_formats: + type: array + description: | + The supported table formats for the Tableflow-enabled topic. + items: + type: string + x-extensible-enum: + - DELTA + - ICEBERG + minItems: 1 + uniqueItems: true + example: + - DELTA + default: + - ICEBERG + environment: + description: The environment to which the target Kafka cluster belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + description: The kafka cluster of the topic for which Tableflow is enabled + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: false + x-enable-listmeta: true + x-enable-objectmeta: true + tableflow.v1.TableflowTopicStatus: + type: object + required: + - write_mode + description: The status of the Tableflow Topic + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - RUNNING + - FAILED + description: | + The lifecycle phase of the Tableflow: + + PENDING: Tableflow setup is pending; + + RUNNING: Tableflow is currently running; + + FAILED: Tableflow failed + example: PENDING + readOnly: true + error_message: + type: string + description: Displayable error message if Tableflow topic is in an error state + example: Could not enable catalog integration + readOnly: true + catalog_sync_statuses: + type: array + description: > + List of associated catalogs and their synchronization statuses for + this Tableflow topic. + items: + $ref: '#/components/schemas/tableflow.v1.CatalogSyncStatus' + readOnly: true + failing_table_formats: + type: array + items: + type: object + properties: + format: + type: string + description: The name of the table format (e.g., DELTA, ICEBERG). + x-extensible-enum: + - DELTA + - ICEBERG + error_message: + type: string + description: The error message for the failing table format. + required: + - format + - error_message + description: > + List of failing table formats for the Tableflow-enabled topic, + including error details. + example: + - format: ICEBERG + error_message: Schema validation failed + - format: DELTA + error_message: Connection timeout + readOnly: true + write_mode: + type: string + description: > + The write mode for the Tableflow-enabled topic, determining how data + is written to the table. + x-extensible-enum: + - APPEND + - UPSERT + - UPSERT_HISTORY + example: APPEND + readOnly: true + readOnly: true + tableflow.v1.CatalogIntegrationSpec: + type: object + description: The desired state of the Catalog Integration + properties: + display_name: + type: string + description: The name of the catalog integration + example: catalog_integration_1 + suspended: + type: boolean + description: >- + Indicates whether the Catalog Integration should be suspended. The + API allows setting it only to `false` i.e., to resume the Catalog + Integration. Pausing the Catalog Integration on-demand is not + currently supported. + example: false + config: + type: object + description: The integration config + discriminator: + propertyName: kind + mapping: + AwsGlue: '#/components/schemas/tableflow.v1.CatalogIntegrationAwsGlueSpec' + Snowflake: >- + #/components/schemas/tableflow.v1.CatalogIntegrationSnowflakeSpec + Unity: '#/components/schemas/tableflow.v1.CatalogIntegrationUnitySpec' + required: + - kind + - provider_integration_id + - endpoint + - client_id + - client_secret + - warehouse + - allowed_scope + - workspace_endpoint + - catalog_name + properties: + kind: + type: string + enum: + - AwsGlue + description: The type of the catalog integration. + x-immutable: true + provider_integration_id: + type: string + description: The provider integration id. + example: cspi-stgce89r7 + x-immutable: true + endpoint: + description: > + The catalog integration connection endpoint for Snowflake Open + Catalog. + type: string + example: https://vuser1_polaris.snowflakecomputing.com/ + client_id: + description: The client ID of the catalog integration. + type: string + client_secret: + description: The client secret of the catalog integration. + type: string + warehouse: + description: Warehouse name of the Snowflake Open Catalog. + type: string + allowed_scope: + description: Allowed scope of the Snowflake Open Catalog. + type: string + workspace_endpoint: + type: string + description: The Databricks workspace URL associated with the Unity Catalog. + example: https://user1.cloud.databricks.com + catalog_name: + type: string + description: The name of the catalog within Unity Catalog. + environment: + description: The environment to which the target Kafka cluster belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + description: The kafka cluster of the topic for which Tableflow is enabled + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + tableflow.v1.CatalogIntegrationStatus: + description: The status of the Catalog Integration + type: object + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - CONNECTED + - FAILED + description: | + The lifecycle phase of the catalog integration: + + PENDING: sync to catalog integration is pending; + + CONNECTED: catalog integration is connected and syncing; + + FAILED: catalog integration failed. + example: CONNECTED + readOnly: true + error_message: + type: string + description: >- + Displayable error message if catalog integration is in a failed + state. + example: Could not enable catalog integration + readOnly: true + last_sync_at: + type: string + description: > + The date and time at which the catalog was last synced. It is + represented in RFC3339 format and is in UTC. + readOnly: true + readOnly: true + tableflow.v1.CatalogIntegrationUpdateSpec: + type: object + description: The desired state of the Catalog Integration + required: + - environment + - kafka_cluster + properties: + display_name: + type: string + description: The name of the catalog integration + example: catalog_integration_1 + suspended: + type: boolean + description: Indicates whether the Catalog Integration should be suspended. + example: false + config: + type: object + description: The integration config + discriminator: + propertyName: kind + mapping: + AwsGlue: >- + #/components/schemas/tableflow.v1.CatalogIntegrationAwsGlueUpdateSpec + Snowflake: >- + #/components/schemas/tableflow.v1.CatalogIntegrationSnowflakeUpdateSpec + Unity: >- + #/components/schemas/tableflow.v1.CatalogIntegrationUnityUpdateSpec + required: + - kind + properties: + kind: + type: string + enum: + - AwsGlue + description: The type of the catalog integration. + x-immutable: true + endpoint: + description: >- + The catalog integration connection endpoint for Snowflake Open + Catalog. + type: string + example: https://vuser1_polaris.snowflakecomputing.com/ + client_id: + description: The client ID of the catalog integration. + type: string + client_secret: + description: The client secret of the catalog integration. + type: string + warehouse: + description: Warehouse name of the Snowflake Open Catalog. + type: string + allowed_scope: + description: Allowed scope of the Snowflake Open Catalog. + type: string + workspace_endpoint: + type: string + description: The Databricks workspace URL associated with the Unity Catalog. + example: https://user1.cloud.databricks.com + catalog_name: + type: string + description: The name of the catalog within Unity Catalog. + environment: + description: The environment to which the target Kafka cluster belongs. + example: + id: env-00000 + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + description: The kafka cluster of the topic for which Tableflow is enabled + example: + id: lkc-00000 + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + tableflow.v1.TableFlowTopicConfigsSpec: + type: object + description: The configs for the Tableflow enabled topic + properties: + enable_compaction: + description: >- + This flag determines whether to enable compaction for the Tableflow + enabled topic. + type: boolean + example: true + x-immutable: true + readOnly: true + enable_partitioning: + description: >- + This flag determines whether to enable partitioning for the + Tableflow enabled topic. + type: boolean + example: true + x-immutable: true + readOnly: true + retention_ms: + description: > + The maximum age, in milliseconds, of snapshots (for Iceberg) or + versions (for Delta) + + to retain in the table for the Tableflow-enabled topic + (snapshot/version expiration). + + + The default value is "604800000" milliseconds (equivalent to 7 + days). + + + The minimum allowed value is "86400000" milliseconds (equivalent to + 24 hours). + type: string + format: int64 + example: '7776000000' + data_retention_ms: + description: > + The maximum age, in milliseconds, of data to retain in the table for + the Tableflow-enabled topic. + + + The minimum allowed non-zero value is "2592000000" milliseconds + (equivalent to 30 days). + + + Set to "0" to disable data retention (keep all data indefinitely). + type: string + format: int64 + example: '2592000000' + record_failure_strategy: + description: > + The strategy to handle record failures in the Tableflow enabled + topic during materialization. + + + For `SKIP`, we skip the bad records and move to the next record, + + + and for `SUSPEND`, we suspend the materialization of the topic. + type: string + x-extensible-enum: + - SUSPEND + - SKIP + default: SUSPEND + deprecated: true + error_handling: + type: object + description: > + The error mode to handle record failures in the Tableflow enabled + topic during materialization. + + + for `SKIP`, we skip the bad records and move to the next record, + + + for `SUSPEND`, we suspend the materialization of the topic, + + + and for `LOG`, we log the bad records to the DLQ and continue + processing the rest of the records. + discriminator: + propertyName: mode + mapping: + SUSPEND: '#/components/schemas/tableflow.v1.ErrorHandlingSuspend' + SKIP: '#/components/schemas/tableflow.v1.ErrorHandlingSkip' + LOG: '#/components/schemas/tableflow.v1.ErrorHandlingLog' + properties: + mode: + type: string + enum: + - SUSPEND + description: > + The error handling mode for the Tableflow enabled topic. + + + In this mode, the materialization of the topic is suspended in + case of record failures. + target: + type: string + description: > + The topic to which the bad records will be logged in case of + `LOG` error handling mode. + + + Creates the topic if it doesn't already exist; otherwise, the + operation is idempotent and no action is taken. + + + Default topic is `error_log`. + default: error_log + required: + - mode + tableflow.v1.ByobAwsSpec: + type: object + description: The Tableflow storage config for BYOB enabled topic in AWS + required: + - kind + - bucket_name + - provider_integration_id + properties: + kind: + type: string + enum: + - ByobAws + description: | + The storage type + x-immutable: true + bucket_name: + description: Bucket name + type: string + example: bucket_1 + x-immutable: true + bucket_region: + description: Bucket region + type: string + example: us-east-1 + x-immutable: true + readOnly: true + provider_integration_id: + type: string + description: The provider integration id + example: cspi-stgce89r7 + x-immutable: true + table_path: + type: string + description: >- + The current storage path where the data and metadata is stored for + this table + example: >- + s3://dummy-bucket-name-1/10011010/11101100/org-1/env-2/lkc-3/v1/tableId + readOnly: true + tableflow.v1.ManagedStorageSpec: + type: object + description: The storage config for confluent managed Tableflow enabled topic. + required: + - kind + properties: + kind: + type: string + enum: + - Managed + description: | + The storage type. + x-immutable: true + table_path: + type: string + description: >- + The current storage path where the data and metadata is stored for + this table + example: >- + s3://dummy-bucket-name-1/10011010/11101100/org-1/env-2/lkc-3/v1/tableId + readOnly: true + tableflow.v1.AzureAdlsSpec: + type: object + description: >- + The Tableflow storage config for customer-owned Azure Data Lake Storage + Gen2 + required: + - kind + - storage_account_name + - container_name + - provider_integration_id + properties: + kind: + type: string + enum: + - AzureDataLakeStorageGen2 + description: | + The storage type. + x-immutable: true + storage_account_name: + description: Storage Account Name + type: string + example: confluentstorage1 + x-immutable: true + container_name: + description: Container name + type: string + example: container-tableflow + x-immutable: true + storage_region: + description: Storage account region + type: string + example: centralus + readOnly: true + provider_integration_id: + type: string + description: The provider integration id + example: cspi-6nxn5 + x-immutable: true + table_path: + type: string + description: >- + The current storage path where the data and metadata is stored for + this table + example: >- + abfss://container@account.dfs.core.windows.net/10011010/11101100/org/env/lkc/v1/tableId + readOnly: true + GlobalObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + EnvScopedObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + tableflow.v1.CatalogSyncStatus: + type: object + description: The synchronization status of an external catalog for a Tableflow topic + properties: + catalog_integration_id: + type: string + description: The ID of the catalog integration + example: tci-12345 + catalog_type: + type: string + description: The type of the external catalog + x-extensible-enum: + - AWS_GLUE + - SNOWFLAKE + - UNITY + example: AWS_GLUE + sync_status: + type: string + description: | + The current synchronization status: + + PENDING: sync is pending; + + SYNCED: successfully synced; + + FAILED: sync failed; + + DISCONNECTED: catalog integration is disconnected. + x-extensible-enum: + - PENDING + - SYNCED + - FAILED + - DISCONNECTED + example: SYNCED + error_message: + type: string + nullable: true + description: > + Error message if the sync failed. This field is only present when + `sync_status` is `FAILED`. + example: 'Failed to connect to catalog: authentication error' + tableflow.v1.CatalogIntegrationAwsGlueSpec: + type: object + description: The catalog integration Glue connection config. + required: + - kind + - provider_integration_id + properties: + kind: + type: string + enum: + - AwsGlue + description: The type of the catalog integration. + x-immutable: true + provider_integration_id: + type: string + description: The provider integration id. + example: cspi-stgce89r7 + x-immutable: true + tableflow.v1.CatalogIntegrationSnowflakeSpec: + type: object + description: The catalog integration connection config for Snowflake Open Catalog. + required: + - kind + - endpoint + - client_id + - client_secret + - warehouse + - allowed_scope + properties: + kind: + type: string + enum: + - Snowflake + description: The type of the catalog integration. + endpoint: + description: > + The catalog integration connection endpoint for Snowflake Open + Catalog. + type: string + example: https://vuser1_polaris.snowflakecomputing.com/ + client_id: + description: The client ID of the catalog integration. + type: string + client_secret: + description: The client secret of the catalog integration. + type: string + warehouse: + description: Warehouse name of the Snowflake Open Catalog. + type: string + allowed_scope: + description: Allowed scope of the Snowflake Open Catalog. + type: string + tableflow.v1.CatalogIntegrationUnitySpec: + type: object + description: The catalog integration connection config for Unity Catalog. + required: + - kind + - workspace_endpoint + - catalog_name + - client_id + - client_secret + properties: + kind: + type: string + enum: + - Unity + description: The type of the catalog integration. + workspace_endpoint: + type: string + description: The Databricks workspace URL associated with the Unity Catalog. + example: https://user1.cloud.databricks.com + catalog_name: + type: string + description: The name of the catalog within Unity Catalog. + client_id: + type: string + description: The OAuth client ID used to authenticate with the Unity Catalog. + client_secret: + type: string + description: >- + The OAuth client secret used for authentication with the Unity + Catalog. + tableflow.v1.CatalogIntegrationAwsGlueUpdateSpec: + type: object + description: The catalog integration Glue connection config for update operations. + required: + - kind + properties: + kind: + type: string + enum: + - AwsGlue + description: The type of the catalog integration. + x-immutable: true + tableflow.v1.CatalogIntegrationSnowflakeUpdateSpec: + type: object + description: >- + The catalog integration connection config for Snowflake Open Catalog + (update operations). + required: + - kind + properties: + kind: + type: string + enum: + - Snowflake + description: The type of the catalog integration. + endpoint: + description: >- + The catalog integration connection endpoint for Snowflake Open + Catalog. + type: string + example: https://vuser1_polaris.snowflakecomputing.com/ + client_id: + description: The client ID of the catalog integration. + type: string + client_secret: + description: The client secret of the catalog integration. + type: string + warehouse: + description: Warehouse name of the Snowflake Open Catalog. + type: string + allowed_scope: + description: Allowed scope of the Snowflake Open Catalog. + type: string + tableflow.v1.CatalogIntegrationUnityUpdateSpec: + type: object + description: The catalog integration connection config for Unity Catalog. + required: + - kind + properties: + kind: + type: string + enum: + - Unity + description: The type of the catalog integration. + workspace_endpoint: + type: string + description: The Databricks workspace URL associated with the Unity Catalog. + example: https://user1.cloud.databricks.com + catalog_name: + type: string + description: The name of the catalog within Unity Catalog. + client_id: + type: string + description: The OAuth client ID used to authenticate with the Unity Catalog. + client_secret: + type: string + description: >- + The OAuth client secret used for authentication with the Unity + Catalog. + tableflow.v1.ErrorHandlingSuspend: + type: object + description: | + Configuration for the `SUSPEND` error handling mode. + properties: + mode: + type: string + enum: + - SUSPEND + description: > + The error handling mode for the Tableflow enabled topic. + + + In this mode, the materialization of the topic is suspended in case + of record failures. + required: + - mode + tableflow.v1.ErrorHandlingSkip: + type: object + description: | + Configuration for the `SKIP` error handling mode. + properties: + mode: + type: string + enum: + - SKIP + description: > + The error handling mode for the Tableflow enabled topic. + + + In this mode, the bad records are skipped and the materialization + continues with the next record. + required: + - mode + tableflow.v1.ErrorHandlingLog: + type: object + description: | + Configuration for the `LOG` error handling mode. + properties: + mode: + type: string + enum: + - LOG + description: > + The error handling mode for the Tableflow enabled topic. + + + In this mode, the bad records are logged to a dead-letter queue + (DLQ) topic and the + + + materialization continues with the next record. + target: + type: string + description: > + The topic to which the bad records will be logged in case of `LOG` + error handling mode. + + + Creates the topic if it doesn't already exist; otherwise, the + operation is idempotent and no action is taken. + + + Default topic is `error_log`. + default: error_log + required: + - mode + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + x-stackQL-resources: + regions: + id: confluent.tableflow.regions + name: regions + title: Regions + methods: + list_tableflow_v1_regions: + operation: + $ref: '#/paths/~1tableflow~1v1~1regions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/regions/methods/list_tableflow_v1_regions + insert: [] + update: [] + delete: [] + replace: [] + topics: + id: confluent.tableflow.topics + name: topics + title: Topics + methods: + list_tableflow_v1_tableflow_topics: + operation: + $ref: '#/paths/~1tableflow~1v1~1tableflow-topics/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_tableflow_v1_tableflow_topic: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tableflow~1v1~1tableflow-topics/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_tableflow_v1_tableflow_topic: + operation: + $ref: '#/paths/~1tableflow~1v1~1tableflow-topics~1{display_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_tableflow_v1_tableflow_topic: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tableflow~1v1~1tableflow-topics~1{display_name}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_tableflow_v1_tableflow_topic: + operation: + $ref: '#/paths/~1tableflow~1v1~1tableflow-topics~1{display_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/topics/methods/get_tableflow_v1_tableflow_topic + - $ref: >- + #/components/x-stackQL-resources/topics/methods/list_tableflow_v1_tableflow_topics + insert: + - $ref: >- + #/components/x-stackQL-resources/topics/methods/create_tableflow_v1_tableflow_topic + update: + - $ref: >- + #/components/x-stackQL-resources/topics/methods/update_tableflow_v1_tableflow_topic + delete: + - $ref: >- + #/components/x-stackQL-resources/topics/methods/delete_tableflow_v1_tableflow_topic + replace: [] + catalog_integrations: + id: confluent.tableflow.catalog_integrations + name: catalog_integrations + title: Catalog Integrations + methods: + list_tableflow_v1_catalog_integrations: + operation: + $ref: '#/paths/~1tableflow~1v1~1catalog-integrations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_tableflow_v1_catalog_integration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tableflow~1v1~1catalog-integrations/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_tableflow_v1_catalog_integration: + operation: + $ref: '#/paths/~1tableflow~1v1~1catalog-integrations~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_tableflow_v1_catalog_integration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tableflow~1v1~1catalog-integrations~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_tableflow_v1_catalog_integration: + operation: + $ref: '#/paths/~1tableflow~1v1~1catalog-integrations~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/catalog_integrations/methods/get_tableflow_v1_catalog_integration + - $ref: >- + #/components/x-stackQL-resources/catalog_integrations/methods/list_tableflow_v1_catalog_integrations + insert: + - $ref: >- + #/components/x-stackQL-resources/catalog_integrations/methods/create_tableflow_v1_catalog_integration + update: + - $ref: >- + #/components/x-stackQL-resources/catalog_integrations/methods/update_tableflow_v1_catalog_integration + delete: + - $ref: >- + #/components/x-stackQL-resources/catalog_integrations/methods/delete_tableflow_v1_catalog_integration + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/usm.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/usm.yaml new file mode 100644 index 0000000..5460711 --- /dev/null +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/usm.yaml @@ -0,0 +1,3157 @@ +openapi: 3.0.0 +info: + title: usm API + description: confluent usm API + version: 1.0.0 +paths: + /usm/v1/kafka-clusters: + get: + x-lifecycle-stage: Preview + x-self-access: true + operationId: listUsmV1KafkaClusters + summary: List of Kafka Clusters + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all kafka clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Kafka Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Kafka Cluster. + content: + application/json: + schema: + type: object + description: >- + `KafkaCluster` object represent Confluent Platform Kafka + clusters registered with Confluent Cloud. + + The API allows you to create and delete KafkaCluster. + + + + ## The Kafka Clusters Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaClusterList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `KafkaCluster` object represent Confluent Platform Kafka + clusters registered with Confluent Cloud. + + The API allows you to create and delete KafkaCluster. + + + + ## The Kafka Clusters Model + + + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - KafkaCluster + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + description: >- + A human-readable name for the Confluent Platform + Kafka cluster. + example: My-Prod-CP-Cluster + confluent_platform_kafka_cluster_id: + type: string + description: >- + The unique identifier of the Kafka cluster within + the Confluent Platform environment. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: >- + The cloud service provider where the metadata for + the Kafka Cluster should be stored. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: >- + The home region of the Confluent Platform Kafka + cluster where the metadata should be stored. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: >- + Environment of the referred resource, if + env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - display_name + - confluent_platform_kafka_cluster_id + - cloud + - region + - environment + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Preview + x-self-access: true + operationId: createUsmV1KafkaCluster + summary: Create a Kafka Cluster + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a kafka cluster. + tags: + - Kafka Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `KafkaCluster` object represent Confluent Platform Kafka + clusters registered with Confluent Cloud. + + The API allows you to create and delete KafkaCluster. + + + + ## The Kafka Clusters Model + + + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaCluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + description: >- + A human-readable name for the Confluent Platform Kafka + cluster. + example: My-Prod-CP-Cluster + confluent_platform_kafka_cluster_id: + type: string + description: >- + The unique identifier of the Kafka cluster within the + Confluent Platform environment. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: >- + The cloud service provider where the metadata for the Kafka + Cluster should be stored. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: >- + The home region of the Confluent Platform Kafka cluster + where the metadata should be stored. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - display_name + - confluent_platform_kafka_cluster_id + - cloud + - region + - environment + responses: + '201': + description: A Kafka Cluster was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/usm/v1/kafka-clusters/{id} + description: KafkaCluster resource uri + content: + application/json: + schema: + type: object + description: >- + `KafkaCluster` object represent Confluent Platform Kafka + clusters registered with Confluent Cloud. + + The API allows you to create and delete KafkaCluster. + + + + ## The Kafka Clusters Model + + + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaCluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + description: >- + A human-readable name for the Confluent Platform Kafka + cluster. + example: My-Prod-CP-Cluster + confluent_platform_kafka_cluster_id: + type: string + description: >- + The unique identifier of the Kafka cluster within the + Confluent Platform environment. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: >- + The cloud service provider where the metadata for the + Kafka Cluster should be stored. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: >- + The home region of the Confluent Platform Kafka cluster + where the metadata should be stored. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - display_name + - confluent_platform_kafka_cluster_id + - cloud + - region + - environment + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Preview + x-self-access: true + /usm/v1/kafka-clusters/{id}: + get: + x-lifecycle-stage: Preview + x-self-access: true + operationId: getUsmV1KafkaCluster + summary: Read a Kafka Cluster + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a kafka cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the kafka cluster. + tags: + - Kafka Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Kafka Cluster. + content: + application/json: + schema: + type: object + description: >- + `KafkaCluster` object represent Confluent Platform Kafka + clusters registered with Confluent Cloud. + + The API allows you to create and delete KafkaCluster. + + + + ## The Kafka Clusters Model + + + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaCluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + description: >- + A human-readable name for the Confluent Platform Kafka + cluster. + example: My-Prod-CP-Cluster + confluent_platform_kafka_cluster_id: + type: string + description: >- + The unique identifier of the Kafka cluster within the + Confluent Platform environment. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: >- + The cloud service provider where the metadata for the + Kafka Cluster should be stored. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: >- + The home region of the Confluent Platform Kafka cluster + where the metadata should be stored. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - display_name + - confluent_platform_kafka_cluster_id + - cloud + - region + - environment + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Preview + x-self-access: true + operationId: deleteUsmV1KafkaCluster + summary: Delete a Kafka Cluster + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a kafka cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the kafka cluster. + tags: + - Kafka Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Kafka Cluster is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Preview + x-self-access: true + /usm/v1/connect-clusters: + get: + x-lifecycle-stage: Preview + x-self-access: true + operationId: listUsmV1ConnectClusters + summary: List of Connect Clusters + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Retrieve a sorted, filtered, paginated list of all connect clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Connect Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connect Cluster. + content: + application/json: + schema: + type: object + description: >- + `ConnectCluster` object represent Confluent Platform Connect + clusters registered with Confluent Cloud. + + The API allows you to create and delete ConnectCluster. + + + + ## The Connect Clusters Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectClusterList + metadata: + type: object + description: >- + ListMeta describes metadata that resource collections may + have + properties: + first: + description: >- + A link to the first page of results. If a response + does not contain a first link, then direct navigation + to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does + not contain a last link, then direct navigation to the + last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response + does not contain a prev link, then either there is no + previous data or backwards traversal through the + result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does + not contain a next link, then there is no more data + available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This + response may be paginated and have a smaller number of + records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. + Each entry in the array is a separate resource. + items: + type: object + description: >- + `ConnectCluster` object represent Confluent Platform + Connect clusters registered with Confluent Cloud. + + The API allows you to create and delete ConnectCluster. + + + + ## The Connect Clusters Model + + + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: >- + Kind defines the object this REST resource + represents. + readOnly: true + enum: + - ConnectCluster + id: + description: >- + ID is the "natural identifier" for an object within + its scope/namespace; it is normally unique across + time but not space. That is, you can assume that the + ID will not be reclaimed and reused after an object + is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same + `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + confluent_platform_connect_cluster_id: + type: string + description: >- + The unique identifier of the Connect cluster within + the Confluent Platform environment. + example: connect-group-xyz123 + x-immutable: true + kafka_cluster_id: + type: string + description: > + The unique identifier of the metadata Kafka cluster + for the Connect Cluster. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: > + The cloud service provider where the metadata for + the Connect Cluster should be stored. + + This field is optional. If provided, 'region' must + also be provided. + + If neither 'cloud' nor 'region' are provided, the + cloud provider of the associated + + metadata Kafka cluster (identified by + 'kafka_cluster_id') will be used as a fallback. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: > + The home region of the Confluent Platform Connect + cluster where the metadata should be stored. + + This field is optional. If provided, 'cloud' must + also be provided. + + If neither 'cloud' nor 'region' are provided, the + home region of the associated + + metadata Kafka cluster (identified by + 'kafka_cluster_id') will be used as a fallback. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: >- + Environment of the referred resource, if + env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: >- + API URL for accessing or modifying the referred + object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - confluent_platform_connect_cluster_id + - kafka_cluster_id + - environment + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Preview + x-self-access: true + operationId: createUsmV1ConnectCluster + summary: Create a Connect Cluster + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to create a connect cluster. + tags: + - Connect Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + `ConnectCluster` object represent Confluent Platform Connect + clusters registered with Confluent Cloud. + + The API allows you to create and delete ConnectCluster. + + + + ## The Connect Clusters Model + + + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectCluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + confluent_platform_connect_cluster_id: + type: string + description: >- + The unique identifier of the Connect cluster within the + Confluent Platform environment. + example: connect-group-xyz123 + x-immutable: true + kafka_cluster_id: + type: string + description: > + The unique identifier of the metadata Kafka cluster for the + Connect Cluster. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: > + The cloud service provider where the metadata for the + Connect Cluster should be stored. + + This field is optional. If provided, 'region' must also be + provided. + + If neither 'cloud' nor 'region' are provided, the cloud + provider of the associated + + metadata Kafka cluster (identified by 'kafka_cluster_id') + will be used as a fallback. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: > + The home region of the Confluent Platform Connect cluster + where the metadata should be stored. + + This field is optional. If provided, 'cloud' must also be + provided. + + If neither 'cloud' nor 'region' are provided, the home + region of the associated + + metadata Kafka cluster (identified by 'kafka_cluster_id') + will be used as a fallback. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - confluent_platform_connect_cluster_id + - kafka_cluster_id + - environment + responses: + '201': + description: A Connect Cluster was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/usm/v1/connect-clusters/{id} + description: ConnectCluster resource uri + content: + application/json: + schema: + type: object + description: >- + `ConnectCluster` object represent Confluent Platform Connect + clusters registered with Confluent Cloud. + + The API allows you to create and delete ConnectCluster. + + + + ## The Connect Clusters Model + + + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectCluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + confluent_platform_connect_cluster_id: + type: string + description: >- + The unique identifier of the Connect cluster within the + Confluent Platform environment. + example: connect-group-xyz123 + x-immutable: true + kafka_cluster_id: + type: string + description: > + The unique identifier of the metadata Kafka cluster for + the Connect Cluster. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: > + The cloud service provider where the metadata for the + Connect Cluster should be stored. + + This field is optional. If provided, 'region' must also be + provided. + + If neither 'cloud' nor 'region' are provided, the cloud + provider of the associated + + metadata Kafka cluster (identified by 'kafka_cluster_id') + will be used as a fallback. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: > + The home region of the Confluent Platform Connect cluster + where the metadata should be stored. + + This field is optional. If provided, 'cloud' must also be + provided. + + If neither 'cloud' nor 'region' are provided, the home + region of the associated + + metadata Kafka cluster (identified by 'kafka_cluster_id') + will be used as a fallback. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - confluent_platform_connect_cluster_id + - kafka_cluster_id + - environment + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Preview + x-self-access: true + /usm/v1/connect-clusters/{id}: + get: + x-lifecycle-stage: Preview + x-self-access: true + operationId: getUsmV1ConnectCluster + summary: Read a Connect Cluster + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to read a connect cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the connect cluster. + tags: + - Connect Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connect Cluster. + content: + application/json: + schema: + type: object + description: >- + `ConnectCluster` object represent Confluent Platform Connect + clusters registered with Confluent Cloud. + + The API allows you to create and delete ConnectCluster. + + + + ## The Connect Clusters Model + + + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this + representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectCluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` + or objects of the same `kind` within a different + scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + confluent_platform_connect_cluster_id: + type: string + description: >- + The unique identifier of the Connect cluster within the + Confluent Platform environment. + example: connect-group-xyz123 + x-immutable: true + kafka_cluster_id: + type: string + description: > + The unique identifier of the metadata Kafka cluster for + the Connect Cluster. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: > + The cloud service provider where the metadata for the + Connect Cluster should be stored. + + This field is optional. If provided, 'region' must also be + provided. + + If neither 'cloud' nor 'region' are provided, the cloud + provider of the associated + + metadata Kafka cluster (identified by 'kafka_cluster_id') + will be used as a fallback. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: > + The home region of the Confluent Platform Connect cluster + where the metadata should be stored. + + This field is optional. If provided, 'cloud' must also be + provided. + + If neither 'cloud' nor 'region' are provided, the home + region of the associated + + metadata Kafka cluster (identified by 'kafka_cluster_id') + will be used as a fallback. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - confluent_platform_connect_cluster_id + - kafka_cluster_id + - environment + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Preview + x-self-access: true + operationId: deleteUsmV1ConnectCluster + summary: Delete a Connect Cluster + description: >- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + + Make a request to delete a connect cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the connect cluster. + tags: + - Connect Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Connect Cluster is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: >- + The number of requests remaining in the current rate limit + window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to + avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Preview + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + usm.v1.KafkaClusterList: + type: object + description: >- + `KafkaCluster` object represent Confluent Platform Kafka clusters + registered with Confluent Cloud. + + The API allows you to create and delete KafkaCluster. + + + + ## The Kafka Clusters Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `KafkaCluster` object represent Confluent Platform Kafka clusters + registered with Confluent Cloud. + + The API allows you to create and delete KafkaCluster. + + + + ## The Kafka Clusters Model + + + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaCluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + description: >- + A human-readable name for the Confluent Platform Kafka + cluster. + example: My-Prod-CP-Cluster + confluent_platform_kafka_cluster_id: + type: string + description: >- + The unique identifier of the Kafka cluster within the + Confluent Platform environment. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: >- + The cloud service provider where the metadata for the Kafka + Cluster should be stored. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: >- + The home region of the Confluent Platform Kafka cluster where + the metadata should be stored. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - display_name + - confluent_platform_kafka_cluster_id + - cloud + - region + - environment + uniqueItems: true + usm.v1.KafkaCluster: + type: object + description: >- + `KafkaCluster` object represent Confluent Platform Kafka clusters + registered with Confluent Cloud. + + The API allows you to create and delete KafkaCluster. + + + + ## The Kafka Clusters Model + + + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaCluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + description: A human-readable name for the Confluent Platform Kafka cluster. + example: My-Prod-CP-Cluster + confluent_platform_kafka_cluster_id: + type: string + description: >- + The unique identifier of the Kafka cluster within the Confluent + Platform environment. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: >- + The cloud service provider where the metadata for the Kafka Cluster + should be stored. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: >- + The home region of the Confluent Platform Kafka cluster where the + metadata should be stored. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + usm.v1.ConnectClusterList: + type: object + description: >- + `ConnectCluster` object represent Confluent Platform Connect clusters + registered with Confluent Cloud. + + The API allows you to create and delete ConnectCluster. + + + + ## The Connect Clusters Model + + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not + contain a first link, then direct navigation to the first page + is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not + contain a last link, then direct navigation to the last page is + not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not + contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: >- + A data property that contains an array of resource items. Each entry + in the array is a separate resource. + items: + type: object + description: >- + `ConnectCluster` object represent Confluent Platform Connect + clusters registered with Confluent Cloud. + + The API allows you to create and delete ConnectCluster. + + + + ## The Connect Clusters Model + + + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this representation + of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectCluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not + space. That is, you can assume that the ID will not be + reclaimed and reused after an object is deleted ("time"); + however, it may collide with IDs for other object `kinds` or + objects of the same `kind` within a different scope/namespace + ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + confluent_platform_connect_cluster_id: + type: string + description: >- + The unique identifier of the Connect cluster within the + Confluent Platform environment. + example: connect-group-xyz123 + x-immutable: true + kafka_cluster_id: + type: string + description: > + The unique identifier of the metadata Kafka cluster for the + Connect Cluster. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: > + The cloud service provider where the metadata for the Connect + Cluster should be stored. + + This field is optional. If provided, 'region' must also be + provided. + + If neither 'cloud' nor 'region' are provided, the cloud + provider of the associated + + metadata Kafka cluster (identified by 'kafka_cluster_id') will + be used as a fallback. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: > + The home region of the Confluent Platform Connect cluster + where the metadata should be stored. + + This field is optional. If provided, 'cloud' must also be + provided. + + If neither 'cloud' nor 'region' are provided, the home region + of the associated + + metadata Kafka cluster (identified by 'kafka_cluster_id') will + be used as a fallback. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - confluent_platform_connect_cluster_id + - kafka_cluster_id + - environment + uniqueItems: true + usm.v1.ConnectCluster: + type: object + description: >- + `ConnectCluster` object represent Confluent Platform Connect clusters + registered with Confluent Cloud. + + The API allows you to create and delete ConnectCluster. + + + + ## The Connect Clusters Model + + + properties: + api_version: + type: string + enum: + - usm/v1 + description: >- + APIVersion defines the schema version of this representation of a + resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectCluster + id: + description: >- + ID is the "natural identifier" for an object within its + scope/namespace; it is normally unique across time but not space. + That is, you can assume that the ID will not be reclaimed and reused + after an object is deleted ("time"); however, it may collide with + IDs for other object `kinds` or objects of the same `kind` within a + different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + confluent_platform_connect_cluster_id: + type: string + description: >- + The unique identifier of the Connect cluster within the Confluent + Platform environment. + example: connect-group-xyz123 + x-immutable: true + kafka_cluster_id: + type: string + description: > + The unique identifier of the metadata Kafka cluster for the Connect + Cluster. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: > + The cloud service provider where the metadata for the Connect + Cluster should be stored. + + This field is optional. If provided, 'region' must also be provided. + + If neither 'cloud' nor 'region' are provided, the cloud provider of + the associated + + metadata Kafka cluster (identified by 'kafka_cluster_id') will be + used as a fallback. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: > + The home region of the Confluent Platform Connect cluster where the + metadata should be stored. + + This field is optional. If provided, 'cloud' must also be provided. + + If neither 'cloud' nor 'region' are provided, the home region of the + associated + + metadata Kafka cluster (identified by 'kafka_cluster_id') will be + used as a fallback. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: >- + A link to the first page of results. If a response does not contain + a first link, then direct navigation to the first page is not + supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: >- + A link to the last page of results. If a response does not contain a + last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: >- + A link to the previous page of results. If a response does not + contain a prev link, then either there is no previous data or + backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: >- + A link to the next page of results. If a response does not contain a + next link, then there is no more data available. + type: string + format: uri + nullable: true + example: >- + https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: >- + Number of records in the full result set. This response may be + paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: >- + Provides information about problems encountered while performing an + operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + EnvScopedObjectReference: + type: object + description: >- + ObjectReference provides information for you to locate the referred + object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: >- + The HTTP status code applicable to this problem, expressed as a + string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: >- + A short, human-readable summary of the problem. It **SHOULD NOT** + change from occurrence to occurrence of the problem, except for + purposes of localization. + type: string + detail: + description: >- + A human-readable explanation specific to this occurrence of the + problem. + type: string + source: + type: object + description: >- + If this error was caused by a particular part of the API request, + the source will point to the query string parameter or request body + property that caused it. + properties: + pointer: + description: >- + A JSON Pointer [RFC6901] to the associated entity in the request + document [e.g. "/spec" for a spec object, or "/spec/title" for a + specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: >- + Basic error="invalid_key", error_description="The API Key is + invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: >- + The user 'mcfly' is not allowed to access the 'delorean' + resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: >- + The maximum number of requests you're permitted to make per time + period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: >- + The relative time in seconds until the current rate-limit window + resets. + + **Important:** This differs from Github and Twitter's same-named + header which uses UTC epoch seconds. We use relative time to avoid + client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: >- + The number of seconds to wait until the rate limit window resets. + Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: >- + The DeLorean has run out of gas, but Doc Brown will fill 'er + up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: >- + The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already + exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: >- + The property '/cluster/storage_size' of type string did not + match the following type: integer + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + x-stackQL-resources: + kafka_clusters: + id: confluent.usm.kafka_clusters + name: kafka_clusters + title: Kafka Clusters + methods: + list_usm_v1_kafka_clusters: + operation: + $ref: '#/paths/~1usm~1v1~1kafka-clusters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_usm_v1_kafka_cluster: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1usm~1v1~1kafka-clusters/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_usm_v1_kafka_cluster: + operation: + $ref: '#/paths/~1usm~1v1~1kafka-clusters~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_usm_v1_kafka_cluster: + operation: + $ref: '#/paths/~1usm~1v1~1kafka-clusters~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/kafka_clusters/methods/get_usm_v1_kafka_cluster + - $ref: >- + #/components/x-stackQL-resources/kafka_clusters/methods/list_usm_v1_kafka_clusters + insert: + - $ref: >- + #/components/x-stackQL-resources/kafka_clusters/methods/create_usm_v1_kafka_cluster + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/kafka_clusters/methods/delete_usm_v1_kafka_cluster + replace: [] + connect_clusters: + id: confluent.usm.connect_clusters + name: connect_clusters + title: Connect Clusters + methods: + list_usm_v1_connect_clusters: + operation: + $ref: '#/paths/~1usm~1v1~1connect-clusters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_usm_v1_connect_cluster: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1usm~1v1~1connect-clusters/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_usm_v1_connect_cluster: + operation: + $ref: '#/paths/~1usm~1v1~1connect-clusters~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_usm_v1_connect_cluster: + operation: + $ref: '#/paths/~1usm~1v1~1connect-clusters~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connect_clusters/methods/get_usm_v1_connect_cluster + - $ref: >- + #/components/x-stackQL-resources/connect_clusters/methods/list_usm_v1_connect_clusters + insert: + - $ref: >- + #/components/x-stackQL-resources/connect_clusters/methods/create_usm_v1_connect_cluster + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/connect_clusters/methods/delete_usm_v1_connect_cluster + replace: [] +servers: + - url: https://api.confluent.cloud diff --git a/provider-dev/scripts/build_svc_overrides.mjs b/provider-dev/scripts/build_svc_overrides.mjs new file mode 100644 index 0000000..e4bf2fa --- /dev/null +++ b/provider-dev/scripts/build_svc_overrides.mjs @@ -0,0 +1,204 @@ +#!/usr/bin/env node +// Build a strict (raw_bucket -> existing_service) override map by walking +// every operationId in the current provider's per-service yamls, locating +// the same operation in the new spec, and applying the discriminator +// function to its tag. Each (raw_bucket -> existing_service) vote is +// recorded; conflicts are reported. +// +// Usage: +// node provider-dev/scripts/build_svc_overrides.mjs +// node provider-dev/scripts/build_svc_overrides.mjs --new-spec path/to/spec.yaml +// +// Outputs: +// - prints summary + conflicts to stdout +// - writes provider-dev/config/svc_name_overrides.json (overwrites) + +import fs from 'node:fs'; +import path from 'node:path'; +import yaml from 'js-yaml'; +import { pathToFileURL } from 'node:url'; + +const args = process.argv.slice(2); +const getArg = (flag, dflt = null) => { + const i = args.indexOf(flag); + return i !== -1 ? args[i + 1] : dflt; +}; + +const EXISTING_DIR = getArg('--existing-dir', 'provider-dev/openapi/src/confluent/v00.00.00000/services'); +const NEW_SPEC = getArg('--new-spec', 'provider-dev/downloaded/openapi.yaml'); +const DISCRIMINATOR_FN = getArg('--discriminator-fn', 'provider-dev/scripts/confluent-svc.mjs'); +const OUT = getArg('--out', 'provider-dev/config/svc_name_overrides.json'); + +const OPS = ['get', 'post', 'put', 'delete', 'patch', 'options', 'head', 'trace']; + +function loadDoc(filePath) { + const text = fs.readFileSync(filePath, 'utf8'); + return yaml.load(text); +} + +// Build (operationId -> existing service name) and (path+verb -> existing service name) from the current provider. +function indexExisting(dir) { + const byOpId = new Map(); + const byPathVerb = new Map(); + const files = fs.readdirSync(dir).filter(f => f.endsWith('.yaml')); + for (const f of files) { + const svc = f.replace(/\.yaml$/, ''); + const doc = loadDoc(path.join(dir, f)); + for (const [p, methods] of Object.entries(doc?.paths || {})) { + for (const [v, op] of Object.entries(methods || {})) { + if (!OPS.includes(v) || !op) continue; + if (op.operationId) byOpId.set(op.operationId, svc); + byPathVerb.set(`${p}\t${v}`, svc); + } + } + } + return { byOpId, byPathVerb }; +} + +// Match the splitter's normalizeServiceName (src/providerdev/split.js): the +// raw value returned by the discriminator is lowercased and hyphens, spaces, +// and dots are replaced with underscores BEFORE svcNameOverrides is consulted. +// The override map keys must therefore use this normalized form. +function normalizeServiceName(raw) { + return String(raw).toLowerCase().replace(/-/g, '_').replace(/ /g, '_').replace(/\./g, '_'); +} + +// Walk new spec, return array of { path, verb, operationId, tag, rawBucket, normalizedBucket }. +function walkNewSpec(spec, discriminator) { + const out = []; + for (const [p, methods] of Object.entries(spec?.paths || {})) { + for (const [v, op] of Object.entries(methods || {})) { + if (!OPS.includes(v) || !op) continue; + const tag = (op.tags && op.tags[0]) || null; + const rawBucket = discriminator(p, op.operationId, op.tags); + const normalizedBucket = rawBucket == null ? null : normalizeServiceName(rawBucket); + out.push({ + path: p, + verb: v, + operationId: op.operationId || null, + tag, + rawBucket, + normalizedBucket, + }); + } + } + return out; +} + +async function main() { + // 1. Index current provider + const { byOpId, byPathVerb } = indexExisting(EXISTING_DIR); + console.log(`[build-overrides] indexed ${byOpId.size} operationIds across existing provider in ${EXISTING_DIR}`); + + // 2. Load new spec (yaml or json — js-yaml handles both) + const newSpec = loadDoc(NEW_SPEC); + console.log(`[build-overrides] loaded new spec from ${NEW_SPEC}`); + + // 3. Load discriminator function + const fnUrl = pathToFileURL(path.resolve(DISCRIMINATOR_FN)).href; + const mod = await import(fnUrl); + const discriminator = mod.default; + if (typeof discriminator !== 'function') { + console.error(`[build-overrides] discriminator at ${DISCRIMINATOR_FN} did not export a default function`); + process.exit(1); + } + + // 4. Walk new spec, collect ops + const newOps = walkNewSpec(newSpec, discriminator); + console.log(`[build-overrides] new spec has ${newOps.length} operations across ${new Set(newOps.map(o => o.normalizedBucket)).size} normalized buckets`); + + // 5. For every op in the new spec, look up existing service. + // Vote: normalizedBucket -> existingSvc. + const votes = new Map(); // normalizedBucket -> Map + const rawByNorm = new Map(); // normalizedBucket -> Set (just for reporting) + let viaOpId = 0, viaPathVerb = 0, unmatched = 0; + + for (const op of newOps) { + if (op.normalizedBucket == null) continue; + if (!rawByNorm.has(op.normalizedBucket)) rawByNorm.set(op.normalizedBucket, new Set()); + rawByNorm.get(op.normalizedBucket).add(op.rawBucket); + + let existing = null; + if (op.operationId && byOpId.has(op.operationId)) { + existing = byOpId.get(op.operationId); + viaOpId++; + } else if (byPathVerb.has(`${op.path}\t${op.verb}`)) { + existing = byPathVerb.get(`${op.path}\t${op.verb}`); + viaPathVerb++; + } else { + unmatched++; + } + if (!existing) continue; + if (!votes.has(op.normalizedBucket)) votes.set(op.normalizedBucket, new Map()); + const m = votes.get(op.normalizedBucket); + m.set(existing, (m.get(existing) || 0) + 1); + } + + console.log(`[build-overrides] matched: ${viaOpId} by operationId, ${viaPathVerb} by path+verb, ${unmatched} unmatched (likely net-new in new spec)`); + + // 6. For each normalized bucket, emit override. + // - If a single existing service won every vote -> emit override (skip if bucket === existingSvc). + // - If multiple existing services voted for the same bucket -> CONFLICT. Pick the majority + // winner but list as a conflict for review. + // - If a bucket has no votes (not in current provider at all) -> truly new, no override. + const overrides = {}; + const conflicts = []; + const truelyNew = []; + const allBuckets = new Set(newOps.map(o => o.normalizedBucket).filter(Boolean)); + for (const nb of [...allBuckets].sort()) { + const v = votes.get(nb); + if (!v) { + truelyNew.push(nb); + continue; + } + const sorted = [...v.entries()].sort((a, b) => b[1] - a[1]); + const winner = sorted[0][0]; + if (sorted.length > 1) { + conflicts.push({ bucket: nb, votes: sorted }); + } + if (nb !== winner) { + overrides[nb] = winner; + } + } + + // 7. Print report + console.log('\n=== Bucket vote breakdown (override key = normalized bucket) ==='); + const w = Math.max(...[...allBuckets].map(s => s.length)); + for (const nb of [...allBuckets].sort()) { + const v = votes.get(nb); + const rawSet = [...(rawByNorm.get(nb) || [])].join('|'); + const rawNote = rawSet && rawSet !== nb ? ` (raw: ${rawSet})` : ''; + if (!v) { + console.log(`${nb.padEnd(w)} (truly new — no override)${rawNote}`); + continue; + } + const breakdown = [...v.entries()].sort((a, b) => b[1] - a[1]).map(([k, n]) => `${k}=${n}`).join(', '); + const winner = [...v.entries()].sort((a, b) => b[1] - a[1])[0][0]; + const arrow = nb === winner ? '(identity)' : `-> ${winner}`; + console.log(`${nb.padEnd(w)} ${breakdown} ${arrow}${rawNote}`); + } + + if (conflicts.length) { + console.log('\n=== Conflicts (single bucket maps to multiple existing services) ==='); + for (const c of conflicts) { + console.log(` ${c.bucket}: ${c.votes.map(([k, n]) => `${k}=${n}`).join(', ')}`); + } + console.log('\n These buckets will be folded into the majority winner. Minority'); + console.log(' resources from the old provider will land in the same service file'); + console.log(' as the majority — this is fine because StackQL resources are scoped'); + console.log(' per service, so e.g. confluent.kafka.cluster_links and'); + console.log(' confluent.kafka.mirror_topics can both live inside kafka.yaml.'); + } + + if (truelyNew.length) { + console.log('\n=== Genuinely new buckets (no matching ops in current provider) ==='); + for (const t of truelyNew) console.log(` ${t}`); + } + + // 8. Write overrides + fs.mkdirSync(path.dirname(OUT), { recursive: true }); + fs.writeFileSync(OUT, JSON.stringify(overrides, null, 2) + '\n'); + console.log(`\n[build-overrides] wrote ${Object.keys(overrides).length} overrides -> ${OUT}`); +} + +main().catch(e => { console.error(e); process.exit(1); }); diff --git a/provider-dev/scripts/fix_doc_links.mjs b/provider-dev/scripts/fix_doc_links.mjs new file mode 100644 index 0000000..9c9766e --- /dev/null +++ b/provider-dev/scripts/fix_doc_links.mjs @@ -0,0 +1,462 @@ +#!/usr/bin/env node +/* + * Post-doc-gen link-fixer. + * + * Walks the FIXES map below, applies each instruction to the named doc file, + * and writes the file back if anything changed. Designed to be parked: today + * we mostly delete dead anchors (Confluent's API-Lifecycle-Policy section + * doesn't exist in our docs), but we can swap to action: 'replace' once we + * have a destination URL. + * + * Map shape: + * { + * '': [ + * { + * link: '', + * action: 'remove' | 'replace', + * replaceWith: '' // required when action === 'replace' + * }, + * ... + * ] + * } + * + * - For action 'remove': we delete the markdown link wrapper but keep the + * visible text. So `[label](broken-url)` becomes `label`. Bare `[![Badge](badge-img)](broken-url)` + * becomes `![Badge](badge-img)`. If `link` matches as a plain anchor token + * (e.g. `#section/Versioning/API-Lifecycle-Policy`) we strip every + * `]( )` occurrence on every line, leaving the leading `[label]` + * untouched, which is the correct unwrap for both shapes. + * + * - For action 'replace': every occurrence of `link` in the file is + * replaced with `replaceWith` (string-literal, not regex). + * + * Run after `npm run generate-docs`, before `yarn build`. + * + * Usage: + * node provider-dev/scripts/fix_doc_links.mjs + * node provider-dev/scripts/fix_doc_links.mjs --dry-run + * node provider-dev/scripts/fix_doc_links.mjs --root website + */ + +import fs from 'node:fs'; +import path from 'node:path'; + +const args = process.argv.slice(2); +const DRY = args.includes('--dry-run'); +const ROOT = (() => { + const i = args.indexOf('--root'); + return i !== -1 ? args[i + 1] : 'website'; +})(); + +// ---------- FIX MAP ---------- + +// Shorthand: every per-resource page links to the same dead Confluent doc anchor. +// We unwrap the link (keep the badge image) on every page that has it. +const LIFECYCLE = { + link: '#section/Versioning/API-Lifecycle-Policy', + action: 'remove', +}; + +// Pages where ONLY the lifecycle anchor is broken. +const LIFECYCLE_ONLY_PAGES = [ + 'docs/services/billing/costs/index.md', + 'docs/services/catalog/business_metadata_defs/index.md', + 'docs/services/catalog/business_metadata/index.md', + 'docs/services/catalog/entities/index.md', + 'docs/services/catalog/tag_defs/index.md', + 'docs/services/catalog/tags/index.md', + 'docs/services/ccl/custom_code_loggings/index.md', + 'docs/services/ccpm/custom_connect_plugin_versions/index.md', + 'docs/services/ccpm/custom_connect_plugins/index.md', + 'docs/services/ccpm/presigned_urls/index.md', + 'docs/services/connect/connector_config/index.md', + 'docs/services/connect/connector_offsets_requests/index.md', + 'docs/services/connect/connector_offsets/index.md', + 'docs/services/connect/connector_tasks/index.md', + 'docs/services/connect/custom_connector_plugins/index.md', + 'docs/services/connect/custom_connector_runtimes/index.md', + 'docs/services/connect/managed_connector_plugins/index.md', + 'docs/services/connect/presigned_urls/index.md', + 'docs/services/encryption_keys/keys/index.md', + 'docs/services/endpoints/endpoints/index.md', + 'docs/services/flink_artifacts/flink_artifacts/index.md', + 'docs/services/flink_artifacts/presigned_urls/index.md', + 'docs/services/flink_compute_pools/compute_pools/index.md', + 'docs/services/flink_compute_pools/org_compute_pool_configs/index.md', + 'docs/services/flink_compute_pools/regions/index.md', + 'docs/services/iam/api_keys/index.md', + 'docs/services/iam/certificate_authorities/index.md', + 'docs/services/iam/certificate_identity_pools/index.md', + 'docs/services/iam/group_mappings/index.md', + 'docs/services/iam/identity_pools/index.md', + 'docs/services/iam/invitations/index.md', + 'docs/services/iam/ip_filter_summaries/index.md', + 'docs/services/iam/ip_filters/index.md', + 'docs/services/iam/ip_groups/index.md', + 'docs/services/iam/role_bindings/index.md', + 'docs/services/iam/service_accounts/index.md', + 'docs/services/iam/users/index.md', + 'docs/services/kafka/acls/index.md', + 'docs/services/kafka/cluster_configs/index.md', + 'docs/services/kafka/cluster_link_configs/index.md', + 'docs/services/kafka/cluster_links/index.md', + 'docs/services/kafka/clusters/index.md', + 'docs/services/kafka/consumer_groups/index.md', + 'docs/services/kafka/consumers_lag_summary/index.md', + 'docs/services/kafka/consumers_lags/index.md', + 'docs/services/kafka/consumers/index.md', + 'docs/services/kafka/default_topic_configs/index.md', + 'docs/services/kafka/group_configs/index.md', + 'docs/services/kafka/mirror_topics/index.md', + 'docs/services/kafka/records/index.md', + 'docs/services/kafka/topic_configs/index.md', + 'docs/services/kafka/topic_partitions/index.md', + 'docs/services/kafka/topics/index.md', + 'docs/services/ksqldb_clusters/clusters/index.md', + 'docs/services/managed_kafka_clusters/clusters/index.md', + 'docs/services/networking/access_points/index.md', + 'docs/services/networking/dns_forwarders/index.md', + 'docs/services/networking/dns_records/index.md', + 'docs/services/networking/gateways/index.md', + 'docs/services/networking/ip_addresses/index.md', + 'docs/services/networking/network_link_endpoints/index.md', + 'docs/services/networking/network_link_service_associations/index.md', + 'docs/services/networking/network_link_services/index.md', + 'docs/services/networking/networks/index.md', + 'docs/services/networking/peerings/index.md', + 'docs/services/networking/private_link_accesses/index.md', + 'docs/services/networking/private_link_attachment_connections/index.md', + 'docs/services/networking/private_link_attachments/index.md', + 'docs/services/networking/transit_gateway_attachments/index.md', + 'docs/services/notifications/integrations/index.md', + 'docs/services/notifications/notification_types/index.md', + 'docs/services/notifications/resource_preferences/index.md', + 'docs/services/notifications/resource_subscriptions/index.md', + 'docs/services/notifications/subscriptions/index.md', + 'docs/services/org/environments/index.md', + 'docs/services/org/organizations/index.md', + 'docs/services/partner/entitlements/index.md', + 'docs/services/partner/organizations/index.md', + 'docs/services/partner/signups/index.md', + 'docs/services/provider_integrations/integrations_v1/index.md', + 'docs/services/provider_integrations/integrations_v2/index.md', + 'docs/services/provider_integrations/integrations/index.md', + 'docs/services/quotas/applied_quotas/index.md', + 'docs/services/quotas/client_quotas/index.md', + 'docs/services/quotas/scopes/index.md', + 'docs/services/schema_registry_clusters/regions/index.md', + 'docs/services/schema_registry_clusters/v2_clusters/index.md', + 'docs/services/schema_registry_clusters/v3_clusters/index.md', + 'docs/services/share_group/consumer_assignments/index.md', + 'docs/services/share_group/consumers/index.md', + 'docs/services/share_group/share_groups/index.md', + 'docs/services/sql/agents/index.md', + 'docs/services/sql/connections/index.md', + 'docs/services/sql/materialized_table_versions/index.md', + 'docs/services/sql/materialized_tables/index.md', + 'docs/services/sql/statement_exceptions/index.md', + 'docs/services/sql/statement_results/index.md', + 'docs/services/sql/statements/index.md', + 'docs/services/sql/tools/index.md', + 'docs/services/stream_sharing/consumer_shared_resources/index.md', + 'docs/services/stream_sharing/consumer_shares/index.md', + 'docs/services/stream_sharing/opt_ins/index.md', + 'docs/services/stream_sharing/provider_shared_resources/index.md', + 'docs/services/stream_sharing/provider_shares/index.md', + 'docs/services/stream_sharing/shared_resources_network_config/index.md', + 'docs/services/stream_sharing/shared_tokens/index.md', + 'docs/services/streams_group/member_assignment_task_partitions/index.md', + 'docs/services/streams_group/member_assignment_tasks/index.md', + 'docs/services/streams_group/member_assignments/index.md', + 'docs/services/streams_group/member_target_assignment_task_partitions/index.md', + 'docs/services/streams_group/member_target_assignment_tasks/index.md', + 'docs/services/streams_group/member_target_assignments/index.md', + 'docs/services/streams_group/members/index.md', + 'docs/services/streams_group/streams_groups/index.md', + 'docs/services/streams_group/subtopologies/index.md', + 'docs/services/sts/oauth_tokens/index.md', + 'docs/services/tableflow/catalog_integrations/index.md', + 'docs/services/tableflow/regions/index.md', + 'docs/services/tableflow/topics/index.md', + 'docs/services/usm/connect_clusters/index.md', + 'docs/services/usm/kafka_clusters/index.md', +]; + +const FIXES = {}; +for (const p of LIFECYCLE_ONLY_PAGES) FIXES[p] = [LIFECYCLE]; + +// connectors page has the lifecycle anchor PLUS two cross-resource anchors that +// don't resolve. Unwrap all three; the prose still reads sensibly. +FIXES['docs/services/connect/connectors/index.md'] = [ + LIFECYCLE, + { link: '#operation/readConnectv1Connector', action: 'remove' }, + { link: '#operation/listConnectv1Connectors', action: 'remove' }, +]; + +// iam/identity_providers has a literal space between `]` and `(` in two +// places: `[Early Access lifecycle stage] (https://...)`. MDX parses the +// trailing `#section/Versioning/...` fragment as an in-page anchor (which +// doesn't exist on this page) instead of treating the whole `(https://...)` +// as the link target. Closing the space turns it into a well-formed external +// link to Confluent's real lifecycle-policy docs. +FIXES['docs/services/iam/identity_providers/index.md'] = [ + { + action: 'replace', + link: '[Early Access lifecycle stage] (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)', + replaceWith: '[Early Access lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)', + }, +]; + + +// SQL pages where MDX is mis-parsing regex char-classes inside blocks +// as bracketed link refs. The structure `[a-z0-9](...)` looks identical to +// markdown's `[label](link)` syntax, and backslash-escaping the brackets +// inside doesn't help — MDX still treats them as link tokens. +// +// The reliable fix is to swap `[` and `]` for HTML entities `[` / `]` +// inside the regex literal. Browsers render the entities as `[` and `]` +// inside , but MDX only sees the literal entity strings and stops +// parsing them as link syntax. +// +// Each entry replaces the full pristine ... regex literal with +// an entity-encoded variant. Idempotent — once swapped the literal no longer +// matches the find string so re-runs are no-ops. +const SQL_REGEX_FIXES = { + 'docs/services/sql/agents/index.md': [ + { + action: 'replace', + link: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*', + replaceWith: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*', + }, + ], + 'docs/services/sql/connections/index.md': [ + { + action: 'replace', + link: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*', + replaceWith: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*', + }, + ], + 'docs/services/sql/materialized_table_versions/index.md': [ + { + action: 'replace', + link: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*', + replaceWith: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*', + }, + ], + 'docs/services/sql/materialized_tables/index.md': [ + { + action: 'replace', + link: '^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$', + replaceWith: '^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$', + }, + ], + 'docs/services/sql/statements/index.md': [ + { + action: 'replace', + link: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*', + replaceWith: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*', + }, + ], + 'docs/services/sql/tools/index.md': [ + { + action: 'replace', + link: '[a-z0-9_]([-a-z0-9_]*[a-z0-9_])?', + replaceWith: '[a-z0-9_]([-a-z0-9_]*[a-z0-9_])?', + }, + ], +}; +for (const [p, fixes] of Object.entries(SQL_REGEX_FIXES)) { + FIXES[p] = (FIXES[p] || []).concat(fixes); +} + +// ---------- ENGINE ---------- + +// For action: 'remove' on an anchor link, we want `[label](anchor)` -> `label`. +// We escape regex metacharacters in the link, then match `]\((anchor)\)` and drop +// it along with the matching opening bracket. The opening bracket is harder to +// pin to the right [label] when prose contains nested brackets, so we use a +// non-greedy [^[\]]* run instead — MDX badges and resource cross-refs in this +// codebase don't nest brackets inside the label text. +function escRegex(s) { + return s.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); +} + +// Find each `](broken-link)` occurrence and walk back to find the matching +// opening `[` taking nested brackets into account. Replace `[label](broken-link)` +// with just `label` so the visible content is preserved but the link is gone. +// This handles cases like `[![alt](image-url)](broken-link)` where the label +// itself contains an image link. +function unwrapMarkdownLink(content, link) { + const closeToken = '](' + link + ')'; + let result = ''; + let cursor = 0; + while (cursor < content.length) { + const closeIdx = content.indexOf(closeToken, cursor); + if (closeIdx === -1) { + result += content.substring(cursor); + break; + } + // Walk back from closeIdx-1 to find the matching `[`. The body up to closeIdx + // is `...[label_with_maybe_nested_brackets]`; we need to find the `[` whose + // depth count is balanced relative to the `]` at closeIdx. + let depth = 1; + let i = closeIdx - 1; + let openIdx = -1; + while (i >= 0) { + const ch = content[i]; + if (ch === ']') depth++; + else if (ch === '[') { + depth--; + if (depth === 0) { openIdx = i; break; } + } + i--; + } + if (openIdx === -1) { + // No matching opener found; emit up to and including the close token unchanged + // and continue past it to avoid an infinite loop. + result += content.substring(cursor, closeIdx + closeToken.length); + cursor = closeIdx + closeToken.length; + continue; + } + // Emit prelude up to (but not including) the opening `[` + result += content.substring(cursor, openIdx); + // Emit the label content (between `[` and `]`) + result += content.substring(openIdx + 1, closeIdx); + // Skip past the closeToken + cursor = closeIdx + closeToken.length; + } + return result; +} + +function replaceLink(content, link, replaceWith) { + const re = new RegExp('\\(' + escRegex(link) + '\\)', 'g'); + // Replace inside a parenthesised link target only — e.g. `](broken)` -> `](new)`. + // For replace mode we keep the link alive but point it elsewhere. + return content.replace(re, '(' + replaceWith + ')'); +} + +function applyLiteralReplace(content, find, replaceWith) { + // Used for the regex-bracket fixes — find/replace is a plain string swap. + const idx = content.indexOf(find); + if (idx === -1) return content; + return content.split(find).join(replaceWith); +} + +// ---------- BADGE STRIP ---------- +// Remove every `![alt](https://img.shields.io/...)` image from every doc page. +// These are Confluent's "Lifecycle Stage" / "Request Access" / "Available in +// dedicated clusters" pills — they bloat tables and add no value in the StackQL +// docs. Also collapses any `

` chunks immediately following a removed +// badge so we don't leave stray vertical gaps. +// +// In Confluent's spec the badge is often wrapped in a link to its lifecycle +// section, e.g. `[![Badge](image)](#section/Versioning/API-Lifecycle-Policy)`. +// We match the OUTER link form first (greedy) so that nuking the badge also +// nukes the surrounding link wrapper, otherwise we'd leave behind `[](#anchor)` +// which Docusaurus then flags as a broken anchor. +function stripBadges(content) { + // 1. Outer-wrapped form: `[![alt](badge-url)](anchor-or-url)
*` + // Whatever the link target is — anchor, full URL, anything — drop the lot. + const wrapped = /\[!\[[^\]\n]*\]\(https:\/\/img\.shields\.io\/[^)\n]*\)\]\([^)\n]*\)(\s*\s*)*/g; + // 2. Bare image: `![alt](badge-url)
*` + const bare = /!\[[^\]\n]*\]\(https:\/\/img\.shields\.io\/[^)\n]*\)(\s*\s*)*/g; + // 3. Corpses left by an EARLIER badge-strip pass that didn't yet handle the + // wrapping link: `[](anchor-or-url)
*`. The label is empty because + // the image was already removed. Drop these too. + const empty = /\[\]\([^)\n]*\)(\s*\s*)*/g; + return content.replace(wrapped, '').replace(bare, '').replace(empty, ''); +} + +function walkDocs(root) { + const out = []; + function walk(dir) { + for (const entry of fs.readdirSync(dir, { withFileTypes: true })) { + const fp = path.join(dir, entry.name); + if (entry.isDirectory()) walk(fp); + else if (entry.isFile() && entry.name.endsWith('.md')) out.push(fp); + } + } + walk(root); + return out; +} + +const docsRoot = path.join(ROOT, 'docs'); +let cleanupFiles = 0; +let cleanupChunksRemoved = 0; +if (fs.existsSync(docsRoot)) { + const allDocs = walkDocs(docsRoot); + for (const fp of allDocs) { + const before = fs.readFileSync(fp, 'utf8'); + const after = stripBadges(before); + if (after === before) continue; + + // Count how much was removed for the report (badges + empty-label corpses). + const badgeMatches = before.match(/!\[[^\]\n]*\]\(https:\/\/img\.shields\.io\/[^)\n]*\)/g); + const corpseMatches = before.match(/\[\]\([^)\n]*\)/g); + const removedCount = (badgeMatches ? badgeMatches.length : 0) + (corpseMatches ? corpseMatches.length : 0); + + cleanupFiles++; + cleanupChunksRemoved += removedCount; + if (DRY) { + const rel = path.relative(ROOT, fp); + console.log(`[dry] would clean ${removedCount} badge/corpse chunk(s) from ${rel}`); + } else { + fs.writeFileSync(fp, after); + } + } + console.log(`post-gen cleanup: ${DRY ? 'would touch' : 'touched'} ${cleanupFiles} file(s), removed ${cleanupChunksRemoved} badge/corpse chunk(s)`); +} else { + console.log(`post-gen cleanup: skipped (${docsRoot} not found)`); +} + +// ---------- LINK FIXES ---------- + +let totalFiles = 0, filesChanged = 0, totalEdits = 0, missing = []; +for (const [rel, instructions] of Object.entries(FIXES)) { + totalFiles++; + const fp = path.join(ROOT, rel); + if (!fs.existsSync(fp)) { missing.push(rel); continue; } + const before = fs.readFileSync(fp, 'utf8'); + let after = before; + let edits = 0; + for (const ins of instructions) { + const prev = after; + if (ins.action === 'remove') { + after = unwrapMarkdownLink(after, ins.link); + } else if (ins.action === 'replace') { + // Two flavours: if the link looks like a URL/anchor (starts with # / http / / etc) + // we treat it as a markdown-link target. Otherwise we treat it as a literal + // string swap (used for regex-bracket fixes). + if (/^[#/]|^https?:|^mailto:/.test(ins.link)) { + if (!ins.replaceWith) { console.warn(`[fix] skipping replace with no replaceWith: ${rel} ${ins.link}`); continue; } + after = replaceLink(after, ins.link, ins.replaceWith); + } else { + if (ins.replaceWith == null) { console.warn(`[fix] skipping replace with no replaceWith: ${rel} ${ins.link}`); continue; } + after = applyLiteralReplace(after, ins.link, ins.replaceWith); + } + } else { + console.warn(`[fix] unknown action "${ins.action}" for ${rel}`); + continue; + } + if (after !== prev) edits++; + } + if (after !== before) { + filesChanged++; + totalEdits += edits; + if (DRY) { + console.log(`[dry] would update ${rel} (${edits} instruction(s) matched)`); + } else { + fs.writeFileSync(fp, after); + console.log(`updated ${rel} (${edits} instruction(s) matched)`); + } + } +} + +console.log(`\nfiles in map: ${totalFiles}`); +console.log(`files changed: ${filesChanged}`); +console.log(`total instructions that matched: ${totalEdits}`); +if (missing.length) { + console.log(`\nFiles in map but not on disk (skipped):`); + for (const m of missing) console.log(` ${m}`); +} +if (DRY) console.log('\n(dry-run; no files written)'); diff --git a/provider-dev/source/.gitkeep b/provider-dev/source/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/provider-dev/source/billing.yaml b/provider-dev/source/billing.yaml new file mode 100644 index 0000000..217fe77 --- /dev/null +++ b/provider-dev/source/billing.yaml @@ -0,0 +1,914 @@ +openapi: 3.0.0 +info: + title: billing API + description: confluent billing API + version: 1.0.0 +paths: + /billing/v1/costs: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listBillingV1Costs + summary: List of Costs + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all costs. + parameters: + - name: start_date + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: '2022-10-12' + description: Filter the results by exact match for start_date. + - name: end_date + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: '2022-10-15' + description: Filter the results by exact match for end_date. + - name: page_size + in: query + required: false + schema: + type: integer + default: 5000 + maximum: 10000 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Costs (billing/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cost. + content: + application/json: + schema: + type: object + description: |- + `Cost` objects represent the aggregated billing costs for an organization + + + Related guide: [Retrieve costs for a range of dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates). + + ## The Costs Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - billing/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CostList + metadata: + type: object + description: CostListMeta describes metadata that resource collections may have + properties: + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Cost` objects represent the aggregated billing costs for an organization + + + Related guide: [Retrieve costs for a range of dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates). + + ## The Costs Model + + properties: + api_version: + type: string + enum: + - billing/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cost + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + start_date: + type: string + format: date + example: '2022-10-12' + description: Start date of time period (inclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. + end_date: + type: string + format: date + example: '2022-10-15' + description: End date of time period (exclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. + granularity: + type: string + x-extensible-enum: + - DAILY + default: DAILY + description: Granularity at which each line item is aggregated. + network_access_type: + type: string + x-extensible-enum: + - INTERNET + - TRANSIT_GATEWAY + - PRIVATE_LINK + - PEERED_VPC + - PNI + - MULTI + example: INTERNET + description: Network access type for the cluster. + product: + type: string + x-extensible-enum: + - KAFKA + - CONNECT + - KSQL + - AUDIT_LOG + - STREAM_GOVERNANCE + - CLUSTER_LINK + - CUSTOM_CONNECT + - FLINK + - TABLEFLOW + - SUPPORT_CLOUD_BASIC + - SUPPORT_CLOUD_DEVELOPER + - SUPPORT_CLOUD_BUSINESS + - SUPPORT_CLOUD_PREMIER + - USM + example: KAFKA + description: Product name. + line_type: + type: string + x-extensible-enum: + - KAFKA_STORAGE + - KAFKA_PARTITION + - KAFKA_NETWORK_READ + - KAFKA_NETWORK_WRITE + - KAFKA_BASE + - KAFKA_NUM_CKUS + - KAFKA_REST_PRODUCE + - KSQL_NUM_CSUS + - CONNECT_CAPACITY + - CONNECT_NUM_TASKS + - CONNECT_THROUGHPUT + - CONNECT_NUM_RECORDS + - SUPPORT + - CLUSTER_LINKING_PER_LINK + - CLUSTER_LINKING_WRITE + - CLUSTER_LINKING_READ + - AUDIT_LOG_READ + - GOVERNANCE_BASE + - SCHEMA_REGISTRY + - PROMO_CREDIT + - CUSTOM_CONNECT_NUM_TASKS + - CUSTOM_CONNECT_THROUGHPUT + - NUM_RULES + - FLINK_NUM_CFUS + - TABLEFLOW_DATA_PROCESSED + - TABLEFLOW_NUM_TOPICS + - TABLEFLOW_STORAGE + - USM_CONNECTED_NODE + - KAFKA_STREAMS + example: KAFKA_NUM_CKUS + description: Type of the line item. + price: + type: number + format: double + example: 1.5 + description: Price for the line item in dollars. + unit: + type: string + example: GB + description: Unit of the line item. + quantity: + type: number + format: double + example: 99.9 + description: Quantity of the line item. + original_amount: + type: number + format: double + example: 149.85 + description: Original amount accrued for this line item. + discount_amount: + type: number + format: double + example: 20.85 + description: Amount discounted from the original amount in dollars. + amount: + type: number + format: double + example: 129 + description: Final amount after deducting discounts. + description: + type: string + example: KAFKA101 + description: Additional details about promotional offers/credits. + tier_dimensions: + type: object + additionalProperties: + type: string + description: Tier dimensions which exist for tiered pricing cost items only. + x-go-type: map[string]string + example: + provider: aws + region: us-east-1 + connector_type: BigQuerySink + resource: + description: The resource for a given object + type: object + properties: + id: + type: string + description: ID of the resource. + example: lkc-12345 + display_name: + type: string + description: Display name of the resource. + example: prod-kafka-cluster + environment: + description: The environment associated with this resource + nullable: true + type: object + properties: + id: + type: string + description: ID of the environment. + example: env-123 + required: + - id + - start_date + - end_date + - unit + - original_amount + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + billing.v1.CostList: + type: object + description: |- + `Cost` objects represent the aggregated billing costs for an organization + + + Related guide: [Retrieve costs for a range of dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates). + + ## The Costs Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - billing/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CostList + metadata: + type: object + description: CostListMeta describes metadata that resource collections may have + properties: + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Cost` objects represent the aggregated billing costs for an organization + + + Related guide: [Retrieve costs for a range of dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates). + + ## The Costs Model + + properties: + api_version: + type: string + enum: + - billing/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cost + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + start_date: + type: string + format: date + example: '2022-10-12' + description: Start date of time period (inclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. + end_date: + type: string + format: date + example: '2022-10-15' + description: End date of time period (exclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. + granularity: + type: string + x-extensible-enum: + - DAILY + default: DAILY + description: Granularity at which each line item is aggregated. + network_access_type: + type: string + x-extensible-enum: + - INTERNET + - TRANSIT_GATEWAY + - PRIVATE_LINK + - PEERED_VPC + - PNI + - MULTI + example: INTERNET + description: Network access type for the cluster. + product: + type: string + x-extensible-enum: + - KAFKA + - CONNECT + - KSQL + - AUDIT_LOG + - STREAM_GOVERNANCE + - CLUSTER_LINK + - CUSTOM_CONNECT + - FLINK + - TABLEFLOW + - SUPPORT_CLOUD_BASIC + - SUPPORT_CLOUD_DEVELOPER + - SUPPORT_CLOUD_BUSINESS + - SUPPORT_CLOUD_PREMIER + - USM + example: KAFKA + description: Product name. + line_type: + type: string + x-extensible-enum: + - KAFKA_STORAGE + - KAFKA_PARTITION + - KAFKA_NETWORK_READ + - KAFKA_NETWORK_WRITE + - KAFKA_BASE + - KAFKA_NUM_CKUS + - KAFKA_REST_PRODUCE + - KSQL_NUM_CSUS + - CONNECT_CAPACITY + - CONNECT_NUM_TASKS + - CONNECT_THROUGHPUT + - CONNECT_NUM_RECORDS + - SUPPORT + - CLUSTER_LINKING_PER_LINK + - CLUSTER_LINKING_WRITE + - CLUSTER_LINKING_READ + - AUDIT_LOG_READ + - GOVERNANCE_BASE + - SCHEMA_REGISTRY + - PROMO_CREDIT + - CUSTOM_CONNECT_NUM_TASKS + - CUSTOM_CONNECT_THROUGHPUT + - NUM_RULES + - FLINK_NUM_CFUS + - TABLEFLOW_DATA_PROCESSED + - TABLEFLOW_NUM_TOPICS + - TABLEFLOW_STORAGE + - USM_CONNECTED_NODE + - KAFKA_STREAMS + example: KAFKA_NUM_CKUS + description: Type of the line item. + price: + type: number + format: double + example: 1.5 + description: Price for the line item in dollars. + unit: + type: string + example: GB + description: Unit of the line item. + quantity: + type: number + format: double + example: 99.9 + description: Quantity of the line item. + original_amount: + type: number + format: double + example: 149.85 + description: Original amount accrued for this line item. + discount_amount: + type: number + format: double + example: 20.85 + description: Amount discounted from the original amount in dollars. + amount: + type: number + format: double + example: 129 + description: Final amount after deducting discounts. + description: + type: string + example: KAFKA101 + description: Additional details about promotional offers/credits. + tier_dimensions: + type: object + additionalProperties: + type: string + description: Tier dimensions which exist for tiered pricing cost items only. + x-go-type: map[string]string + example: + provider: aws + region: us-east-1 + connector_type: BigQuerySink + resource: + description: The resource for a given object + type: object + properties: + id: + type: string + description: ID of the resource. + example: lkc-12345 + display_name: + type: string + description: Display name of the resource. + example: prod-kafka-cluster + environment: + description: The environment associated with this resource + nullable: true + type: object + properties: + id: + type: string + description: ID of the environment. + example: env-123 + required: + - id + - start_date + - end_date + - unit + - original_amount + uniqueItems: true + CostListMeta: + type: object + description: CostListMeta describes metadata that resource collections may have + properties: + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + billing.v1.Cost: + type: object + description: |- + `Cost` objects represent the aggregated billing costs for an organization + + + Related guide: [Retrieve costs for a range of dates](https://docs.confluent.io/cloud/current/billing/overview.html#retrieve-costs-for-a-range-of-dates). + + ## The Costs Model + + properties: + api_version: + type: string + enum: + - billing/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cost + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + start_date: + type: string + format: date + example: '2022-10-12' + description: Start date of time period (inclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. + end_date: + type: string + format: date + example: '2022-10-15' + description: End date of time period (exclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. + granularity: + type: string + x-extensible-enum: + - DAILY + default: DAILY + description: Granularity at which each line item is aggregated. + network_access_type: + type: string + x-extensible-enum: + - INTERNET + - TRANSIT_GATEWAY + - PRIVATE_LINK + - PEERED_VPC + - PNI + - MULTI + example: INTERNET + description: Network access type for the cluster. + product: + type: string + x-extensible-enum: + - KAFKA + - CONNECT + - KSQL + - AUDIT_LOG + - STREAM_GOVERNANCE + - CLUSTER_LINK + - CUSTOM_CONNECT + - FLINK + - TABLEFLOW + - SUPPORT_CLOUD_BASIC + - SUPPORT_CLOUD_DEVELOPER + - SUPPORT_CLOUD_BUSINESS + - SUPPORT_CLOUD_PREMIER + - USM + example: KAFKA + description: Product name. + line_type: + type: string + x-extensible-enum: + - KAFKA_STORAGE + - KAFKA_PARTITION + - KAFKA_NETWORK_READ + - KAFKA_NETWORK_WRITE + - KAFKA_BASE + - KAFKA_NUM_CKUS + - KAFKA_REST_PRODUCE + - KSQL_NUM_CSUS + - CONNECT_CAPACITY + - CONNECT_NUM_TASKS + - CONNECT_THROUGHPUT + - CONNECT_NUM_RECORDS + - SUPPORT + - CLUSTER_LINKING_PER_LINK + - CLUSTER_LINKING_WRITE + - CLUSTER_LINKING_READ + - AUDIT_LOG_READ + - GOVERNANCE_BASE + - SCHEMA_REGISTRY + - PROMO_CREDIT + - CUSTOM_CONNECT_NUM_TASKS + - CUSTOM_CONNECT_THROUGHPUT + - NUM_RULES + - FLINK_NUM_CFUS + - TABLEFLOW_DATA_PROCESSED + - TABLEFLOW_NUM_TOPICS + - TABLEFLOW_STORAGE + - USM_CONNECTED_NODE + - KAFKA_STREAMS + example: KAFKA_NUM_CKUS + description: Type of the line item. + price: + type: number + format: double + example: 1.5 + description: Price for the line item in dollars. + unit: + type: string + example: GB + description: Unit of the line item. + quantity: + type: number + format: double + example: 99.9 + description: Quantity of the line item. + original_amount: + type: number + format: double + example: 149.85 + description: Original amount accrued for this line item. + discount_amount: + type: number + format: double + example: 20.85 + description: Amount discounted from the original amount in dollars. + amount: + type: number + format: double + example: 129 + description: Final amount after deducting discounts. + description: + type: string + example: KAFKA101 + description: Additional details about promotional offers/credits. + tier_dimensions: + type: object + additionalProperties: + type: string + description: Tier dimensions which exist for tiered pricing cost items only. + x-go-type: map[string]string + example: + provider: aws + region: us-east-1 + connector_type: BigQuerySink + resource: + description: The resource for a given object + type: object + properties: + id: + type: string + description: ID of the resource. + example: lkc-12345 + display_name: + type: string + description: Display name of the resource. + example: prod-kafka-cluster + environment: + description: The environment associated with this resource + nullable: true + type: object + properties: + id: + type: string + description: ID of the environment. + example: env-123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + billing.v1.Resource: + type: object + description: | + The resource associated with this object. The resource can be one of Kafka Cluster ID (example: lkc-12345), + Connector ID (example: + lcc-12345), Schema Registry Cluster ID (example: lsrc-12345), or ksqlDB Cluster ID + (example: lksqlc-12345). + May be null or omitted if not associated with a resource. + properties: + id: + type: string + description: ID of the resource. + example: lkc-12345 + display_name: + type: string + description: Display name of the resource. + example: prod-kafka-cluster + environment: + description: The environment associated with this resource + nullable: true + type: object + properties: + id: + type: string + description: ID of the environment. + example: env-123 + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + billing.v1.Environment: + type: object + description: | + The details of the environment for a given resource. + properties: + id: + type: string + description: ID of the environment. + example: env-123 + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/catalog.yaml b/provider-dev/source/catalog.yaml new file mode 100644 index 0000000..e2fda0c --- /dev/null +++ b/provider-dev/source/catalog.yaml @@ -0,0 +1,1731 @@ +openapi: 3.0.0 +info: + title: catalog API + description: confluent catalog API + version: 1.0.0 +paths: + /catalog/v1/types/businessmetadatadefs: + get: + summary: Bulk Read Business Metadata Definitions + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk retrieval API for retrieving business metadata definitions. + operationId: getAllBusinessMetadataDefs + tags: + - Types (v1) + parameters: + - description: The prefix of a business metadata definition name + explode: true + in: query + name: prefix + required: false + schema: + type: string + style: form + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataDefResponse' + type: array + description: The business metadata definitions + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + post: + summary: Bulk Create Business Metadata Definitions + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk create API for business metadata definitions. + operationId: createBusinessMetadataDefs + tags: + - Types (v1) + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataDef' + type: array + description: The business metadata definitions to create + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataDefResponse' + type: array + description: The business metadata definitions. Errored business metadata definitions will have an additional error property. + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + put: + summary: Bulk Update Business Metadata Definitions + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk update API for business metadata definitions. + operationId: updateBusinessMetadataDefs + tags: + - Types (v1) + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataDef' + type: array + description: The business metadata definitions to update + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataDefResponse' + type: array + description: The business metadata definitions. Errored business metadata definitions will have an additional error property. + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/types/businessmetadatadefs/{bmName}: + delete: + summary: Delete Business Metadata Definition + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete API for business metadata definition identified by its name. + operationId: deleteBusinessMetadataDef + tags: + - Types (v1) + parameters: + - description: The name of the business metadata definition + explode: false + in: path + name: bmName + required: true + schema: + type: string + style: simple + responses: + '204': + description: No Content + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + get: + summary: Read Business Metadata Definition + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get the business metadata definition with the given name. + operationId: getBusinessMetadataDefByName + tags: + - Types (v1) + parameters: + - description: The name of the business metadata definition + explode: false + in: path + name: bmName + required: true + schema: + type: string + style: simple + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BusinessMetadataDef' + description: The business metadata definition + '400': + description: Bad Request + '404': + description: Business metadata definition not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity/businessmetadata: + post: + summary: Bulk Create Business Metadata + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk API to create multiple business metadata. + operationId: createBusinessMetadata + tags: + - Entity (v1) + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadata' + type: array + description: The business metadata + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataResponse' + type: array + description: The business metadata. Errored business metadata will have an additional error property. + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + put: + summary: Bulk Update Business Metadata + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk API to update multiple business metadata. + operationId: updateBusinessMetadata + tags: + - Entity (v1) + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadata' + type: array + description: The business metadata + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataResponse' + type: array + description: The business metadata. Errored business metadata will have an additional error property. + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata: + get: + summary: Read Business Metadata for an Entity + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Gets the list of business metadata for a given entity represented + by a qualified name. + operationId: getBusinessMetadata + tags: + - Entity (v1) + parameters: + - description: The type of the entity + explode: false + in: path + name: typeName + required: true + schema: + type: string + style: simple + - description: The qualified name of the entity + explode: false + in: path + name: qualifiedName + required: true + schema: + type: string + style: simple + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/BusinessMetadataResponse' + type: array + description: The business metadata + '400': + description: Bad Request + '404': + description: Entity not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}: + delete: + summary: Delete a Business Metadata for an Entity + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete a business metadata on an entity. + operationId: deleteBusinessMetadata + tags: + - Entity (v1) + parameters: + - description: The type of the entity + explode: false + in: path + name: typeName + required: true + schema: + type: string + style: simple + - description: The qualified name of the entity + explode: false + in: path + name: qualifiedName + required: true + schema: + type: string + style: simple + - description: The name of the business metadata + explode: false + in: path + name: bmName + required: true + schema: + type: string + style: simple + responses: + '204': + description: No Content + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity/tags: + put: + summary: Bulk Update Tags + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk API to update multiple tags. + tags: + - Entity (v1) + operationId: updateTags + requestBody: + description: The tags + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tag' + responses: + '200': + description: The tags. Errored tags will have an additional error property. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagResponse' + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + post: + summary: Bulk Create Tags + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk API to create multiple tags. + tags: + - Entity (v1) + operationId: createTags + requestBody: + description: The tags + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tag' + responses: + '200': + description: The tags. Errored tags will have an additional error property. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagResponse' + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity/type/{typeName}/name/{qualifiedName}: + get: + summary: Read an Entity + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Fetch complete definition of an entity given its type and unique attribute. + operationId: getByUniqueAttributes + parameters: + - name: typeName + in: path + description: The type of the entity + required: true + schema: + type: string + - name: qualifiedName + in: path + description: The qualified name of the entity + required: true + schema: + type: string + - name: minExtInfo + in: query + description: Whether to populate on header and schema attributes + schema: + type: boolean + default: false + - name: ignoreRelationships + in: query + description: Whether to ignore relationships + schema: + type: boolean + default: false + tags: + - Entity (v1) + responses: + '200': + description: The entity + content: + application/json: + schema: + $ref: '#/components/schemas/EntityWithExtInfo' + '400': + description: Bad Request + '404': + description: Entity not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags: + get: + summary: Read Tags for an Entity + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Gets the list of tags for a given entity represented by a qualified name. + operationId: getTags + parameters: + - name: typeName + in: path + description: The type of the entity + required: true + schema: + type: string + - name: qualifiedName + in: path + description: The qualified name of the entity + required: true + schema: + type: string + tags: + - Entity (v1) + responses: + '200': + description: The tags + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagResponse' + '400': + description: Bad Request + '404': + description: Entity not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity: + put: + summary: Update an Entity Attribute + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Partially update an entity attribute. + operationId: partialEntityUpdate + requestBody: + description: The entity to update + content: + application/json: + schema: + $ref: '#/components/schemas/EntityWithExtInfo' + tags: + - Entity (v1) + responses: + '200': + description: The updated entity + content: + application/json: + schema: + $ref: '#/components/schemas/EntityPartialUpdateResponse' + '400': + description: Bad Request + '404': + description: Entity not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}: + delete: + summary: Delete a Tag for an Entity + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete a tag for an entity. + operationId: deleteTag + parameters: + - name: typeName + in: path + description: The type of the entity + required: true + schema: + type: string + - name: qualifiedName + in: path + description: The qualified name of the entity + required: true + schema: + type: string + - name: tagName + in: path + description: The name of the tag + required: true + schema: + type: string + tags: + - Entity (v1) + responses: + '204': + description: No Content + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/search/attribute: + get: + summary: Search by Attribute + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve data for the specified attribute search query. + operationId: searchUsingAttribute + parameters: + - name: type + in: query + description: Limit the result to only entities of specified types + style: form + explode: true + schema: + type: array + items: + type: string + - name: attr + in: query + description: One of more additional attributes to return in the response + style: form + explode: true + schema: + type: array + items: + type: string + - name: attrName + in: query + description: The attribute to search + style: form + explode: true + schema: + type: array + items: + type: string + - name: attrValuePrefix + in: query + description: The prefix for the attribute value to search + style: form + explode: true + schema: + type: array + items: + type: string + - name: tag + in: query + description: Limit the result to only entities tagged with the given tag + schema: + type: string + - name: sortBy + in: query + description: An attribute to sort by + schema: + type: string + - name: sortOrder + in: query + description: Sort order, either ASCENDING (default) or DESCENDING + schema: + type: string + enum: + - ASCENDING + - DESCENDING + - name: deleted + in: query + description: Whether to include deleted entities + schema: + type: boolean + - name: limit + in: query + description: Limit the result set to only include the specified number of entries + schema: + type: integer + format: int32 + - name: offset + in: query + description: Start offset of the result set (useful for pagination) + schema: + type: integer + format: int32 + tags: + - Search (v1) + responses: + '200': + description: On successful search query with some results, might return an empty list if execution succeeded without any results + content: + application/json: + schema: + $ref: '#/components/schemas/SearchResult' + '400': + description: Invalid wildcard or query parameters + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/search/basic: + get: + summary: Search by Fulltext Query + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve data for the specified fulltext query. + operationId: searchUsingBasic + parameters: + - name: query + in: query + description: The full-text query + schema: + type: string + - name: type + in: query + description: Limit the result to only entities of specified types + style: form + explode: true + schema: + type: array + items: + type: string + - name: attr + in: query + description: One of more additional attributes to return in the response + style: form + explode: true + schema: + type: array + items: + type: string + - name: tag + in: query + description: Limit the result to only entities tagged with the given tag + schema: + type: string + - name: sortBy + in: query + description: An attribute to sort by + schema: + type: string + - name: sortOrder + in: query + description: Sort order, either ASCENDING (default) or DESCENDING + schema: + type: string + enum: + - ASCENDING + - DESCENDING + - name: deleted + in: query + description: Whether to include deleted entities + schema: + type: boolean + - name: limit + in: query + description: Limit the result set to only include the specified number of entries + schema: + type: integer + format: int32 + - name: offset + in: query + description: Start offset of the result set (useful for pagination) + schema: + type: integer + format: int32 + tags: + - Search (v1) + responses: + '200': + description: On successful fulltext query with some results, might return an empty list if execution succeeded without any results + content: + application/json: + schema: + $ref: '#/components/schemas/SearchResult' + '400': + description: Invalid fulltext or query parameters + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/types/tagdefs: + get: + summary: Bulk Read Tag Definitions + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk retrieval API for retrieving tag definitions. + operationId: getAllTagDefs + parameters: + - name: prefix + in: query + description: The prefix of a tag definition name + schema: + type: string + tags: + - Types (v1) + responses: + '200': + description: The tag definitions + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagDefResponse' + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + put: + summary: Bulk Update Tag Definitions + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk update API for tag definitions. + tags: + - Types (v1) + operationId: updateTagDefs + requestBody: + description: The tag definitions to update + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagDef' + responses: + '200': + description: The tag definitions. Errored tag definitions will have an additional error property. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagDefResponse' + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + post: + summary: Bulk Create Tag Definitions + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Bulk create API for tag definitions. + tags: + - Types (v1) + operationId: createTagDefs + requestBody: + description: The tag definitions to create + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagDef' + responses: + '200': + description: The tag definitions. Errored tag definitions will have an additional error property. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagDefResponse' + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + /catalog/v1/types/tagdefs/{tagName}: + get: + summary: Read Tag Definition + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get the tag definition with the given name. + operationId: getTagDefByName + parameters: + - name: tagName + in: path + description: The name of the tag definiton + required: true + schema: + type: string + tags: + - Types (v1) + responses: + '200': + description: The tag definition + content: + application/json: + schema: + $ref: '#/components/schemas/TagDef' + '400': + description: Bad Request + '404': + description: Tag definition not found + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + delete: + summary: Delete Tag Definition + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete API for tag definition identified by its name. + operationId: deleteTagDef + parameters: + - name: tagName + in: path + description: The name of the tag definition + required: true + schema: + type: string + tags: + - Types (v1) + responses: + '204': + description: No Content + '400': + description: Bad Request + '429': + description: Rate Limit Error + '500': + description: Internal Server Error + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud +components: + schemas: + BusinessMetadataDefResponse: + properties: + category: + enum: + - PRIMITIVE + - OBJECT_ID_TYPE + - ENUM + - STRUCT + - CLASSIFICATION + - ENTITY + - ARRAY + - MAP + - RELATIONSHIP + - BUSINESS_METADATA + type: string + description: The category + guid: + type: string + description: The internal guid + createdBy: + type: string + description: The creator + updatedBy: + type: string + description: The updater + createTime: + format: int64 + type: integer + description: The create time + updateTime: + format: int64 + type: integer + description: The update time + version: + format: int32 + type: integer + description: The version + name: + type: string + description: The name + description: + type: string + description: The description + typeVersion: + type: string + description: The type version + serviceType: + type: string + description: The service type + options: + additionalProperties: + type: string + type: object + description: The options + attributeDefs: + items: + $ref: '#/components/schemas/AttributeDef' + type: array + description: The attribute definitions + error: + $ref: '#/components/schemas/ErrorMessage' + type: object + BusinessMetadataDef: + properties: + category: + enum: + - PRIMITIVE + - OBJECT_ID_TYPE + - ENUM + - STRUCT + - CLASSIFICATION + - ENTITY + - ARRAY + - MAP + - RELATIONSHIP + - BUSINESS_METADATA + type: string + description: The category + guid: + type: string + description: The internal guid + createdBy: + type: string + description: The creator + updatedBy: + type: string + description: The updater + createTime: + format: int64 + type: integer + description: The create time + updateTime: + format: int64 + type: integer + description: The update time + version: + format: int32 + type: integer + description: The version + name: + type: string + description: The name + description: + type: string + description: The description + typeVersion: + type: string + description: The type version + serviceType: + type: string + description: The service type + options: + additionalProperties: + type: string + type: object + description: The options + attributeDefs: + items: + $ref: '#/components/schemas/AttributeDef' + type: array + description: The attribute definitions + type: object + BusinessMetadata: + properties: + typeName: + type: string + description: The business metadata name + attributes: + type: string + description: The business metadata attributes (opaque JSON object) + entityType: + type: string + description: The entity type + entityName: + type: string + description: The qualified name of the entity + type: object + BusinessMetadataResponse: + properties: + typeName: + type: string + description: The business metadata name + attributes: + type: string + description: The business metadata attributes (opaque JSON object) + entityType: + type: string + description: The entity type + entityName: + type: string + description: The qualified name of the entity + error: + $ref: '#/components/schemas/ErrorMessage' + type: object + Tag: + type: object + properties: + typeName: + type: string + description: The tag name + attributes: + type: string + description: The tag attributes (opaque JSON object) + entityGuid: + type: string + description: The internal entity guid + entityStatus: + type: string + description: The entity status + enum: + - ACTIVE + - DELETED + - PURGED + propagate: + type: boolean + description: Whether to propagate the tag + validityPeriods: + type: array + description: The validity periods + items: + $ref: '#/components/schemas/TimeBoundary' + removePropagationsOnEntityDelete: + type: boolean + description: Whether to remove propagations on entity delete + entityType: + type: string + description: The entity type + entityName: + type: string + description: The qualified name of the entity + TagResponse: + type: object + properties: + typeName: + type: string + description: The tag name + attributes: + type: string + description: The tag attributes (opaque JSON object) + entityGuid: + type: string + description: The internal entity guid + entityStatus: + type: string + description: The entity status + enum: + - ACTIVE + - DELETED + - PURGED + propagate: + type: boolean + description: Whether to propagate the tag + validityPeriods: + type: array + description: The validity periods + items: + $ref: '#/components/schemas/TimeBoundary' + removePropagationsOnEntityDelete: + type: boolean + description: Whether to remove propagations on entity delete + entityType: + type: string + description: The entity type + entityName: + type: string + description: The qualified name of the entity + error: + $ref: '#/components/schemas/ErrorMessage' + EntityWithExtInfo: + type: object + properties: + referredEntities: + type: object + description: The referred entities + additionalProperties: + $ref: '#/components/schemas/Entity' + entity: + $ref: '#/components/schemas/Entity' + EntityPartialUpdateResponse: + type: object + properties: + mutatedEntities: + $ref: '#/components/schemas/EntityPartialUpdate' + description: The type name + SearchResult: + type: object + properties: + searchParameters: + $ref: '#/components/schemas/SearchParams' + types: + type: array + description: The types + items: + type: string + entities: + type: array + description: The entities + items: + $ref: '#/components/schemas/EntityHeader' + referredEntities: + type: object + description: The referred entities + additionalProperties: + $ref: '#/components/schemas/EntityHeader' + TagDefResponse: + type: object + properties: + category: + type: string + description: The category + enum: + - PRIMITIVE + - OBJECT_ID_TYPE + - ENUM + - STRUCT + - CLASSIFICATION + - ENTITY + - ARRAY + - MAP + - RELATIONSHIP + - BUSINESS_METADATA + guid: + type: string + description: The internal guid + createdBy: + type: string + description: The creator + updatedBy: + type: string + description: The updater + createTime: + type: integer + description: The create time + format: int64 + updateTime: + type: integer + description: The update time + format: int64 + version: + type: integer + description: The version + format: int32 + name: + type: string + description: The name + description: + type: string + description: The description + typeVersion: + type: string + description: The type version + serviceType: + type: string + description: The service type + options: + type: object + description: The options + additionalProperties: + type: string + attributeDefs: + type: array + description: The attribute definitions + items: + $ref: '#/components/schemas/AttributeDef' + superTypes: + uniqueItems: true + type: array + description: The supertypes + items: + type: string + entityTypes: + uniqueItems: true + type: array + description: The entity types + items: + type: string + subTypes: + uniqueItems: true + type: array + description: The subtypes + items: + type: string + error: + $ref: '#/components/schemas/ErrorMessage' + TagDef: + type: object + properties: + category: + type: string + description: The category + enum: + - PRIMITIVE + - OBJECT_ID_TYPE + - ENUM + - STRUCT + - CLASSIFICATION + - ENTITY + - ARRAY + - MAP + - RELATIONSHIP + - BUSINESS_METADATA + guid: + type: string + description: The internal guid + createdBy: + type: string + description: The creator + updatedBy: + type: string + description: The updater + createTime: + type: integer + description: The create time + format: int64 + updateTime: + type: integer + description: The update time + format: int64 + version: + type: integer + description: The version + format: int32 + name: + type: string + description: The name + description: + type: string + description: The description + typeVersion: + type: string + description: The type version + serviceType: + type: string + description: The service type + options: + type: object + description: The options + additionalProperties: + type: string + attributeDefs: + type: array + description: The attribute definitions + items: + $ref: '#/components/schemas/AttributeDef' + superTypes: + uniqueItems: true + type: array + description: The supertypes + items: + type: string + entityTypes: + uniqueItems: true + type: array + description: The entity types + items: + type: string + subTypes: + uniqueItems: true + type: array + description: The subtypes + items: + type: string + AttributeDef: + type: object + properties: + name: + type: string + description: The name + typeName: + type: string + description: The type name + isOptional: + type: boolean + description: Whether is optional + cardinality: + type: string + description: The cardinality + enum: + - SINGLE + - LIST + - SET + valuesMinCount: + type: integer + description: The values min count + format: int32 + valuesMaxCount: + type: integer + description: The values max count + format: int32 + isUnique: + type: boolean + description: Whether is unique + isIndexable: + type: boolean + description: Whether is indexable + includeInNotification: + type: boolean + description: Whether to include in notifications + defaultValue: + type: string + description: The default value + description: + type: string + description: The description + searchWeight: + type: integer + description: The search weight + format: int32 + indexType: + type: string + description: The index type + enum: + - DEFAULT + - STRING + constraints: + type: array + description: The constraints + items: + $ref: '#/components/schemas/ConstraintDef' + options: + type: object + description: The options + additionalProperties: + type: string + displayName: + type: string + description: The display name + ErrorMessage: + type: object + properties: + error_code: + type: integer + description: The error code + format: int32 + message: + type: string + description: The error message + description: Error message of this operation + TimeBoundary: + type: object + properties: + startTime: + type: string + description: The start time of format yyyy/MM/dd HH:mm:ss + endTime: + type: string + description: The end time of format yyyy/MM/dd HH:mm:ss + timeZone: + type: string + description: The time zone (see java.util.TimeZone) + Entity: + type: object + description: The entity + properties: + typeName: + type: string + description: The type name + attributes: + type: string + description: The type attributes (opaque JSON object) + guid: + type: string + description: The internal guid + homeId: + type: string + description: The home id + isProxy: + type: boolean + description: Whether is a proxy + writeOnly: true + isIncomplete: + type: boolean + description: Whether is incomplete + provenanceType: + type: integer + description: The provenance type + format: int32 + status: + type: string + description: The status + enum: + - ACTIVE + - DELETED + - PURGED + createdBy: + type: string + description: The creator + updatedBy: + type: string + description: The updater + createTime: + type: integer + description: The create time + format: int64 + updateTime: + type: integer + description: The update time + format: int64 + version: + type: integer + description: The version + format: int32 + relationshipAttributes: + type: string + description: The relationship attributes (opaque JSON object) + classifications: + type: array + description: The classifications (tags) + items: + $ref: '#/components/schemas/Classification' + meanings: + type: array + description: The meanings + items: + $ref: '#/components/schemas/TermAssignmentHeader' + customAttributes: + type: object + description: The custom attributes + additionalProperties: + type: string + businessAttributes: + type: object + description: The business attributes + additionalProperties: + type: string + description: (opaque JSON object) + labels: + uniqueItems: true + type: array + description: The labels + items: + type: string + proxy: + type: boolean + description: Whether is a proxy + EntityPartialUpdate: + type: object + properties: + UPDATE: + type: array + description: The updated entities. + items: + $ref: '#/components/schemas/PartialUpdateParams' + description: The updated entities. + SearchParams: + type: object + description: Search paramas to filter results + properties: + includeDeleted: + type: boolean + description: Whether to include deleted + limit: + type: integer + description: The limit + format: int32 + offset: + type: integer + description: The offset + format: int32 + EntityHeader: + type: object + properties: + typeName: + type: string + description: The type name + attributes: + type: object + description: The attributes + additionalProperties: true + guid: + type: string + description: The internal guid + status: + type: string + description: The status + enum: + - ACTIVE + - DELETED + - PURGED + displayText: + type: string + description: The display text + classificationNames: + type: array + description: The classification (tag) names + items: + type: string + classifications: + type: array + description: The classifications (tags) + items: + $ref: '#/components/schemas/Classification' + meaningNames: + type: array + description: The meaning names + items: + type: string + meanings: + type: array + description: The meanings + items: + $ref: '#/components/schemas/TermAssignmentHeader' + isIncomplete: + type: boolean + description: Whether is incomplete + labels: + uniqueItems: true + type: array + description: The labels + items: + type: string + ConstraintDef: + type: object + properties: + type: + type: string + description: The type + params: + type: object + description: The params + additionalProperties: + type: string + description: (opaque JSON object) + Classification: + type: object + properties: + typeName: + type: string + description: The tag name + attributes: + type: object + description: The tag attributes + additionalProperties: + type: string + description: (opaque JSON object) + entityGuid: + type: string + description: The internal entity guid + entityStatus: + type: string + description: The entity status + enum: + - ACTIVE + - DELETED + - PURGED + propagate: + type: boolean + description: Whether to propagate the tag + validityPeriods: + type: array + description: The validity periods + items: + $ref: '#/components/schemas/TimeBoundary' + removePropagationsOnEntityDelete: + type: boolean + description: Whether to remove propagations on entity delete + TermAssignmentHeader: + type: object + properties: + termGuid: + type: string + description: The term guid + relationGuid: + type: string + description: The relation guid + description: + type: string + description: The description + displayText: + type: string + description: The display text + expression: + type: string + description: The expression + createdBy: + type: string + description: The creator + steward: + type: string + description: The steward + source: + type: string + description: The source + confidence: + type: integer + description: The confidence + format: int32 + status: + type: string + description: The status + enum: + - DISCOVERED + - PROPOSED + - IMPORTED + - VALIDATED + - DEPRECATED + - OBSOLETE + - OTHER + PartialUpdateParams: + type: object + properties: + typeName: + type: string + description: The type name + attributes: + type: string + description: The attributes (opaque JSON object) + guid: + type: string + description: The internal guid + status: + type: string + description: The status + enum: + - ACTIVE + - DELETED + - PURGED + classificationNames: + type: array + description: The classification (tag) names + items: + type: string + classifications: + type: array + description: The classifications (tags) + items: + $ref: '#/components/schemas/ClassificationHeader' + isIncomplete: + type: boolean + description: Whether is incomplete + ClassificationHeader: + type: object + properties: + typeName: + type: string + description: The tag name + entityGuid: + type: string + description: The internal entity guid + entityStatus: + type: string + description: The entity status + enum: + - ACTIVE + - DELETED + - PURGED + propagate: + type: boolean + description: Whether to propagate the tag + removePropagationsOnEntityDelete: + type: boolean + description: Whether to remove propagations on entity delete +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/ccl.yaml b/provider-dev/source/ccl.yaml new file mode 100644 index 0000000..7763037 --- /dev/null +++ b/provider-dev/source/ccl.yaml @@ -0,0 +1,2326 @@ +openapi: 3.0.0 +info: + title: ccl API + description: confluent ccl API + version: 1.0.0 +paths: + /ccl/v1/custom-code-loggings: + get: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + operationId: listCclV1CustomCodeLoggings + summary: List of Custom Code Loggings + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Custom Code Logging API EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Retrieve a sorted, filtered, paginated list of all custom code loggings. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Custom Code Loggings (ccl/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Code Logging. + content: + application/json: + schema: + type: object + description: |- + CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Code Logging. + + + ## The Custom Code Loggings Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ccl/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLoggingList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Code Logging. + + + ## The Custom Code Loggings Model + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: The kafka cluster id where Custom Code Logging is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - cloud + - region + - destination_settings + - environment + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + operationId: createCclV1CustomCodeLogging + summary: Create a Custom Code Logging + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Custom Code Logging API EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to create a custom code logging. + tags: + - Custom Code Loggings (ccl/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Code Logging. + + + ## The Custom Code Loggings Model + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: The kafka cluster id where Custom Code Logging is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - cloud + - region + - destination_settings + - environment + responses: + '201': + description: A Custom Code Logging was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/ccl/v1/custom-code-loggings/{id} + description: CustomCodeLogging resource uri + content: + application/json: + schema: + type: object + description: |- + CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Code Logging. + + + ## The Custom Code Loggings Model + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: The kafka cluster id where Custom Code Logging is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - cloud + - region + - destination_settings + - environment + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + /ccl/v1/custom-code-loggings/{id}: + get: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + operationId: getCclV1CustomCodeLogging + summary: Read a Custom Code Logging + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Custom Code Logging API EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to read a custom code logging. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom code logging. + tags: + - Custom Code Loggings (ccl/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Code Logging. + content: + application/json: + schema: + type: object + description: |- + CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Code Logging. + + + ## The Custom Code Loggings Model + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: The kafka cluster id where Custom Code Logging is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - cloud + - region + - destination_settings + - environment + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + operationId: updateCclV1CustomCodeLogging + summary: Update a Custom Code Logging + description: |+ + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Custom Code Logging API EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to update a custom code logging. + + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom code logging. + tags: + - Custom Code Loggings (ccl/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Code Logging. + + + ## The Custom Code Loggings Model + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: The kafka cluster id where Custom Code Logging is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - environment + responses: + '200': + description: Custom Code Logging. + content: + application/json: + schema: + type: object + description: |- + CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Code Logging. + + + ## The Custom Code Loggings Model + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: The kafka cluster id where Custom Code Logging is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - cloud + - region + - destination_settings + - environment + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA + operationId: deleteCclV1CustomCodeLogging + summary: Delete a Custom Code Logging + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Custom Code Logging API EA](https://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540)](mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to delete a custom code logging. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom code logging. + tags: + - Custom Code Loggings (ccl/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Custom Code Logging is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Custom Code Logging API EA +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + ccl.v1.CustomCodeLoggingList: + type: object + description: |- + CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Code Logging. + + + ## The Custom Code Loggings Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ccl/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLoggingList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Code Logging. + + + ## The Custom Code Loggings Model + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: The kafka cluster id where Custom Code Logging is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - cloud + - region + - destination_settings + - environment + uniqueItems: true + ccl.v1.CustomCodeLogging: + type: object + description: |- + CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Code Logging. + + + ## The Custom Code Loggings Model + + properties: + api_version: + type: string + enum: + - ccl/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomCodeLogging + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Custom Code Logging is sent. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + maxLength: 60 + x-immutable: true + region: + type: string + description: The Cloud provider region the Custom Code Logging is sent. + example: us-west-2 + maxLength: 60 + x-immutable: true + destination_settings: + type: object + description: Destination Settings of the Custom Code Logging. + discriminator: + propertyName: kind + mapping: + Kafka: '#/components/schemas/ccl.v1.KafkaDestinationSettings' + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: The kafka cluster id where Custom Code Logging is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + ccl.v1.KafkaDestinationSettings: + type: object + description: | + Kafka Destination Settings of the Custom Code Logging. + properties: + kind: + type: string + description: The destination where Custom Code Logging is sent. + enum: + - Kafka + cluster_id: + type: string + example: lkc-123 + maxLength: 255 + description: The kafka cluster id where Custom Code Logging is sent. + topic: + type: string + example: topic-123 + maxLength: 255 + description: The kafka topic where Custom Code Logging is sent. + log_level: + type: string + example: INFO + default: INFO + description: Minimum log level for Custom Code Logging. + x-extensible-enum: + - ERROR + - WARN + - INFO + - DEBUG + maxLength: 60 + required: + - kind + - cluster_id + - topic + EnvScopedObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/ccpm.yaml b/provider-dev/source/ccpm.yaml new file mode 100644 index 0000000..32e9154 --- /dev/null +++ b/provider-dev/source/ccpm.yaml @@ -0,0 +1,3074 @@ +openapi: 3.0.0 +info: + title: ccpm API + description: confluent ccpm API + version: 1.0.0 +paths: + /ccpm/v1/plugins: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCcpmV1CustomConnectPlugins + summary: List of Custom Connect Plugins + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all custom connect plugins. + + If no `cloud` filter is specified, returns custom connect plugins from all clouds. + parameters: + - name: spec.cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for spec.cloud. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Custom Connect Plugins (ccpm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Connect Plugin. + content: + application/json: + schema: + type: object + description: |- + CustomConnectPlugins objects represent Custom Connect artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugins. + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connect Plugins Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + CustomConnectPlugins objects represent Custom Connect artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugins. + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connect Plugins Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + required: + - id + - metadata + - spec + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-page-first-available: true + x-page-last-available: true + x-page-from-start: true + x-page-from-end: true + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createCcpmV1CustomConnectPlugin + summary: Create a Custom Connect Plugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a custom connect plugin. + tags: + - Custom Connect Plugins (ccpm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + CustomConnectPlugins objects represent Custom Connect artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugins. + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connect Plugins Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + required: + - spec + responses: + '202': + description: A Custom Connect Plugin is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/ccpm/v1/plugins/{id} + description: CustomConnectPlugin resource uri + content: + application/json: + schema: + type: object + description: |- + CustomConnectPlugins objects represent Custom Connect artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugins. + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connect Plugins Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + required: + - spec + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /ccpm/v1/plugins/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCcpmV1CustomConnectPlugin + summary: Read a Custom Connect Plugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a custom connect plugin. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connect plugin. + tags: + - Custom Connect Plugins (ccpm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Connect Plugin. + content: + application/json: + schema: + type: object + description: |- + CustomConnectPlugins objects represent Custom Connect artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugins. + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connect Plugins Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateCcpmV1CustomConnectPlugin + summary: Update a Custom Connect Plugin + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a custom connect plugin. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connect plugin. + tags: + - Custom Connect Plugins (ccpm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + CustomConnectPlugins objects represent Custom Connect artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugins. + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connect Plugins Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + required: + - spec + responses: + '200': + description: Custom Connect Plugin. + content: + application/json: + schema: + type: object + description: |- + CustomConnectPlugins objects represent Custom Connect artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugins. + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connect Plugins Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteCcpmV1CustomConnectPlugin + summary: Delete a Custom Connect Plugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a custom connect plugin. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connect plugin. + tags: + - Custom Connect Plugins (ccpm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Custom Connect Plugin is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /ccpm/v1/presigned-upload-url: + post: + summary: Request a presigned upload URL for a new Custom Connect Plugin. + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Request a presigned upload URL to upload a Custom Connect Plugin archive. + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createCcpmV1PresignedUrl + tags: + - Presigned Urls (ccpm/v1) + security: + - cloud-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + Request a presigned upload URL for new Custom Connect Plugin. Note that + the URL policy expires in one hour. If the policy expires, you can request + a new presigned upload URL. + + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Presigned Urls Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Custom Connect Plugin archive. + example: ZIP + x-extensible-enum: + - ZIP + - JAR + cloud: + type: string + description: Cloud provider where the Custom Connect Plugin archive is uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Custom Connect Plugin archive. + example: https://confluent-custom-connectors-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: string + description: Upload form data of the Custom Connect Plugin. All values should be strings. (opaque JSON object) + example: + bucket: confluent-custom-connectors-stag-us-west-2 + key: staging/custom-plugin/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/connect-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/plugin.zip + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - content_format + - cloud + - environment + responses: + '201': + description: A Presigned Url was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/ccpm/v1/presigned-upload-url/{id} + description: PresignedUrl resource uri + content: + application/json: + schema: + type: object + description: |- + Request a presigned upload URL for new Custom Connect Plugin. Note that + the URL policy expires in one hour. If the policy expires, you can request + a new presigned upload URL. + + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Presigned Urls Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Custom Connect Plugin archive. + example: ZIP + x-extensible-enum: + - ZIP + - JAR + cloud: + type: string + description: Cloud provider where the Custom Connect Plugin archive is uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Custom Connect Plugin archive. + example: https://confluent-custom-connectors-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: string + description: Upload form data of the Custom Connect Plugin. All values should be strings. (opaque JSON object) + example: + bucket: confluent-custom-connectors-stag-us-west-2 + key: staging/custom-plugin/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/connect-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/plugin.zip + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - content_format + - cloud + - environment + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /ccpm/v1/plugins/{plugin_id}/versions: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCcpmV1CustomConnectPluginVersions + summary: List of Custom Connect Plugin Versions + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all custom connect plugin versions. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: plugin_id + in: path + required: true + schema: + type: string + description: The Plugin + tags: + - Custom Connect Plugin Versions (ccpm/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Custom Connect Plugin Version. + content: + application/json: + schema: + type: object + description: |- + CustomConnectPluginVersion objects represent Custom Connect Plugin Versions on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugin Versions. + + + ## The Custom Connect Plugin Versions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + CustomConnectPluginVersion objects represent Custom Connect Plugin Versions on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugin Versions. + + + ## The Custom Connect Plugin Versions Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersion + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionSpec' + status: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createCcpmV1CustomConnectPluginVersion + summary: Create a Custom Connect Plugin Version + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a custom connect plugin version. + parameters: + - name: plugin_id + in: path + required: true + schema: + type: string + description: The Plugin + tags: + - Custom Connect Plugin Versions (ccpm/v1) + security: + - cloud-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + CustomConnectPluginVersion objects represent Custom Connect Plugin Versions on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugin Versions. + + + ## The Custom Connect Plugin Versions Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersion + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionSpec' + status: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionStatus' + required: + - spec + responses: + '202': + description: A Custom Connect Plugin Version is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/ccpm/v1/plugins/{plugin_id}/versions/{id} + description: CustomConnectPluginVersion resource uri + content: + application/json: + schema: + type: object + description: |- + CustomConnectPluginVersion objects represent Custom Connect Plugin Versions on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugin Versions. + + + ## The Custom Connect Plugin Versions Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersion + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionSpec' + status: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /ccpm/v1/plugins/{plugin_id}/versions/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCcpmV1CustomConnectPluginVersion + summary: Read a Custom Connect Plugin Version + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a custom connect plugin version. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: plugin_id + in: path + required: true + schema: + type: string + description: The Plugin + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connect plugin version. + tags: + - Custom Connect Plugin Versions (ccpm/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Custom Connect Plugin Version. + content: + application/json: + schema: + type: object + description: |- + CustomConnectPluginVersion objects represent Custom Connect Plugin Versions on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugin Versions. + + + ## The Custom Connect Plugin Versions Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersion + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionSpec' + status: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteCcpmV1CustomConnectPluginVersion + summary: Delete a Custom Connect Plugin Version + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a custom connect plugin version. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: plugin_id + in: path + required: true + schema: + type: string + description: The Plugin + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connect plugin version. + tags: + - Custom Connect Plugin Versions (ccpm/v1) + security: + - cloud-api-key: [] + responses: + '204': + description: A Custom Connect Plugin Version is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + ccpm.v1.CustomConnectPluginList: + type: object + description: |- + CustomConnectPlugins objects represent Custom Connect artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugins. + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connect Plugins Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + CustomConnectPlugins objects represent Custom Connect artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugins. + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connect Plugins Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + required: + - id + - metadata + - spec + uniqueItems: true + ccpm.v1.CustomConnectPlugin: + type: object + description: |- + CustomConnectPlugins objects represent Custom Connect artifacts containing connector, and SMT jars on Confluent + Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugins. + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connect Plugins Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginSpec' + ccpm.v1.PresignedUrl: + type: object + description: |- + Request a presigned upload URL for new Custom Connect Plugin. Note that + the URL policy expires in one hour. If the policy expires, you can request + a new presigned upload URL. + + Related guide: + [Custom Connect Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Presigned Urls Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Custom Connect Plugin archive. + example: ZIP + x-extensible-enum: + - ZIP + - JAR + cloud: + type: string + description: Cloud provider where the Custom Connect Plugin archive is uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Custom Connect Plugin archive. + example: https://confluent-custom-connectors-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: string + description: Upload form data of the Custom Connect Plugin. All values should be strings. (opaque JSON object) + example: + bucket: confluent-custom-connectors-stag-us-west-2 + key: staging/custom-plugin/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/connect-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/plugin.zip + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + ccpm.v1.CustomConnectPluginVersionList: + type: object + description: |- + CustomConnectPluginVersion objects represent Custom Connect Plugin Versions on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugin Versions. + + + ## The Custom Connect Plugin Versions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + CustomConnectPluginVersion objects represent Custom Connect Plugin Versions on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugin Versions. + + + ## The Custom Connect Plugin Versions Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersion + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionSpec' + status: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + ccpm.v1.CustomConnectPluginVersion: + type: object + description: |- + CustomConnectPluginVersion objects represent Custom Connect Plugin Versions on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connect Plugin Versions. + + + ## The Custom Connect Plugin Versions Model + + properties: + api_version: + type: string + enum: + - ccpm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectPluginVersion + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionSpec' + status: + $ref: '#/components/schemas/ccpm.v1.CustomConnectPluginVersionStatus' + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + ccpm.v1.CustomConnectPluginSpec: + type: object + description: The desired state of the Custom Connect Plugin + properties: + cloud: + type: string + description: Cloud provider where the Custom Connect Plugin archive is uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + display_name: + type: string + description: Display name of Custom Connect Plugin. + maxLength: 60 + description: + type: string + description: Description of Custom Connect Plugin. + maxLength: 256 + runtime_language: + type: string + example: JAVA + description: Runtime language of Custom Connect Plugin. + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + EnvScopedObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + ccpm.v1.CustomConnectPluginVersionSpec: + type: object + description: The desired state of the Custom Connect Plugin Version + properties: + version: + type: string + description: | + Version of the Custom Connect Plugin. + The version must comply with SemVer (e.g., `1.2.3`, `1.2.3-beta`, `1.2.3-rc.123`, `1.2.3-rc.123+build.456`). + maxLength: 60 + x-immutable: true + sensitive_config_properties: + type: array + description: | + A sensitive property is a connector configuration property that must be hidden after a user enters property + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + x-immutable: true + documentation_link: + type: string + maxLength: 512 + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connect Plugin. + x-immutable: true + content_format: + type: string + example: ZIP + description: Archive format of Custom Connect Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + connector_classes: + type: array + description: | + List of connector classes. + The connector class must be a valid Java class name or alias for the connector. + You can get the connector class from the connector documentation provided by the developer. + items: + $ref: '#/components/schemas/ccpm.v1.ConnectorClass' + minItems: 1 + maxItems: 10 + x-immutable: true + upload_source: + type: object + description: | + Upload source of Custom Connect Plugin Version. Only required in `create` request, + will be ignored in `read`, `update` or `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/ccpm.v1.UploadSource.PresignedUrl' + x-immutable: true + properties: + location: + type: string + description: | + Location of the Custom Connect Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: Upload ID returned by the `/presigned-upload-url` API. This field returns an empty string in all responses. + required: + - location + - upload_id + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + ccpm.v1.CustomConnectPluginVersionStatus: + type: object + required: + - phase + description: The status of the Custom Connect Plugin Version + properties: + phase: + type: string + maxLength: 50 + x-extensible-enum: + - PROCESSING + - READY + - FAILED + description: Phase of the Custom Connect Plugin Version. + x-immutable: true + example: PROCESSING + error_message: + type: string + maxLength: 256 + description: Displayable error message if version is in a failed state + x-immutable: true + example: Version creation failed due to invalid plugin archive. + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + ccpm.v1.ConnectorClass: + type: object + description: | + Java class of the Connector. + properties: + class_name: + type: string + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: Java class or alias for connector. You can get connector class from connector documentation provided by developer. + x-immutable: true + example: io.confluent.kafka.connect.datagen.DatagenConnector + type: + type: string + description: | + Type of the connector class. Should be either `SOURCE` or `SINK`. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + required: + - class_name + - type + ccpm.v1.UploadSource.PresignedUrl: + type: object + description: Presigned URL of the uploaded Custom Connect Plugin archive. + properties: + location: + type: string + description: | + Location of the Custom Connect Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: Upload ID returned by the `/presigned-upload-url` API. This field returns an empty string in all responses. + required: + - location + - upload_id + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/connect.yaml b/provider-dev/source/connect.yaml new file mode 100644 index 0000000..316eabc --- /dev/null +++ b/provider-dev/source/connect.yaml @@ -0,0 +1,5621 @@ +openapi: 3.0.0 +info: + title: connect API + description: confluent connect API + version: 1.0.0 +paths: + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors: + get: + x-lifecycle-stage: General Availability + operationId: listConnectv1Connectors + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a list of "names" of the active connectors. You can then make a [read request](#operation/readConnectv1Connector) for a specific connector by name. + summary: List of Connectors + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + parameters: [] + responses: + '200': + description: Connector. + content: + application/json: + schema: + type: array + description: List of connector names + items: + type: string + description: Connector name + example: + - MyGcsLogsBucketConnector + - MyS3BucketConnector + - MyDatagenConnector + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + post: + x-lifecycle-stage: General Availability + operationId: createConnectv1Connector + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Create a new connector. Returns the new connector information if successful. + summary: Create a Connector + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorWithOffsets' + example: + name: MyGcsLogsBucketConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '1' + time.interval: DAILY + topics: APILogsTopic + tasks: + - connector: MyGcsLogsBucketConnector + task: 0 + type: sink + offsets: + - partition: + kafka_partition: 0 + kafka_topic: APILogsTopic + offset: + kafka_offset: 1000 + headers: {} + '400': + description: Bad Request + content: + application/json: + schema: + type: object + properties: + code: + type: integer + message: + type: string + example: + error: + code: 400 + message: Unauthorized + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error + content: + application/json: + schema: + type: object + properties: + error_code: + type: integer + message: + type: string + example: + error_code: 500 + message: Failed to find any class that implements Connector and which name matches io.confluent.connect.... + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: Name of the connector to create. + config: + type: object + description: Configuration parameters for the connector. All values should be strings. + x-redact: true + required: + - connector.class + - name + - kafka.api.key + - kafka.api.secret + properties: + connector.class: + type: string + description: \[Required for Managed Connector, Ignored for Custom Connector\] The connector class name, e.g., BigQuerySink, GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. For custom connector, it must be the same as the name of the connector to create. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + confluent.connector.type: + type: string + description: | + \[Required for Custom Connector\] The connector type. + example: CUSTOM + default: MANAGED + x-extensible-enum: + - CUSTOM + - MANAGED + confluent.custom.plugin.id: + type: string + example: ccp-lq5m06 + description: | + \[Required for Custom Connector\] The custom plugin id of custom connector, e.g., `ccp-lq5m06` + confluent.custom.connection.endpoints: + type: string + description: | + \[Optional for Custom Connector\] Egress endpoint(s) for the connector to use when attaching to the sink or source data system. + confluent.custom.schema.registry.auto: + type: string + description: | + \[Optional for Custom Connector\] Automatically add the required schema registry properties in a custom connector config if schema registry is enabled. + example: 'FALSE' + default: 'FALSE' + x-extensible-enum: + - 'TRUE' + - 'FALSE' + confluent.custom.connect.plugin.runtime: + type: string + description: | + \[Optional for Custom Connector\] The runtime of the custom connector plugin. + example: 3.9.0 + confluent.custom.connect.java.version: + type: string + description: | + \[Optional for Custom Connector\] The Java version of the custom connector plugin. + example: '17' + additionalProperties: + type: string + description: Other configuration parameters for the connector. All values should be strings. See the connector's docs for details. + offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + examples: + sink: + value: + name: MyGcsLogsBucketConnector + config: + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + offsets: + - partition: + kafka_partition: 0 + kafka_topic: APILogsTopic + offset: + kafka_offset: 1000 + source: + value: + name: MySqlCdcSourceV2Connector_0 + config: + connector.class: MySqlCdcSourceV2 + output.data.format: JSON + flush.size: '1000' + database.hostname: 12.34.567.98 + database.password: '****************' + database.port: '1234' + database.user: '****' + kafka.api.key: '****************' + kafka.api.secret: '****************' + name: MySqlCdcSourceV2Connector_0 + tasks.max: '1' + time.interval: DAILY + topic.prefix: test + offsets: + - partition: + server: test + offset: + file: mysql-bin.000123 + pos: 154 + ts_sec: 1712907333 + description: '' + x-lifecycle-stage: General Availability + parameters: + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id: + get: + x-lifecycle-stage: General Availability + operationId: listConnectv1ConnectorsWithExpansions + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve an object with the queried expansions of all connectors. Without `expand` query parameter, this list connector’s endpoint will return a [list of only the connector names](#operation/listConnectv1Connectors). + summary: List of Connectors with Expansions + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector. + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorExpansionMap' + example: + MyGcsLogsBucketConnector: + id: + id: lcc-xxxxx + id_type: ID + info: + name: MyGcsLogsBucketConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '1' + time.interval: DAILY + topics: APILogsTopic + type: sink + status: + name: MyGcsLogsBucketConnector + connector: + state: PROVISIONING + worker_id: MyGcsLogsBucketConnector + trace: '' + tasks: [] + type: sink + MyS3BucketConnector: + id: + id: lcc-xxxxx + id_type: ID + info: + name: MyS3BucketConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: S3Sink + data.format: BYTES + flush.size: '1000' + s3.bucket: APILogsBucket + aws.access.key.id: '************' + aws.secret.access.key: '**********' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyS3BucketConnector + tasks.max: '1' + time.interval: DAILY + topics: APILogsTopic + type: source + status: + name: MyS3BucketConnector + connector: + state: FAILED + worker_id: MyS3BucketConnector + trace: | + There were some errors with your configuration: + topics: Provided Kafka ApiKey is invalid + kafka.api.secret: Provided Kafka ApiKey is invalid + tasks: [] + type: sink + MyDatagenConnector: + id: + id: lcc-xxxxx + id_type: ID + info: + name: MyDatagenConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: DatagenSource + data.format: BYTES + flush.size: '1000' + quickstart: ORDERS + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyDatagenConnector + tasks.max: '1' + time.interval: DAILY + topics: APILogsTopic + type: source + status: + name: MyDatagenConnector + connector: + state: RUNNING + worker_id: MyDatagenConnector + trace: '' + tasks: + - id: 0 + msg: '' + state: RUNNING + worker_id: MyDatagenConnector + type: source + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + - name: expand + in: query + description: |- + - id : Returns metadata of each connector such as id and id type. + - info : Returns metadata of each connector such as the configuration, task + information, and type of connector. + - status : Returns additional state information of each connector including their status and tasks. + schema: + type: string + enum: + - id + - info + - status + x-lifecycle-stage: General Availability + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config: + get: + x-lifecycle-stage: General Availability + operationId: getConnectv1ConnectorConfig + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get the configuration for the connector. + summary: Read a Connector Configuration + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector. + content: + application/json: + schema: + type: object + description: Configuration parameters for the connector. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: + - aws + - azure + - gcp + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. For Custom Connector, it must be the same as connector_name. + kafka.endpoint: + type: string + description: The kafka cluster endpoint. + kafka.region: + type: string + description: The kafka cluster region. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + additionalProperties: + type: string + description: Other configuration parameters for the connector. See the connector's docs for the list of options. + example: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + put: + x-lifecycle-stage: General Availability + operationId: createOrUpdateConnectv1ConnectorConfig + description: Create a new connector using the given configuration, or update the configuration for an existing connector. Returns information about the connector after the change has been made. + summary: Create or Update a Connector Configuration + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: Configuration parameters for the connector. + required: + - connector.class + - name + - kafka.api.key + - kafka.api.secret + properties: + connector.class: + type: string + description: \[Required for Managed Connector, Ignored for Custom Connector\] The connector class name. E.g. BigQuerySink, GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + confluent.connector.type: + type: string + description: | + \[Required for Custom Connector\] The connector type. + example: CUSTOM + default: MANAGED + x-extensible-enum: + - CUSTOM + - MANAGED + confluent.custom.plugin.id: + type: string + example: ccp-lq5m06 + description: | + \[Required for Custom Connector\] The custom plugin id of custom connector, e.g., `ccp-lq5m06` + confluent.custom.connection.endpoints: + type: string + description: | + \[Optional for Custom Connector\] Egress endpoint(s) for the connector to use when attaching to the sink or source data system. + confluent.custom.schema.registry.auto: + type: string + description: | + \[Optional for Custom Connector\] Automatically add the required schema registry properties in a custom connector config if schema registry is enabled. + example: 'FALSE' + default: 'FALSE' + x-extensible-enum: + - 'TRUE' + - 'FALSE' + confluent.custom.connect.plugin.runtime: + type: string + description: | + \[Optional for Custom Connector\] The runtime of the custom connector plugin. By default this is the latest version available. If not provided this config is updated internally to reflect the version used. + example: 3.9.0 + confluent.custom.connect.java.version: + type: string + description: | + \[Optional for Custom Connector\] The Java version of the custom connector plugin. By default this is the latest version supported by the latest runtime. If not provided this config is updated internally to reflect the version used. + example: '17' + additionalProperties: + type: string + description: Other configuration parameters for the connector. All values should be strings. See the connector's docs for details. + example: + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + description: Configuration parameters for the connector. All values should be strings. + responses: + '200': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.Connector' + example: + name: MyGcsLogsBucketConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + tasks: + - connector: MyGcsLogsBucketConnector + task: 0 + - connector: MyGcsLogsBucketConnector + task: 1 + type: sink + '400': + $ref: '#/components/responses/connect.v1.BadRequestError' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error + content: + application/json: + schema: + type: object + properties: + error_code: + type: integer + message: + type: string + example: + error_code: 500 + message: Failed to find any class that implements Connector and which name matches io.confluent.connect.... + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}: + get: + x-lifecycle-stage: General Availability + operationId: readConnectv1Connector + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get information about the connector. + summary: Read a Connector + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector. + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.Connector' + example: + name: MyGcsLogsBucketConnector + config: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '1' + time.interval: DAILY + topics: APILogsTopic + tasks: + - connector: MyGcsLogsBucketConnector + task: 0 + type: sink + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + operationId: deleteConnectv1Connector + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete a connector. Halts all tasks and deletes the connector configuration. + summary: Delete a Connector + tags: + - Connectors (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + $ref: '#/components/responses/connect.v1.OK' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause: + put: + x-lifecycle-stage: General Availability + operationId: pauseConnectv1Connector + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Pause the connector and its tasks. Stops message processing until the connector is resumed. This call is asynchronous and the tasks will not transition to PAUSED state at the same time. + summary: Pause a Connector + tags: + - Lifecycle (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '202': + description: Accepted + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume: + put: + x-lifecycle-stage: General Availability + operationId: resumeConnectv1Connector + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Resume a paused connector or do nothing if the connector is not paused. This call is asynchronous and the tasks will not transition to RUNNING state at the same time. + summary: Resume a Connector + tags: + - Lifecycle (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '202': + description: Accepted + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart: + post: + x-lifecycle-stage: Preview + operationId: restartConnectv1Connector + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + Restart the connector and its tasks. Stops message processing until the connector and tasks are restart. This call is asynchronous and the connector will not transition to another state at the same time. + summary: Restart a Connector + tags: + - Lifecycle (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '202': + description: Accepted + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '403': + $ref: '#/components/responses/connect.v1.ForbiddenError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: Preview + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status: + get: + x-lifecycle-stage: General Availability + operationId: readConnectv1ConnectorStatus + description: Get current status of the connector. This includes whether it is running, failed, or paused. Also includes which worker it is assigned to, error information if it has failed, and the state of all its tasks. + summary: Read a Connector Status + tags: + - Status (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the connector. + type: + type: string + description: Type of connector, sink or source. + enum: + - sink + - source + connector: + type: object + description: The map containing connector status. + required: + - state + - worker_id + properties: + state: + type: string + description: The state of the connector. + enum: + - NONE + - PROVISIONING + - RUNNING + - DEGRADED + - FAILED + - PAUSED + - DELETED + worker_id: + type: string + description: The worker ID of the connector. + trace: + type: string + description: The exception name in case of error. + tasks: + type: array + description: The map containing the task status. + items: + type: object + properties: + id: + type: integer + description: The ID of task. + state: + type: string + description: The state of the task. + worker_id: + type: string + description: The worker ID of the task. + msg: + type: string + required: + - id + - state + - worker_id + required: + - name + - type + - connector + example: + name: MyGcsLogsBucketConnector + connector: + state: PROVISIONING + worker_id: MyGcsLogsBucketConnector + trace: '' + tasks: [] + type: source + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks: + get: + x-lifecycle-stage: General Availability + operationId: listConnectv1ConnectorTasks + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get a list of tasks currently running for the connector. + summary: List of Connector Tasks + tags: + - Status (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector Task. + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.Connectors' + example: + - id: + connector: MyGcsLogsBucketConnector + task: 2 + config: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '1000' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins: + get: + x-lifecycle-stage: General Availability + operationId: listConnectv1ConnectorPlugins + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return a list of Managed Connector plugins installed in the Kafka Connect cluster. + summary: List of Managed Connector plugins + tags: + - Managed Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector Plugin. + content: + application/json: + schema: + type: array + items: + type: object + properties: + class: + type: string + description: The connector class name. E.g. BigQuerySink. + type: + type: string + description: Type of connector, sink or source. + enum: + - sink + - source + version: + type: string + description: The version string for the connector available. + required: + - class + - type + example: + - class: BigQuerySink + type: sink + - class: KinesisSource + type: source + version: 0.1.0 + - class: PostgresSource + type: source + version: 0.1.0 + - class: S3_SINK + type: sink + - class: GcsSink + type: sink + version: 0.2.0 + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: [] + x-lifecycle-stage: General Availability + parameters: + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate: + put: + x-lifecycle-stage: General Availability + operationId: validateConnectv1ConnectorPlugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Validate the provided configuration values against the configuration definition. This API performs per config validation and returns suggested values and validation error messages. + summary: Validate a Managed Connector Plugin + tags: + - Managed Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector Plugin. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The class name of the connector plugin. + groups: + type: array + description: The list of groups used in configuration definitions. + items: + type: string + error_count: + type: integer + description: The total number of errors encountered during configuration validation. + configs: + type: array + items: + type: object + properties: + definition: + type: object + description: The definition for a config in the connector plugin, which includes the name, type, importance, etc. + properties: + name: + type: string + description: The name of the configuration + type: + type: string + enum: + - NONE + - BOOLEAN + - INT + - SHORT + - LONG + - DOUBLE + - STRING + - LIST + - ENUM + - PASSWORD + description: The config types + required: + type: boolean + description: Whether this configuration is required + default_value: + type: string + description: Default value for this configuration + importance: + type: string + enum: + - NONE + - HIGH + - MEDIUM + - LOW + description: The importance level for a configuration + documentation: + type: string + description: The documentation for the configuration + group: + type: string + description: The UI group to which the configuration belongs to + width: + type: string + enum: + - NONE + - SHORT + - MEDIUM + - LONG + description: The width of a configuration value + display_name: + type: string + dependents: + type: array + description: Other configurations on which this configuration is dependent + items: + type: string + order: + type: integer + description: The order of configuration in specified group + alias: + type: string + value: + type: object + description: The current value for a config, which includes the name, value, recommended values, etc. + properties: + name: + type: string + description: The name of the configuration + value: + type: string + description: The value for the configuration + recommended_values: + type: array + description: The list of valid values for the configuration + items: + type: string + errors: + type: array + description: Errors, if any, in the configuration value + items: + type: string + visible: + type: boolean + description: |- + The visibility of the configuration. Based on the values of other configuration + fields, this visibility boolean value points out if the current field should be + visible or not. + metadata: + type: string + description: |- + Map of metadata details about the connector configuration, such as type of + input, etc. (opaque JSON object) + example: + name: io.confluent.connect.gcs.GcsSinkConnector + groups: + - Organize my data by... + - Which topics do you want to get data from? + - Messages + - How should we connect to your data? + - Google Cloud Storage details + - Kafka Cluster credentials + - Number of tasks for this connector + error_count: 1 + configs: + - definition: + name: name + type: STRING + required: true + default_value: '' + importance: HIGH + documentation: Sets a name for your connector. + group: How should we connect to your data? + width: NONE + display_name: Connector name + dependents: [] + order: 2 + alias: '' + value: + name: name + value: '{{.logicalClusterId}}' + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: connector.class + type: STRING + required: true + default_value: '' + importance: HIGH + documentation: '' + group: How should we connect to your data? + width: NONE + display_name: Connector class + dependents: [] + order: 1 + alias: '' + value: + name: connector.class + value: io.confluent.connect.gcs.GcsSinkConnector + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: kafka.api.key + type: PASSWORD + required: true + default_value: '' + importance: HIGH + documentation: '' + group: Kafka Cluster credentials + width: NONE + display_name: Kafka API Key + dependents: [] + order: 1 + alias: '' + value: + name: kafka.api.key + value: '' + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: kafka.api.secret + type: PASSWORD + required: true + default_value: '' + importance: HIGH + documentation: '' + group: Kafka Cluster credentials + width: NONE + display_name: Kafka API Secret + dependents: + - kafka.api.key + order: 2 + alias: '' + value: + name: kafka.api.secret + value: '' + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: topics + type: LIST + required: true + default_value: '' + importance: HIGH + documentation: Identifies the topic name or a comma-separated list of topic names. + group: Which topics do you want to get data from? + width: NONE + display_name: Topic names + dependents: [] + order: 1 + alias: '' + value: + name: topics + value: test1 + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: data.format + type: STRING + required: true + default_value: '' + importance: HIGH + documentation: Sets the input/output message format. Valid entries are AVRO, JSON, or BYTES + group: Messages + width: NONE + display_name: Message format + dependents: [] + order: 1 + alias: '' + value: + name: data.format + value: BYTES + recommended_values: + - BYTES + - JSON + - AVRO + errors: [] + visible: true + metadata: {} + - definition: + name: gcs.credentials.config + type: PASSWORD + required: true + default_value: '' + importance: HIGH + documentation: Contents of the downloaded GCP service account JSON file. + group: Google Cloud Storage details + width: NONE + display_name: Google Cloud Storage credentials. + dependents: [] + order: 1 + alias: '' + value: + name: gcs.credentials.config + value: '' + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: gcs.bucket.name + type: STRING + required: true + default_value: '' + importance: HIGH + documentation: A Google Cloud Storage bucket must be in the same region as your Confluent Cloud cluster. + group: Google Cloud Storage details + width: NONE + display_name: Bucket name. + dependents: [] + order: 2 + alias: '' + value: + name: gcs.bucket.name + value: gmagare + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: time.interval + type: STRING + required: true + default_value: '' + importance: HIGH + documentation: Sets how your messages grouped in storage. Valid entries are DAILY or HOURLY. + group: Organize my data by... + width: NONE + display_name: Time interval + dependents: [] + order: 1 + alias: '' + value: + name: time.interval + value: DAILY + recommended_values: + - DAILY + - HOURLY + errors: [] + visible: true + metadata: {} + - definition: + name: tasks.max + type: INT + required: true + default_value: '' + importance: HIGH + documentation: '' + group: Number of tasks for this connector + width: NONE + display_name: Tasks + dependents: [] + order: 1 + alias: '' + value: + name: tasks.max + value: '1' + recommended_values: [] + errors: [] + visible: true + metadata: {} + - definition: + name: flush.size + type: INT + required: true + default_value: '1000' + importance: HIGH + documentation: This value defaults to 1000. For example, if you use the default setting of 1000 and your topic has six partitions, files start to be created in the storage bucket after more than 1000 records exist in each partition. Note that the default value of 1000 can be increased if needed. + group: Organize my data by... + width: NONE + display_name: Flush size + dependents: [] + order: 2 + alias: '' + value: + name: flush.size + value: '1' + recommended_values: [] + errors: + - '"flush.size" should be greater than or equal to 1000' + visible: true + metadata: {} + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + requestBody: + content: + application/json: + schema: + type: object + description: Configuration parameters for the connector. All values should be strings. + additionalProperties: + type: string + description: Other configuration parameters for the connector. All values should be strings. See the connector's docs for the list of options. + example: + cloud.environment: prod + cloud.provider: aws + connector.class: GcsSink + data.format: BYTES + flush.size: '500' + gcs.bucket.name: APILogsBucket + gcs.credentials.config: '****************' + kafka.api.key: '****************' + kafka.api.secret: '****************' + kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + kafka.region: us-west-2 + name: MyGcsLogsBucketConnector + tasks.max: '2' + time.interval: DAILY + topics: APILogsTopic + description: Configuration parameters for the connector. All values should be strings. + x-lifecycle-stage: General Availability + parameters: + - name: plugin_name + in: path + schema: + type: string + required: true + description: The unique name of the connector plugin. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/translate?mask_sensitive=true: + put: + x-lifecycle-stage: General Availability + operationId: translateConnectv1ConnectorPlugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Translate the provided Self Managed configuration values. This API performs configuration translation + and returns the translated fully managed configuration along with any errors or warnings. + Query Parameter `mask_sensitive=true` redacts sensitive config values in response. + summary: Translate Self Managed Connector Plugin Configurations to Fully Managed Connector Plugin Configurations + tags: + - Managed Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: Configuration parameters for the self managed connector. All values should be strings. + additionalProperties: + type: string + description: Configuration parameters for the self managed connector. All values should be strings. See the self managed connector's docs for the list of options. + example: + topics: nidhi_topic + input.data.format: JSON + connector.class: io.confluent.connect.datadog.metrics.DatadogMetricsSinkConnector + name: DatadogMetricsSinkConnector_87 + datadog.api.key: 535069c094cdfd1a55fb3e80eba09241 + datadog.domain: COM + max.retry.time.ms: '5000' + behavior.on.error: log + tasks.max: '1' + errors.tolerance: all + errors.deadletterqueue.context.headers.enable: 'true' + errors.log.include.messages: 'true' + errors.log.enable: 'true' + reporter.bootstrap.servers: localhost:9092 + reporter.error.topic.replication.factor: '1' + confluent.topic.bootstrap.servers: localhost:9092 + confluent.topic.replication.factor: '1' + description: Configuration parameters for the connector. All values should be strings. + responses: + '200': + description: Connector Plugin translation result. + content: + application/json: + schema: + type: object + properties: + config: + type: object + description: The translated configuration + additionalProperties: + type: string + errors: + type: array + description: List of configuration errors + items: + type: object + properties: + field: + type: string + description: The field name that has an error + message: + type: string + description: The error message + required: + - field + - message + warnings: + type: array + description: List of configuration warnings + items: + type: object + properties: + field: + type: string + description: The field name that has a warning + message: + type: string + description: The warning message + required: + - field + - message + example: + config: + connector.class: DatadogMetricsSink + name: DatadogMetricsSinkConnector_87 + topics: nidhi_topic + datadog.api.key: '****************' + datadog.domain: COM + max.retry.time.ms: '5000' + behavior.on.error: log + tasks.max: '1' + errors.tolerance: all + errors.deadletterqueue.context.headers.enable: 'true' + errors.log.include.messages: 'true' + errors.log.enable: 'true' + confluent.topic.bootstrap.servers: localhost:9092 + input.data.format: JSON + max.poll.interval.ms: '300000' + max.poll.records: '500' + errors: + - field: datadog.site + message: Required config is missing. + warnings: + - field: confluent.topic.bootstrap.servers + message: Customer given value is ignored. Default value is used. + - field: reporter.error.topic.replication.factor + message: Customer given value is ignored. Default value is used. + - field: confluent.topic.replication.factor + message: Customer given value is ignored. Default value is used. + '400': + $ref: '#/components/responses/connect.v1.BadRequestError' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '403': + $ref: '#/components/responses/connect.v1.ForbiddenError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: plugin_name + in: path + schema: + type: string + required: true + description: The unique name of the connector plugin. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + - name: mask_sensitive + in: query + required: false + schema: + type: string + maxLength: 255 + description: Indicates whether to redact sensitive config values in response. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets: + get: + x-lifecycle-stage: General Availability + operationId: getConnectv1ConnectorOffsets + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get the current offsets for the connector. The offsets provide information on the point in the source system, + from which the connector is pulling in data. The offsets of a connector are continuously observed periodically and are queryable via this API. + summary: Get a Connector Offsets + tags: + - Offsets (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector Offsets. + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorOffsets' + examples: + sink: + value: + id: lcc-as341 + name: MysqlSinkConnector + offsets: + - partition: + kafka_partition: 0 + kafka_topic: topic_A + offset: + kafka_offset: 20032323 + - partition: + kafka_partition: 1 + kafka_topic: topic_B + offset: + kafka_offset: 20032322 + metadata: + observed_at: 2024-02-20T15:14:19.000Z + source: + value: + id: lcc-21sdda + name: MysqlSourceConnector + offsets: + - partition: + protocol: 1 + table: sourcedb.sourcetable + offset: + timestamp_nanos: 0 + incrementing: 3 + timestamp: 1699142400000 + metadata: + observed_at: 2024-02-20T15:14:19.000Z + '400': + $ref: '#/components/responses/connect.v1.BadRequestError' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '403': + $ref: '#/components/responses/connect.v1.ForbiddenError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request: + post: + x-lifecycle-stage: General Availability + operationId: alterConnectv1ConnectorOffsetsRequest + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Request to alter the offsets of a connector. This supports the ability to PATCH/DELETE the offsets of a connector. + Note, you will see momentary downtime as this will internally stop the connector, while the offsets are being altered. + You can only make one alter offsets request at a time for a connector. + summary: Request to Alter the Connector Offsets + tags: + - Offsets (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '202': + description: Accepted + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.AlterOffsetRequestInfo' + examples: + patch: + value: + id: lcc-sa32er + name: MySinkConnector + offsets: + - partition: + kafka_partition: 0 + kafka_topic: topic_A + offset: + kafka_offset: 1000 + requested_at: 2024-02-20T15:14:19.000Z + type: PATCH + delete: + value: + id: lcc-234ds + name: MySourceConnector + offsets: [] + requested_at: 2024-02-20T15:14:19.000Z + type: DELETE + '400': + $ref: '#/components/responses/connect.v1.BadRequestError' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '403': + $ref: '#/components/responses/connect.v1.ForbiddenError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.AlterOffsetRequest' + examples: + patch sink: + value: + type: PATCH + offsets: + - partition: + kafka_partition: 0 + kafka_topic: topic_A + offset: + kafka_offset: 1000 + patch source: + value: + type: PATCH + offsets: + - partition: + protocol: 1 + table: sourcedb.sourcetable + offset: + timestamp_nanos: 0 + incrementing: 3 + timestamp: 1699000000000 + delete: + value: + type: DELETE + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status: + get: + x-lifecycle-stage: General Availability + operationId: getConnectv1ConnectorOffsetsRequestStatus + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get the status of the previous alter offset request. + summary: Get the Status of Alter Offset Request + tags: + - Offsets (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connector Offsets Request Status. + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.AlterOffsetStatus' + examples: + sink - pending patch operation: + value: + request: + id: lcc-sa32er + name: MySinkConnector + offsets: + - partition: + kafka_partition: 0 + kafka_topic: topic_A + offset: + kafka_offset: 1000 + requested_at: 2024-02-20T15:14:19.000Z + type: PATCH + status: + phase: PENDING + applied_at: null + source - applied patch operation: + value: + request: + id: lcc-x1sdfs + name: MySourceConnector + offsets: + - partition: + protocol: 1 + table: sourcedb.sourcetable + offset: + timestamp_nanos: 0 + incrementing: 3 + timestamp: 1699000000000 + requested_at: 2024-02-20T15:14:19.000Z + type: PATCH + status: + phase: APPLIED + message: The Connect framework-managed offsets for this connector have been altered successfully. However, if this connector manages offsets externally, they will need to be altered manually in the system that the connector uses. + previous_offsets: + - partition: + protocol: 1 + table: sourcedb.sourcetable + offset: + timestamp_nanos: 0 + incrementing: 2 + timestamp: 1698329479943 + applied_at: 2024-02-20T15:14:20+0000 + delete: + value: + request: + id: lcc-234ds + name: MySourceConnector + offsets: [] + requested_at: 2024-02-20T15:14:19.000Z + type: DELETE + status: + phase: APPLIED + message: The Connect framework-managed offsets for this connector have been reset successfully. However, if this connector manages offsets externally, they will need to be reset manually in the system that the connector uses. + previous_offsets: + - partition: + protocol: 1 + table: sourcedb.sourcetable + offset: + timestamp_nanos: 0 + incrementing: 2 + timestamp: 1698329479943 + applied_at: 2024-02-20T15:14:20.000Z + '400': + $ref: '#/components/responses/connect.v1.BadRequestError' + '401': + $ref: '#/components/responses/connect.v1.UnauthenticatedError' + '403': + $ref: '#/components/responses/connect.v1.ForbiddenError' + '404': + $ref: '#/components/responses/connect.v1.ResourceNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-lifecycle-stage: General Availability + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + /connect/v1/custom-connector-plugins: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listConnectV1CustomConnectorPlugins + summary: List of Custom Connector Plugins + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all custom connector plugins. + + If no `cloud` filter is specified, returns custom connector plugins from all clouds. + parameters: + - name: cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for cloud. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Custom Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Connector Plugin. + content: + application/json: + schema: + type: object + description: |- + CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connector Plugins. + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connector Plugins Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPluginList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connector Plugins. + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connector Plugins Model + + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: Display name of Custom Connector Plugin. + maxLength: 60 + content_format: + type: string + example: ZIP + description: Archive format of Custom Connector Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + description: + type: string + description: Description of Custom Connector Plugin. + maxLength: 256 + documentation_link: + maxLength: 512 + type: string + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connector Plugin. + connector_class: + type: string + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: Java class or alias for connector. You can get connector class from connector documentation provided by developer. + example: io.confluent.kafka.connect.datagen.DatagenConnector + x-immutable: true + connector_type: + type: string + description: | + Custom Connector type. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + x-immutable: true + cloud: + type: string + description: Cloud provider where the Custom Connector Plugin archive is uploaded. + example: AWS + default: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + sensitive_config_properties: + type: array + description: | + A sensitive property is a connector configuration property that must be hidden after a user enters property + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + upload_source: + type: object + description: Upload source of Custom Connector Plugin. Only required in `create` request, will be ignored in `read`, `update` or `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/connect.v1.UploadSource.PresignedUrl' + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: Upload ID returned by the `/presigned-upload-url` API. This field returns an empty string in all responses. + required: + - location + - upload_id + runtime_language: + type: string + example: JAVA + default: JAVA + description: Runtime language of Custom Connector Plugin. + x-extensible-enum: + - JAVA + - PYTHON + required: + - id + - metadata + - display_name + - connector_class + - connector_type + - upload_source + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createConnectV1CustomConnectorPlugin + summary: Create a Custom Connector Plugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a custom connector plugin. + tags: + - Custom Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connector Plugins. + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connector Plugins Model + + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: Display name of Custom Connector Plugin. + maxLength: 60 + content_format: + type: string + example: ZIP + description: Archive format of Custom Connector Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + description: + type: string + description: Description of Custom Connector Plugin. + maxLength: 256 + documentation_link: + maxLength: 512 + type: string + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connector Plugin. + connector_class: + type: string + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: Java class or alias for connector. You can get connector class from connector documentation provided by developer. + example: io.confluent.kafka.connect.datagen.DatagenConnector + x-immutable: true + connector_type: + type: string + description: | + Custom Connector type. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + x-immutable: true + cloud: + type: string + description: Cloud provider where the Custom Connector Plugin archive is uploaded. + example: AWS + default: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + sensitive_config_properties: + type: array + description: | + A sensitive property is a connector configuration property that must be hidden after a user enters property + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + upload_source: + type: object + description: Upload source of Custom Connector Plugin. Only required in `create` request, will be ignored in `read`, `update` or `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/connect.v1.UploadSource.PresignedUrl' + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: Upload ID returned by the `/presigned-upload-url` API. This field returns an empty string in all responses. + required: + - location + - upload_id + runtime_language: + type: string + example: JAVA + default: JAVA + description: Runtime language of Custom Connector Plugin. + x-extensible-enum: + - JAVA + - PYTHON + required: + - display_name + - connector_class + - connector_type + - upload_source + responses: + '201': + description: A Custom Connector Plugin was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/connect/v1/custom-connector-plugins/{id} + description: CustomConnectorPlugin resource uri + content: + application/json: + schema: + type: object + description: |- + CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connector Plugins. + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connector Plugins Model + + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: Display name of Custom Connector Plugin. + maxLength: 60 + content_format: + type: string + example: ZIP + description: Archive format of Custom Connector Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + description: + type: string + description: Description of Custom Connector Plugin. + maxLength: 256 + documentation_link: + maxLength: 512 + type: string + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connector Plugin. + connector_class: + type: string + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: Java class or alias for connector. You can get connector class from connector documentation provided by developer. + example: io.confluent.kafka.connect.datagen.DatagenConnector + x-immutable: true + connector_type: + type: string + description: | + Custom Connector type. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + x-immutable: true + cloud: + type: string + description: Cloud provider where the Custom Connector Plugin archive is uploaded. + example: AWS + default: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + sensitive_config_properties: + type: array + description: | + A sensitive property is a connector configuration property that must be hidden after a user enters property + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + upload_source: + type: object + description: Upload source of Custom Connector Plugin. Only required in `create` request, will be ignored in `read`, `update` or `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/connect.v1.UploadSource.PresignedUrl' + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: Upload ID returned by the `/presigned-upload-url` API. This field returns an empty string in all responses. + required: + - location + - upload_id + runtime_language: + type: string + example: JAVA + default: JAVA + description: Runtime language of Custom Connector Plugin. + x-extensible-enum: + - JAVA + - PYTHON + required: + - display_name + - connector_class + - connector_type + - upload_source + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /connect/v1/custom-connector-plugins/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getConnectV1CustomConnectorPlugin + summary: Read a Custom Connector Plugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a custom connector plugin. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connector plugin. + tags: + - Custom Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Connector Plugin. + content: + application/json: + schema: + type: object + description: |- + CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connector Plugins. + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connector Plugins Model + + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: Display name of Custom Connector Plugin. + maxLength: 60 + content_format: + type: string + example: ZIP + description: Archive format of Custom Connector Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + description: + type: string + description: Description of Custom Connector Plugin. + maxLength: 256 + documentation_link: + maxLength: 512 + type: string + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connector Plugin. + connector_class: + type: string + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: Java class or alias for connector. You can get connector class from connector documentation provided by developer. + example: io.confluent.kafka.connect.datagen.DatagenConnector + x-immutable: true + connector_type: + type: string + description: | + Custom Connector type. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + x-immutable: true + cloud: + type: string + description: Cloud provider where the Custom Connector Plugin archive is uploaded. + example: AWS + default: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + sensitive_config_properties: + type: array + description: | + A sensitive property is a connector configuration property that must be hidden after a user enters property + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + upload_source: + type: object + description: Upload source of Custom Connector Plugin. Only required in `create` request, will be ignored in `read`, `update` or `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/connect.v1.UploadSource.PresignedUrl' + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: Upload ID returned by the `/presigned-upload-url` API. This field returns an empty string in all responses. + required: + - location + - upload_id + runtime_language: + type: string + example: JAVA + default: JAVA + description: Runtime language of Custom Connector Plugin. + x-extensible-enum: + - JAVA + - PYTHON + required: + - api_version + - kind + - id + - display_name + - connector_class + - connector_type + - upload_source + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateConnectV1CustomConnectorPlugin + summary: Update a Custom Connector Plugin + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a custom connector plugin. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connector plugin. + tags: + - Custom Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.CustomConnectorPlugin' + responses: + '200': + description: Custom Connector Plugin. + content: + application/json: + schema: + type: object + description: |- + CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connector Plugins. + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connector Plugins Model + + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: Display name of Custom Connector Plugin. + maxLength: 60 + content_format: + type: string + example: ZIP + description: Archive format of Custom Connector Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + description: + type: string + description: Description of Custom Connector Plugin. + maxLength: 256 + documentation_link: + maxLength: 512 + type: string + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connector Plugin. + connector_class: + type: string + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: Java class or alias for connector. You can get connector class from connector documentation provided by developer. + example: io.confluent.kafka.connect.datagen.DatagenConnector + x-immutable: true + connector_type: + type: string + description: | + Custom Connector type. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + x-immutable: true + cloud: + type: string + description: Cloud provider where the Custom Connector Plugin archive is uploaded. + example: AWS + default: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + sensitive_config_properties: + type: array + description: | + A sensitive property is a connector configuration property that must be hidden after a user enters property + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + upload_source: + type: object + description: Upload source of Custom Connector Plugin. Only required in `create` request, will be ignored in `read`, `update` or `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/connect.v1.UploadSource.PresignedUrl' + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: Upload ID returned by the `/presigned-upload-url` API. This field returns an empty string in all responses. + required: + - location + - upload_id + runtime_language: + type: string + example: JAVA + default: JAVA + description: Runtime language of Custom Connector Plugin. + x-extensible-enum: + - JAVA + - PYTHON + required: + - api_version + - kind + - id + - display_name + - connector_class + - connector_type + - upload_source + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteConnectV1CustomConnectorPlugin + summary: Delete a Custom Connector Plugin + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a custom connector plugin. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the custom connector plugin. + tags: + - Custom Connector Plugins (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Custom Connector Plugin is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /connect/v1/presigned-upload-url: + post: + summary: Request a presigned upload URL for a new Custom Connector Plugin. + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Request a presigned upload URL to upload a Custom Connector Plugin archive. + requestBody: + content: + application/json: + schema: + type: object + description: | + Request schema of the presigned upload URL. + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrlRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + content_format: + type: string + example: ZIP + description: Archive format of the Custom Connector Plugin. + x-extensible-enum: + - JAR + - ZIP + cloud: + type: string + example: AWS + default: AWS + description: Cloud provider where the Custom Connector Plugin archive is uploaded. + x-extensible-enum: + - AWS + - GCP + - AZURE + required: + - content_format + x-lifecycle-stage: General Availability + x-self-access: true + x-name: connect.v1.PresignedUrl + operationId: presigned-upload-urlConnectV1PresignedUrl + tags: + - Presigned Urls (connect/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Presigned Url. + content: + application/json: + schema: + type: object + description: |- + Request a presigned upload URL for new Custom Connector Plugin. Note that + the URL policy expires in one hour. If the policy expires, you can request + a new presigned upload URL. + + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Presigned Urls Model + + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Custom Connector Plugin archive. + example: ZIP + x-extensible-enum: + - ZIP + - JAR + readOnly: true + cloud: + type: string + description: Cloud provider where the Custom Connector Plugin archive is uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + readOnly: true + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Custom Connector Plugin archive. + example: https://confluent-custom-connectors-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: string + description: Upload form data of the Custom Connector Plugin. All values should be strings. (opaque JSON object) + example: + bucket: confluent-custom-connectors-stag-us-west-2 + key: staging/custom-plugin/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/connect-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/plugin.zip + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + readOnly: true + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /connect/v1/custom-connector-runtimes: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listConnectV1CustomConnectorRuntimes + summary: List of Custom Connector Runtimes + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all custom connector runtimes. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Custom Connector Runtimes (connect/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Custom Connector Runtime. + content: + application/json: + schema: + type: object + description: |- + List of supported runtime languages for Custom Connector Plugin. The list defines the supported + entries for confluent.custom.connect.plugin.runtime attribute in CustomConnectorPlugin object. + Each entry also defines the set of supported java versions for that runtime which can be specified during + connector provisioning via the confluent.custom.connect.plugin.java.version attribute. + + + ## The Custom Connector Runtimes Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorRuntimeList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + List of supported runtime languages for Custom Connector Plugin. The list defines the supported + entries for confluent.custom.connect.plugin.runtime attribute in CustomConnectorPlugin object. + Each entry also defines the set of supported java versions for that runtime which can be specified during + connector provisioning via the confluent.custom.connect.plugin.java.version attribute. + + + ## The Custom Connector Runtimes Model + + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorRuntime + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + custom_connect_plugin_runtime_name: + type: string + description: | + Name of the runtime that is being used while provisioning a custom connector. This corresponds to + the property custom.connect.plugin.runtime in the connector configuration. + example: 3.9.0 + readOnly: true + runtime_ak_version: + type: string + description: The underlying version of Apache Kafka which bundles the connect runtime + example: 3.9.0 + readOnly: true + supported_java_versions: + type: array + description: List of supported Java versions + items: + type: string + example: + - '11' + - '17' + readOnly: true + product_maturity: + type: string + description: | + The product maturity phase for the plugin runtime. + EA (Early Access), GA (Generally Available), or Preview. + x-extensible-enum: + - EA + - GA + - PREVIEW + example: GA + readOnly: true + end_of_life_at: + type: string + format: date-time + description: End of Life date for the runtime + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: + type: string + description: Description of the runtime + example: Custom Connector Plugin runtime using AK 3.9.0 and supporting Java 11 and 17 + readOnly: true + required: + - id + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + connect.v1.ConnectorWithOffsets: + type: object + properties: + name: + type: string + description: Name of the connector + config: + type: object + description: |- + Configuration parameters for the connector. These configurations + are the minimum set of key-value pairs which can be used to + define how the connector connects Kafka to the external system. + Some of these key-value pairs are common to all the connectors, such as + connection parameters to Kafka, connector metadata, etc. The list + of common connector configurations is as follows + - cloud.environment + - cloud.provider + - connector.class + - kafka.api.key + - kafka.api.secret + - kafka.endpoint + - kafka.region + - name + A specific connector such as `GcsSink` would have additional + parameters such as `gcs.bucket.name`, `flush.size`, etc. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: + - aws + - azure + - gcp + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.endpoint: + type: string + description: The Kafka cluster endpoint. + kafka.region: + type: string + description: The Kafka cluster region. + kafka.api.key: + type: string + description: The Kafka cluster API key. + kafka.api.secret: + type: string + description: The Kafka cluster API secret. + x-redact: true + additionalProperties: + type: string + tasks: + type: array + description: List of active tasks generated by the connector + items: + type: object + properties: + connector: + type: string + description: The name of the connector the task belongs to + task: + type: integer + description: Task ID within the connector + required: + - connector + - task + type: + type: string + description: Type of connector, sink or source + enum: + - sink + - source + offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + required: + - name + - config + connect.v1.Offsets: + type: array + description: Array of offsets which are categorised into partitions. + items: + type: object + properties: + partition: + type: object + additionalProperties: true + description: |- + The partition information. For sink connectors this is the kafka topic and + partition. For source connectors this is depends on the partitions defined by the + source connector. For example, the table which this task is pulling data from in a + JDBC based MySQL source connector. + Please refer to the [documentation](https://docs.confluent.io/cloud/current/connectors/offsets.html#manage-offsets-for-fully-managed-connectors-in-ccloud) for + more information. + offset: + type: object + additionalProperties: true + description: |- + The offset of the partition. For sink connectors this is the kafka offset. For + source connectors this is depends on the offset defined by the source connector. + For example, the timestamp and incrementing column info in a table, for a JDBC based + MySQL source connector. + Please refer to the [documentation](https://docs.confluent.io/cloud/current/connectors/offsets.html#manage-offsets-for-fully-managed-connectors-in-ccloud) for + more information. + connect.v1.ConnectorExpansionMap: + type: object + additionalProperties: + $ref: '#/components/schemas/connect.v1.ConnectorExpansion' + connect.v1.Connector: + type: object + properties: + name: + type: string + description: Name of the connector + config: + type: object + description: |- + Configuration parameters for the connector. These configurations + are the minimum set of key-value pairs (KVP) which can be used to + define how the connector connects Kafka to the external system. + Some of these KVPs are common to all the connectors, such as + connection parameters to Kafka, connector metadata, etc. The list + of common connector configurations is as follows + + - cloud.environment + - cloud.provider + - connector.class + - kafka.api.key + - kafka.api.secret + - kafka.endpoint + - kafka.region + - name + + A specific connector such as `GcsSink` would have additional + parameters such as `gcs.bucket.name`, `flush.size`, etc. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: + - aws + - azure + - gcp + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.endpoint: + type: string + description: The kafka cluster endpoint. + kafka.region: + type: string + description: The kafka cluster region. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + additionalProperties: + type: string + tasks: + type: array + description: List of active tasks generated by the connector + items: + type: object + properties: + connector: + type: string + description: The name of the connector the task belongs to + task: + type: integer + description: Task ID within the connector + required: + - connector + - task + type: + type: string + description: Type of connector, sink or source + enum: + - sink + - source + required: + - name + - config + connect.v1.Connectors: + type: array + description: List of active task configs that have been created by the connector + items: + type: object + properties: + id: + type: object + description: The ID of task. + properties: + connector: + type: string + description: The name of the connector the task belongs to. + task: + type: integer + description: Task ID within the connector. + config: + type: object + description: |- + Configuration parameters for the connector. These configurations + are the minimum set of key-value pairs (KVP) which can be used to + define how the connector connects Kafka to the external system. + Some of these KVPs are common to all the connectors, such as + connection parameters to Kafka, connector metadata, etc. The list + of common connector configurations is as follows + + - cloud.environment + - cloud.provider + - connector.class + - kafka.api.key + - kafka.api.secret + - kafka.endpoint + - kafka.region + - name + + A specific connector such as `GcsSink` would have additional + parameters such as `gcs.bucket.name`, `flush.size`, etc. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: + - aws + - azure + - gcp + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.endpoint: + type: string + description: The kafka cluster endpoint. + kafka.region: + type: string + description: The kafka cluster region. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + additionalProperties: + type: string + connect.v1.ConnectorOffsets: + type: object + description: Offsets for a connector + properties: + name: + type: string + description: The name of the connector. + id: + type: string + description: The ID of the connector. + offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + metadata: + type: object + description: Metadata of the connector offset. + properties: + observed_at: + type: string + format: date-time + example: '2024-02-20T15:14:19.000Z' + readOnly: true + description: The time at which the offsets were observed. The time is in UTC, ISO 8601 format. + connect.v1.AlterOffsetRequestInfo: + type: object + description: The request made to alter offsets. + properties: + id: + type: string + description: The ID of the connector. + name: + type: string + description: The name of the connector. + offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + requested_at: + type: string + format: date-time + readOnly: true + example: '2024-02-20T15:14:19.000Z' + description: The time at which the request was made. The time is in UTC, ISO 8601 format. + type: + $ref: '#/components/schemas/connect.v1.AlterOffsetRequestType' + required: + - id + - name + - type + - requested_at + connect.v1.AlterOffsetRequest: + type: object + description: Request to alter the offset of a connector. The offsets parameter is options for DELETE type. + properties: + type: + $ref: '#/components/schemas/connect.v1.AlterOffsetRequestType' + offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + required: + - type + connect.v1.AlterOffsetStatus: + type: object + description: |- + Status of the alter offset operation. The previous offsets in the response + is the offsets that the connector last processed, before the offsets were altered, + via a patch or delete operation. + properties: + request: + $ref: '#/components/schemas/connect.v1.AlterOffsetRequestInfo' + status: + type: object + description: The response of the alter offsets operation. + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - PENDING_VALIDATION + - APPLIED + - FAILED + description: |- + The phase of the alter offset operation. + + PENDING: The offset alter operation is in progress. + + APPLIED: The offset alter operation has been applied to the connector. + + FAILED: The offset alter operation has failed to be applied to the connector. + message: + type: string + description: An info message from the alter offset operation. + required: + - phase + previous_offsets: + $ref: '#/components/schemas/connect.v1.Offsets' + applied_at: + type: string + nullable: true + format: date-time + example: '2024-02-20T15:14:19.000Z' + readOnly: true + description: The time at which the offsets were applied. The time is in UTC, ISO 8601 format. + required: + - request + - status + SearchFilter: + description: Filter a collection by a string search + type: string + connect.v1.CustomConnectorPluginList: + type: object + description: |- + CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connector Plugins. + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connector Plugins Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPluginList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connector Plugins. + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connector Plugins Model + + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: Display name of Custom Connector Plugin. + maxLength: 60 + content_format: + type: string + example: ZIP + description: Archive format of Custom Connector Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + description: + type: string + description: Description of Custom Connector Plugin. + maxLength: 256 + documentation_link: + maxLength: 512 + type: string + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connector Plugin. + connector_class: + type: string + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: Java class or alias for connector. You can get connector class from connector documentation provided by developer. + example: io.confluent.kafka.connect.datagen.DatagenConnector + x-immutable: true + connector_type: + type: string + description: | + Custom Connector type. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + x-immutable: true + cloud: + type: string + description: Cloud provider where the Custom Connector Plugin archive is uploaded. + example: AWS + default: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + sensitive_config_properties: + type: array + description: | + A sensitive property is a connector configuration property that must be hidden after a user enters property + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + upload_source: + type: object + description: Upload source of Custom Connector Plugin. Only required in `create` request, will be ignored in `read`, `update` or `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/connect.v1.UploadSource.PresignedUrl' + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: Upload ID returned by the `/presigned-upload-url` API. This field returns an empty string in all responses. + required: + - location + - upload_id + runtime_language: + type: string + example: JAVA + default: JAVA + description: Runtime language of Custom Connector Plugin. + x-extensible-enum: + - JAVA + - PYTHON + required: + - id + - metadata + - display_name + - connector_class + - connector_type + - upload_source + uniqueItems: true + connect.v1.CustomConnectorPlugin: + type: object + description: |- + CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud. + The API allows you to list, create, read, update, and delete your Custom Connector Plugins. + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Custom Connector Plugins Model + + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorPlugin + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: Display name of Custom Connector Plugin. + maxLength: 60 + content_format: + type: string + example: ZIP + description: Archive format of Custom Connector Plugin. + x-extensible-enum: + - ZIP + - JAR + readOnly: true + description: + type: string + description: Description of Custom Connector Plugin. + maxLength: 256 + documentation_link: + maxLength: 512 + type: string + pattern: ^$|^(http://|https://).+ + example: https://github.com/confluentinc/kafka-connect-datagen + description: Document link of Custom Connector Plugin. + connector_class: + type: string + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + description: Java class or alias for connector. You can get connector class from connector documentation provided by developer. + example: io.confluent.kafka.connect.datagen.DatagenConnector + x-immutable: true + connector_type: + type: string + description: | + Custom Connector type. + example: SOURCE + x-extensible-enum: + - SOURCE + - SINK + x-immutable: true + cloud: + type: string + description: Cloud provider where the Custom Connector Plugin archive is uploaded. + example: AWS + default: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + x-immutable: true + sensitive_config_properties: + type: array + description: | + A sensitive property is a connector configuration property that must be hidden after a user enters property + value when setting up connector. + items: + type: string + pattern: ^[\w\+\.-]+$ + maxLength: 150 + example: + - passwords + - keys + - tokens + upload_source: + type: object + description: Upload source of Custom Connector Plugin. Only required in `create` request, will be ignored in `read`, `update` or `list`. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/connect.v1.UploadSource.PresignedUrl' + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: Upload ID returned by the `/presigned-upload-url` API. This field returns an empty string in all responses. + required: + - location + - upload_id + runtime_language: + type: string + example: JAVA + default: JAVA + description: Runtime language of Custom Connector Plugin. + x-extensible-enum: + - JAVA + - PYTHON + connect.v1.PresignedUrlRequest: + type: object + description: | + Request schema of the presigned upload URL. + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrlRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + content_format: + type: string + example: ZIP + description: Archive format of the Custom Connector Plugin. + x-extensible-enum: + - JAR + - ZIP + cloud: + type: string + example: AWS + default: AWS + description: Cloud provider where the Custom Connector Plugin archive is uploaded. + x-extensible-enum: + - AWS + - GCP + - AZURE + connect.v1.PresignedUrl: + type: object + description: |- + Request a presigned upload URL for new Custom Connector Plugin. Note that + the URL policy expires in one hour. If the policy expires, you can request + a new presigned upload URL. + + Related guide: + [Custom Connector Plugin API](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html). + + + ## The Presigned Urls Model + + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Custom Connector Plugin archive. + example: ZIP + x-extensible-enum: + - ZIP + - JAR + readOnly: true + cloud: + type: string + description: Cloud provider where the Custom Connector Plugin archive is uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + readOnly: true + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Custom Connector Plugin archive. + example: https://confluent-custom-connectors-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: string + description: Upload form data of the Custom Connector Plugin. All values should be strings. (opaque JSON object) + example: + bucket: confluent-custom-connectors-stag-us-west-2 + key: staging/custom-plugin/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/connect-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/plugin.zip + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + readOnly: true + connect.v1.CustomConnectorRuntimeList: + type: object + description: |- + List of supported runtime languages for Custom Connector Plugin. The list defines the supported + entries for confluent.custom.connect.plugin.runtime attribute in CustomConnectorPlugin object. + Each entry also defines the set of supported java versions for that runtime which can be specified during + connector provisioning via the confluent.custom.connect.plugin.java.version attribute. + + + ## The Custom Connector Runtimes Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorRuntimeList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + List of supported runtime languages for Custom Connector Plugin. The list defines the supported + entries for confluent.custom.connect.plugin.runtime attribute in CustomConnectorPlugin object. + Each entry also defines the set of supported java versions for that runtime which can be specified during + connector provisioning via the confluent.custom.connect.plugin.java.version attribute. + + + ## The Custom Connector Runtimes Model + + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorRuntime + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + custom_connect_plugin_runtime_name: + type: string + description: | + Name of the runtime that is being used while provisioning a custom connector. This corresponds to + the property custom.connect.plugin.runtime in the connector configuration. + example: 3.9.0 + readOnly: true + runtime_ak_version: + type: string + description: The underlying version of Apache Kafka which bundles the connect runtime + example: 3.9.0 + readOnly: true + supported_java_versions: + type: array + description: List of supported Java versions + items: + type: string + example: + - '11' + - '17' + readOnly: true + product_maturity: + type: string + description: | + The product maturity phase for the plugin runtime. + EA (Early Access), GA (Generally Available), or Preview. + x-extensible-enum: + - EA + - GA + - PREVIEW + example: GA + readOnly: true + end_of_life_at: + type: string + format: date-time + description: End of Life date for the runtime + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: + type: string + description: Description of the runtime + example: Custom Connector Plugin runtime using AK 3.9.0 and supporting Java 11 and 17 + readOnly: true + required: + - id + uniqueItems: true + connect.v1.ConnectorError: + type: object + properties: + error: + type: object + description: Connector Error with error code and message. + properties: + code: + type: integer + description: Error code for the type of error + message: + type: string + description: Human readable error message + connect.v1.ConnectorExpansion: + type: object + description: Name of connector + properties: + id: + type: object + description: The ID of connector. + properties: + id: + type: string + description: The ID of the connector. + id_type: + type: string + description: Type of the value in the `id` property. + info: + type: object + description: Metadata of the connector. + properties: + name: + type: string + description: Name of the connector. + config: + type: object + description: |- + Configuration parameters for the connector. These configurations + are the minimum set of key-value pairs (KVP) which are used to + define how the connector connects Kafka to the external system. + Some of these KVPs are common to all the connectors, such as + connection parameters to Kafka, connector metadata, etc. The list + of common connector configurations is as follows + + - cloud.environment + - cloud.provider + - connector.class + - kafka.api.key + - kafka.api.secret + - kafka.endpoint + - kafka.region + - name + + For example, a connector like `GcsSink` would have additional + parameters such as `gcs.bucket.name`, `flush.size`, etc. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: + - aws + - azure + - gcp + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.endpoint: + type: string + description: The kafka cluster endpoint. + kafka.region: + type: string + description: The kafka cluster region. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + additionalProperties: + type: string + status: + type: object + description: Status of the connector and its tasks. + properties: + name: + type: string + description: The name of the connector. + type: + type: string + description: Type of connector, sink or source. + enum: + - sink + - source + connector: + type: object + description: A map containing connector status. + required: + - state + - worker_id + properties: + state: + type: string + description: The state of the connector. + enum: + - NONE + - PROVISIONING + - RUNNING + - DEGRADED + - FAILED + - PAUSED + - DELETED + worker_id: + type: string + description: The worker ID of the connector. + trace: + type: string + description: Exception message in case of an error. + tasks: + type: array + description: A map containing the task status. + items: + type: object + properties: + id: + type: integer + description: The ID of task. + state: + type: string + description: The state of the task. + worker_id: + type: string + description: The worker ID of the task. + msg: + type: string + required: + - id + - state + - worker_id + required: + - name + - type + - connector + connect.v1.AlterOffsetRequestType: + type: string + enum: + - PATCH + - DELETE + description: |- + The type of alter operation. PATCH will update the offset to the provided values. + The update will only happen for the partitions provided in the request. + DELETE will delete the offset for the provided partitions and reset them back to the + base state. It is as if, a fresh new connector was created. + + For sink connectors PATCH/DELETE will move the offsets to the provided point in the + topic partition. If the offset provided is not present in the topic partition it will + by default reset to the earliest offset in the topic partition. + + For source connectors, post PATCH/DELETE the connector will attempt to read from the + position defined in the altered offsets. + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + connect.v1.UploadSource.PresignedUrl: + type: object + description: Presigned URL of the uploaded Custom Connector Plugin archive. + properties: + location: + type: string + description: | + Location of the Custom Connector Plugin source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: Upload ID returned by the `/presigned-upload-url` API. This field returns an empty string in all responses. + required: + - location + - upload_id + connect.v1.CustomConnectorRuntime: + type: object + description: |- + List of supported runtime languages for Custom Connector Plugin. The list defines the supported + entries for confluent.custom.connect.plugin.runtime attribute in CustomConnectorPlugin object. + Each entry also defines the set of supported java versions for that runtime which can be specified during + connector provisioning via the confluent.custom.connect.plugin.java.version attribute. + + + ## The Custom Connector Runtimes Model + + properties: + api_version: + type: string + enum: + - connect/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CustomConnectorRuntime + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + custom_connect_plugin_runtime_name: + type: string + description: | + Name of the runtime that is being used while provisioning a custom connector. This corresponds to + the property custom.connect.plugin.runtime in the connector configuration. + example: 3.9.0 + readOnly: true + runtime_ak_version: + type: string + description: The underlying version of Apache Kafka which bundles the connect runtime + example: 3.9.0 + readOnly: true + supported_java_versions: + type: array + description: List of supported Java versions + items: + type: string + example: + - '11' + - '17' + readOnly: true + product_maturity: + type: string + description: | + The product maturity phase for the plugin runtime. + EA (Early Access), GA (Generally Available), or Preview. + x-extensible-enum: + - EA + - GA + - PREVIEW + example: GA + readOnly: true + end_of_life_at: + type: string + format: date-time + description: End of Life date for the runtime + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: + type: string + description: Description of the runtime + example: Custom Connector Plugin runtime using AK 3.9.0 and supporting Java 11 and 17 + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + connect.v1.UnauthenticatedError: + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 401 + message: Unauthorized + connect.v1.AccountNotFoundError: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 404 + message: account not found + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + connect.v1.DefaultSystemError: + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 500 + message: Oops, something went wrong + connect.v1.BadRequestError: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 400 + message: Bad Request + connect.v1.OK: + description: OK + content: + application/json: + schema: + type: object + properties: + error: + type: string + nullable: true + description: (opaque JSON object) + example: + error: null + connect.v1.ResourceNotFoundError: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 404 + message: resource not found + connect.v1.ForbiddenError: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/connect.v1.ConnectorError' + example: + error: + code: 403 + message: Forbidden + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/encryption_keys.yaml b/provider-dev/source/encryption_keys.yaml new file mode 100644 index 0000000..2c0e2bb --- /dev/null +++ b/provider-dev/source/encryption_keys.yaml @@ -0,0 +1,3860 @@ +openapi: 3.0.0 +info: + title: encryption_keys API + description: confluent encryption_keys API + version: 1.0.0 +paths: + /dek-registry/v1/keks: + get: + tags: + - Key Encryption Keys (v1) + operationId: getKekNames + parameters: + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + items: + example: mykek + type: string + type: array + application/vnd.schemaregistry+json; qs=0.9: + schema: + items: + example: mykek + type: string + type: array + application/json; qs=0.5: + schema: + items: + example: mykek + type: string + type: array + description: List of kek names + summary: Get a list of kek names + security: + - resource-api-key: [] + - external-access-token: [] + post: + tags: + - Key Encryption Keys (v1) + operationId: createKek + parameters: + - description: Whether to test kek sharing + explode: true + in: query + name: testSharing + required: false + schema: + type: boolean + default: false + style: form + requestBody: + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/CreateKekRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/CreateKekRequest' + application/json: + schema: + $ref: '#/components/schemas/CreateKekRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/CreateKekRequest' + description: The create request + required: true + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Kek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Kek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Kek' + description: The create response + '409': + description: Conflict. Error code 40971 -- Key already exists. Error code 40972 -- Too many keys. + '422': + description: Error code 42271 -- Invalid key + summary: Create a kek + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}: + delete: + tags: + - Key Encryption Keys (v1) + operationId: deleteKek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Whether to perform a permanent delete + explode: true + in: query + name: permanent + required: false + schema: + type: boolean + style: form + responses: + '204': + description: No Content + '404': + description: Not found. Error code 40470 -- Key not found. Error code 40471 -- Key not soft-deleted. + '422': + description: Unprocessable entity. Error code 42271 -- Invalid key. Error code 42272 -- References to key exist. + summary: Delete a kek + security: + - resource-api-key: [] + - external-access-token: [] + get: + tags: + - Key Encryption Keys (v1) + operationId: getKek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Kek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Kek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Kek' + description: The kek info + '404': + description: Error code 40470 -- Key not found + '422': + description: Error code 42271 -- Invalid key + summary: Get a kek by name + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Key Encryption Keys (v1) + operationId: putKek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Whether to test kek sharing + explode: true + in: query + name: testSharing + required: false + schema: + type: boolean + default: false + style: form + requestBody: + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/UpdateKekRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/UpdateKekRequest' + application/json: + schema: + $ref: '#/components/schemas/UpdateKekRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/UpdateKekRequest' + description: The update request + required: true + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Kek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Kek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Kek' + description: The update response + '404': + description: Error code 40470 -- Key not found + '409': + description: Error code 40971 -- Key already exists + '422': + description: Error code 42271 -- Invalid key + summary: Alters a kek + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/undelete: + post: + tags: + - Key Encryption Keys (v1) + operationId: undeleteKek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + responses: + '204': + description: No Content + '404': + description: Error code 40470 -- Key not found + '422': + description: Unprocessable entity. Error code 42271 -- Invalid key. Error code 42272 -- References to key exist. + summary: Undelete a kek + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/test: + post: + tags: + - Key Encryption Keys (v1) + operationId: testKek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Kek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Kek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Kek' + description: The test response + '422': + description: Error code 42271 -- Invalid key + '500': + description: Error code 50070 -- Dek generation error + summary: Test a kek + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/deks: + get: + tags: + - Data Encryption Keys (v1) + operationId: getDekSubjects + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + - description: Pagination offset for results + explode: true + in: query + name: offset + required: false + schema: + type: integer + default: 0 + style: form + - description: Pagination size for results. Ignored if negative + explode: true + in: query + name: limit + required: false + schema: + type: integer + default: -1 + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + items: + example: User + type: string + type: array + application/vnd.schemaregistry+json; qs=0.9: + schema: + items: + example: User + type: string + type: array + application/json; qs=0.5: + schema: + items: + example: User + type: string + type: array + description: List of dek subjects + '404': + description: Error code 40470 -- Key not found + '422': + description: Error code 42271 -- Invalid key + summary: Get a list of dek subjects + security: + - resource-api-key: [] + - external-access-token: [] + post: + tags: + - Data Encryption Keys (v1) + operationId: createDek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + requestBody: + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/CreateDekRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/CreateDekRequest' + application/json: + schema: + $ref: '#/components/schemas/CreateDekRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/CreateDekRequest' + description: The create request + required: true + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Dek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Dek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Dek' + description: The create response + '409': + description: Conflict. Error code 40971 -- Key already exists. Error code 40972 -- Too many keys. + '422': + description: Error code 42271 -- Invalid key + '500': + description: Error code 50070 -- Dek generation error + summary: Create a dek + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/deks/{subject}: + delete: + tags: + - Data Encryption Keys (v1) + operationId: deleteDekVersions + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + - description: Whether to perform a permanent delete + explode: true + in: query + name: permanent + required: false + schema: + type: boolean + style: form + responses: + '204': + description: No Content + '404': + description: Not found. Error code 40470 -- Key not found. Error code 40471 -- Key not soft-deleted. + '422': + description: Error code 42271 -- Invalid key + summary: Delete all versions of a dek + security: + - resource-api-key: [] + - external-access-token: [] + get: + tags: + - Data Encryption Keys (v1) + operationId: getDek + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Dek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Dek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Dek' + description: The dek info + '404': + description: Error code 40470 -- Key not found + '422': + description: Error code 42271 -- Invalid key + '500': + description: Error code 50070 -- Dek generation error + summary: Get a dek by subject + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}: + delete: + tags: + - Data Encryption Keys (v1) + operationId: deleteDekVersion + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Version of the dek + explode: false + in: path + name: version + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + - description: Whether to perform a permanent delete + explode: true + in: query + name: permanent + required: false + schema: + type: boolean + style: form + responses: + '204': + description: No Content + '404': + description: Not found. Error code 40470 -- Key not found. Error code 40471 -- Key not soft-deleted. + '422': + description: Unprocessable entity. Error code 42202 -- Invalid version. Error code 42271 -- Invalid key. + summary: Delete a dek version + security: + - resource-api-key: [] + - external-access-token: [] + get: + tags: + - Data Encryption Keys (v1) + operationId: getDekByVersion + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Version of the dek + explode: false + in: path + name: version + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Dek' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Dek' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Dek' + description: The dek info + '404': + description: Error code 40470 -- Key not found + '422': + description: Unprocessable entity. Error code 42202 -- Invalid version. Error code 42271 -- Invalid key. + '500': + description: Error code 50070 -- Dek generation error + summary: Get a dek by subject and version + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/deks/{subject}/versions: + get: + tags: + - Data Encryption Keys (v1) + operationId: getDekVersions + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + - description: Whether to include deleted keys + explode: true + in: query + name: deleted + required: false + schema: + type: boolean + style: form + - description: Pagination offset for results + explode: true + in: query + name: offset + required: false + schema: + type: integer + default: 0 + style: form + - description: Pagination size for results. Ignored if negative + explode: true + in: query + name: limit + required: false + schema: + type: integer + default: -1 + style: form + responses: + '200': + content: + application/vnd.schemaregistry.v1+json: + schema: + items: + example: 1 + format: int32 + type: integer + type: array + application/vnd.schemaregistry+json; qs=0.9: + schema: + items: + example: 1 + format: int32 + type: integer + type: array + application/json; qs=0.5: + schema: + items: + example: 1 + format: int32 + type: integer + type: array + description: List of version numbers for dek + '404': + description: Error code 40470 -- Key not found + '422': + description: Error code 42271 -- Invalid key + summary: List versions of dek + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}/undelete: + post: + tags: + - Data Encryption Keys (v1) + operationId: undeleteDekVersion + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Version of the dek + explode: false + in: path + name: version + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + responses: + '204': + description: No Content + '404': + description: Not found. Error code 40470 -- Key not found. Error code 40472 -- Key must be undeleted. + '422': + description: Unprocessable entity. Error code 42202 -- Invalid version. Error code 42271 -- Invalid key. + summary: Undelete a dek version + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /dek-registry/v1/keks/{name}/deks/{subject}/undelete: + post: + tags: + - Data Encryption Keys (v1) + operationId: undeleteDekVersions + parameters: + - description: Name of the kek + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + - description: Subject of the dek + explode: false + in: path + name: subject + required: true + schema: + type: string + style: simple + - description: Algorithm of the dek + explode: true + in: query + name: algorithm + required: false + schema: + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + type: string + style: form + responses: + '204': + description: No Content + '404': + description: Not found. Error code 40470 -- Key not found. Error code 40472 -- Key must be undeleted. + '422': + description: Error code 42271 -- Invalid key + summary: Undelete all versions of a dek + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /byok/v1/keys: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listByokV1Keys + summary: List of Keys + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all keys. + parameters: + - name: display_name + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: Key for billing cluster + description: Filter the results by a partial search of display_name. + - name: provider + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for provider. + - name: state + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: IN_USE + description: Filter the results by exact match for state. + - name: validation_phase + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + description: Filter the results by exact match for validation_phase. + - name: validation_region + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-west-2 + description: | + Filter keys by the cloud region where they are deployed. + - name: key + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: vault-name + description: | + Filters results by a partial match on the key identifier: key_arn for AWS, key_id for Azure and GCP. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Keys (byok/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Key. + content: + application/json: + schema: + type: object + description: |- + `Key` objects represent customer managed keys on dedicated Confluent Cloud clusters. + + Keys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP. + This API allows you to upload and retrieve self-managed keys on Confluent Cloud. + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + ## The Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - byok/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KeyList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Key` objects represent customer managed keys on dedicated Confluent Cloud clusters. + + Keys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP. + This API allows you to upload and retrieve self-managed keys on Confluent Cloud. + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + ## The Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. | + properties: + api_version: + type: string + enum: + - byok/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Key + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + key: + type: object + description: | + The cloud-specific key details. + + For AWS, provide the corresponding `key_arn`. + + For Azure, provide the corresponding `key_id`. + + For GCP, provide the corresponding `key_id`. + discriminator: + propertyName: kind + mapping: + AwsKey: '#/components/schemas/byok.v1.AwsKey' + AzureKey: '#/components/schemas/byok.v1.AzureKey' + GcpKey: '#/components/schemas/byok.v1.GcpKey' + x-immutable: true + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: | + The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - arn:aws:iam::123456789876:role/block_storage_manager + - arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + application_id: + description: | + The Application ID created for this key-environment combination. + type: string + readOnly: true + key_id: + description: | + The unique Key Object Identifier URL without version of an Azure Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + tenant_id: + description: | + Tenant ID (uuid) hosting the Key Vault containing the key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + required: + - key_arn + - kind + - key_id + - key_vault_id + - tenant_id + display_name: + type: string + description: | + The human-readable name of the key object. + example: Key for billing cluster + x-immutable: false + provider: + type: string + x-extensible-enum: + - AWS + - Azure + - GCP + description: The cloud provider of the Key. + readOnly: true + example: AWS + state: + type: string + x-extensible-enum: + - AVAILABLE + - IN_USE + description: | + The state of the key: + + AVAILABLE: key can be used for a Kafka cluster provisioning. + + IN_USE: key is already in use by a Kafka cluster provisioning. + readOnly: true + example: IN_USE + validation: + description: | + The validation details of the key. + readOnly: true + type: object + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: | + The timestamp since which the key is in the current validation phase. + Changes to the validation message or phase will update this timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: | + The cloud region where the key is deployed. This value is computed by the + API after the key is successfully validated. + example: us-west-2 + readOnly: true + required: + - id + - metadata + - key + - provider + - state + - validation + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createByokV1Key + summary: Create a Key + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a key. + tags: + - Keys (byok/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Key` objects represent customer managed keys on dedicated Confluent Cloud clusters. + + Keys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP. + This API allows you to upload and retrieve self-managed keys on Confluent Cloud. + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + ## The Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. | + properties: + api_version: + type: string + enum: + - byok/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Key + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + key: + type: object + description: | + The cloud-specific key details. + + For AWS, provide the corresponding `key_arn`. + + For Azure, provide the corresponding `key_id`. + + For GCP, provide the corresponding `key_id`. + discriminator: + propertyName: kind + mapping: + AwsKey: '#/components/schemas/byok.v1.AwsKey' + AzureKey: '#/components/schemas/byok.v1.AzureKey' + GcpKey: '#/components/schemas/byok.v1.GcpKey' + x-immutable: true + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: | + The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - arn:aws:iam::123456789876:role/block_storage_manager + - arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + application_id: + description: | + The Application ID created for this key-environment combination. + type: string + readOnly: true + key_id: + description: | + The unique Key Object Identifier URL without version of an Azure Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + tenant_id: + description: | + Tenant ID (uuid) hosting the Key Vault containing the key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + required: + - key_arn + - kind + - key_id + - key_vault_id + - tenant_id + display_name: + type: string + description: | + The human-readable name of the key object. + example: Key for billing cluster + x-immutable: false + provider: + type: string + x-extensible-enum: + - AWS + - Azure + - GCP + description: The cloud provider of the Key. + readOnly: true + example: AWS + state: + type: string + x-extensible-enum: + - AVAILABLE + - IN_USE + description: | + The state of the key: + + AVAILABLE: key can be used for a Kafka cluster provisioning. + + IN_USE: key is already in use by a Kafka cluster provisioning. + readOnly: true + example: IN_USE + validation: + description: | + The validation details of the key. + readOnly: true + type: object + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: | + The timestamp since which the key is in the current validation phase. + Changes to the validation message or phase will update this timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: | + The cloud region where the key is deployed. This value is computed by the + API after the key is successfully validated. + example: us-west-2 + readOnly: true + required: + - key + responses: + '201': + description: A Key was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/byok/v1/keys/{id} + description: Key resource uri + content: + application/json: + schema: + type: object + description: |- + `Key` objects represent customer managed keys on dedicated Confluent Cloud clusters. + + Keys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP. + This API allows you to upload and retrieve self-managed keys on Confluent Cloud. + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + ## The Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. | + properties: + api_version: + type: string + enum: + - byok/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Key + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + key: + type: object + description: | + The cloud-specific key details. + + For AWS, provide the corresponding `key_arn`. + + For Azure, provide the corresponding `key_id`. + + For GCP, provide the corresponding `key_id`. + discriminator: + propertyName: kind + mapping: + AwsKey: '#/components/schemas/byok.v1.AwsKey' + AzureKey: '#/components/schemas/byok.v1.AzureKey' + GcpKey: '#/components/schemas/byok.v1.GcpKey' + x-immutable: true + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: | + The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - arn:aws:iam::123456789876:role/block_storage_manager + - arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + application_id: + description: | + The Application ID created for this key-environment combination. + type: string + readOnly: true + key_id: + description: | + The unique Key Object Identifier URL without version of an Azure Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + tenant_id: + description: | + Tenant ID (uuid) hosting the Key Vault containing the key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + required: + - key_arn + - kind + - key_id + - key_vault_id + - tenant_id + display_name: + type: string + description: | + The human-readable name of the key object. + example: Key for billing cluster + x-immutable: false + provider: + type: string + x-extensible-enum: + - AWS + - Azure + - GCP + description: The cloud provider of the Key. + readOnly: true + example: AWS + state: + type: string + x-extensible-enum: + - AVAILABLE + - IN_USE + description: | + The state of the key: + + AVAILABLE: key can be used for a Kafka cluster provisioning. + + IN_USE: key is already in use by a Kafka cluster provisioning. + readOnly: true + example: IN_USE + validation: + description: | + The validation details of the key. + readOnly: true + type: object + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: | + The timestamp since which the key is in the current validation phase. + Changes to the validation message or phase will update this timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: | + The cloud region where the key is deployed. This value is computed by the + API after the key is successfully validated. + example: us-west-2 + readOnly: true + required: + - key + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /byok/v1/keys/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getByokV1Key + summary: Read a Key + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a key. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the key. + tags: + - Keys (byok/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Key. + content: + application/json: + schema: + type: object + description: |- + `Key` objects represent customer managed keys on dedicated Confluent Cloud clusters. + + Keys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP. + This API allows you to upload and retrieve self-managed keys on Confluent Cloud. + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + ## The Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. | + properties: + api_version: + type: string + enum: + - byok/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Key + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + key: + type: object + description: | + The cloud-specific key details. + + For AWS, provide the corresponding `key_arn`. + + For Azure, provide the corresponding `key_id`. + + For GCP, provide the corresponding `key_id`. + discriminator: + propertyName: kind + mapping: + AwsKey: '#/components/schemas/byok.v1.AwsKey' + AzureKey: '#/components/schemas/byok.v1.AzureKey' + GcpKey: '#/components/schemas/byok.v1.GcpKey' + x-immutable: true + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: | + The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - arn:aws:iam::123456789876:role/block_storage_manager + - arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + application_id: + description: | + The Application ID created for this key-environment combination. + type: string + readOnly: true + key_id: + description: | + The unique Key Object Identifier URL without version of an Azure Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + tenant_id: + description: | + Tenant ID (uuid) hosting the Key Vault containing the key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + required: + - key_arn + - kind + - key_id + - key_vault_id + - tenant_id + display_name: + type: string + description: | + The human-readable name of the key object. + example: Key for billing cluster + x-immutable: false + provider: + type: string + x-extensible-enum: + - AWS + - Azure + - GCP + description: The cloud provider of the Key. + readOnly: true + example: AWS + state: + type: string + x-extensible-enum: + - AVAILABLE + - IN_USE + description: | + The state of the key: + + AVAILABLE: key can be used for a Kafka cluster provisioning. + + IN_USE: key is already in use by a Kafka cluster provisioning. + readOnly: true + example: IN_USE + validation: + description: | + The validation details of the key. + readOnly: true + type: object + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: | + The timestamp since which the key is in the current validation phase. + Changes to the validation message or phase will update this timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: | + The cloud region where the key is deployed. This value is computed by the + API after the key is successfully validated. + example: us-west-2 + readOnly: true + required: + - api_version + - kind + - id + - key + - provider + - state + - validation + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateByokV1Key + summary: Update a Key + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a key. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the key. + tags: + - Keys (byok/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/byok.v1.Key' + responses: + '200': + description: Key. + content: + application/json: + schema: + type: object + description: |- + `Key` objects represent customer managed keys on dedicated Confluent Cloud clusters. + + Keys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP. + This API allows you to upload and retrieve self-managed keys on Confluent Cloud. + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + ## The Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. | + properties: + api_version: + type: string + enum: + - byok/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Key + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + key: + type: object + description: | + The cloud-specific key details. + + For AWS, provide the corresponding `key_arn`. + + For Azure, provide the corresponding `key_id`. + + For GCP, provide the corresponding `key_id`. + discriminator: + propertyName: kind + mapping: + AwsKey: '#/components/schemas/byok.v1.AwsKey' + AzureKey: '#/components/schemas/byok.v1.AzureKey' + GcpKey: '#/components/schemas/byok.v1.GcpKey' + x-immutable: true + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: | + The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - arn:aws:iam::123456789876:role/block_storage_manager + - arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + application_id: + description: | + The Application ID created for this key-environment combination. + type: string + readOnly: true + key_id: + description: | + The unique Key Object Identifier URL without version of an Azure Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + tenant_id: + description: | + Tenant ID (uuid) hosting the Key Vault containing the key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + required: + - key_arn + - kind + - key_id + - key_vault_id + - tenant_id + display_name: + type: string + description: | + The human-readable name of the key object. + example: Key for billing cluster + x-immutable: false + provider: + type: string + x-extensible-enum: + - AWS + - Azure + - GCP + description: The cloud provider of the Key. + readOnly: true + example: AWS + state: + type: string + x-extensible-enum: + - AVAILABLE + - IN_USE + description: | + The state of the key: + + AVAILABLE: key can be used for a Kafka cluster provisioning. + + IN_USE: key is already in use by a Kafka cluster provisioning. + readOnly: true + example: IN_USE + validation: + description: | + The validation details of the key. + readOnly: true + type: object + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: | + The timestamp since which the key is in the current validation phase. + Changes to the validation message or phase will update this timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: | + The cloud region where the key is deployed. This value is computed by the + API after the key is successfully validated. + example: us-west-2 + readOnly: true + required: + - api_version + - kind + - id + - key + - provider + - state + - validation + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteByokV1Key + summary: Delete a Key + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a key. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the key. + tags: + - Keys (byok/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Key is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + CreateKekRequest: + example: + kmsProps: + key: kmsProps + shared: true + name: name + doc: doc + kmsKeyId: kmsKeyId + kmsType: kmsType + properties: + name: + type: string + description: Name of the kek + kmsType: + type: string + description: KMS type of the kek + kmsKeyId: + type: string + description: KMS key ID of the kek + kmsProps: + type: object + additionalProperties: + type: string + description: Properties of the kek + doc: + type: string + description: Description of the kek + shared: + type: boolean + description: Whether the kek is shared + deleted: + type: boolean + description: Whether the kek is deleted + type: object + Kek: + example: + kmsProps: + key: kmsProps + shared: true + deleted: true + name: name + doc: doc + kmsKeyId: kmsKeyId + kmsType: kmsType + ts: 0 + properties: + name: + type: string + description: Name of the kek + kmsType: + type: string + description: KMS type of the kek + kmsKeyId: + type: string + description: KMS key ID of the kek + kmsProps: + type: object + additionalProperties: + type: string + description: Properties of the kek + doc: + type: string + description: Description of the kek + shared: + type: boolean + description: Whether the kek is shared + ts: + type: integer + description: Timestamp of the kek + format: int64 + deleted: + type: boolean + description: Whether the kek is deleted + type: object + UpdateKekRequest: + example: + kmsProps: + key: kmsProps + shared: true + doc: doc + properties: + kmsProps: + type: object + additionalProperties: + type: string + description: Properties of the kek + doc: + type: string + description: Description of the kek + shared: + type: boolean + description: Whether the kek is shared + type: object + CreateDekRequest: + example: + subject: subject + encryptedKeyMaterial: encryptedKeyMaterial + version: 0 + algorithm: AES128_GCM + properties: + subject: + type: string + description: Subject of the dek + version: + type: integer + description: Version of the dek + format: int32 + algorithm: + type: string + description: Algorithm of the dek + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + encryptedKeyMaterial: + type: string + description: Encrypted key material of the dek + deleted: + type: boolean + description: Whether the dek is deleted + type: object + Dek: + example: + kekName: kekName + keyMaterial: keyMaterial + deleted: true + subject: subject + encryptedKeyMaterial: encryptedKeyMaterial + version: 0 + algorithm: AES128_GCM + ts: 6 + properties: + kekName: + type: string + description: Kek name of the dek + subject: + type: string + description: Subject of the dek + version: + type: integer + description: Version of the dek + format: int32 + algorithm: + type: string + description: Algorithm of the dek + enum: + - AES128_GCM + - AES256_GCM + - AES256_SIV + encryptedKeyMaterial: + type: string + description: Encrypted key material of the dek + keyMaterial: + type: string + description: Raw key material of the dek + ts: + type: integer + description: Timestamp of the dek + format: int64 + deleted: + type: boolean + description: Whether the dek is deleted + type: object + SearchFilter: + description: Filter a collection by a string search + type: string + byok.v1.KeyList: + type: object + description: |- + `Key` objects represent customer managed keys on dedicated Confluent Cloud clusters. + + Keys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP. + This API allows you to upload and retrieve self-managed keys on Confluent Cloud. + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + ## The Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - byok/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KeyList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Key` objects represent customer managed keys on dedicated Confluent Cloud clusters. + + Keys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP. + This API allows you to upload and retrieve self-managed keys on Confluent Cloud. + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + ## The Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. | + properties: + api_version: + type: string + enum: + - byok/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Key + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + key: + type: object + description: | + The cloud-specific key details. + + For AWS, provide the corresponding `key_arn`. + + For Azure, provide the corresponding `key_id`. + + For GCP, provide the corresponding `key_id`. + discriminator: + propertyName: kind + mapping: + AwsKey: '#/components/schemas/byok.v1.AwsKey' + AzureKey: '#/components/schemas/byok.v1.AzureKey' + GcpKey: '#/components/schemas/byok.v1.GcpKey' + x-immutable: true + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: | + The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - arn:aws:iam::123456789876:role/block_storage_manager + - arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + application_id: + description: | + The Application ID created for this key-environment combination. + type: string + readOnly: true + key_id: + description: | + The unique Key Object Identifier URL without version of an Azure Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + tenant_id: + description: | + Tenant ID (uuid) hosting the Key Vault containing the key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + required: + - key_arn + - kind + - key_id + - key_vault_id + - tenant_id + display_name: + type: string + description: | + The human-readable name of the key object. + example: Key for billing cluster + x-immutable: false + provider: + type: string + x-extensible-enum: + - AWS + - Azure + - GCP + description: The cloud provider of the Key. + readOnly: true + example: AWS + state: + type: string + x-extensible-enum: + - AVAILABLE + - IN_USE + description: | + The state of the key: + + AVAILABLE: key can be used for a Kafka cluster provisioning. + + IN_USE: key is already in use by a Kafka cluster provisioning. + readOnly: true + example: IN_USE + validation: + description: | + The validation details of the key. + readOnly: true + type: object + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: | + The timestamp since which the key is in the current validation phase. + Changes to the validation message or phase will update this timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: | + The cloud region where the key is deployed. This value is computed by the + API after the key is successfully validated. + example: us-west-2 + readOnly: true + required: + - id + - metadata + - key + - provider + - state + - validation + uniqueItems: true + byok.v1.Key: + type: object + description: |- + `Key` objects represent customer managed keys on dedicated Confluent Cloud clusters. + + Keys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP. + This API allows you to upload and retrieve self-managed keys on Confluent Cloud. + + + Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). + + ## The Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. | + properties: + api_version: + type: string + enum: + - byok/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Key + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + key: + type: object + description: | + The cloud-specific key details. + + For AWS, provide the corresponding `key_arn`. + + For Azure, provide the corresponding `key_id`. + + For GCP, provide the corresponding `key_id`. + discriminator: + propertyName: kind + mapping: + AwsKey: '#/components/schemas/byok.v1.AwsKey' + AzureKey: '#/components/schemas/byok.v1.AzureKey' + GcpKey: '#/components/schemas/byok.v1.GcpKey' + x-immutable: true + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: | + The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - arn:aws:iam::123456789876:role/block_storage_manager + - arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + application_id: + description: | + The Application ID created for this key-environment combination. + type: string + readOnly: true + key_id: + description: | + The unique Key Object Identifier URL without version of an Azure Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + tenant_id: + description: | + Tenant ID (uuid) hosting the Key Vault containing the key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + required: + - key_arn + - kind + - key_id + - key_vault_id + - tenant_id + display_name: + type: string + description: | + The human-readable name of the key object. + example: Key for billing cluster + x-immutable: false + provider: + type: string + x-extensible-enum: + - AWS + - Azure + - GCP + description: The cloud provider of the Key. + readOnly: true + example: AWS + state: + type: string + x-extensible-enum: + - AVAILABLE + - IN_USE + description: | + The state of the key: + + AVAILABLE: key can be used for a Kafka cluster provisioning. + + IN_USE: key is already in use by a Kafka cluster provisioning. + readOnly: true + example: IN_USE + validation: + description: | + The validation details of the key. + readOnly: true + type: object + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: | + The timestamp since which the key is in the current validation phase. + Changes to the validation message or phase will update this timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: | + The cloud region where the key is deployed. This value is computed by the + API after the key is successfully validated. + example: us-west-2 + readOnly: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + byok.v1.AwsKey: + type: object + description: | + The AWS BYOK details + properties: + key_arn: + description: | + The Amazon Resource Name (ARN) of an AWS KMS key. + type: string + example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + x-immutable: true + roles: + description: | + The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination. + type: array + items: + type: string + readOnly: true + example: + - arn:aws:iam::123456789876:role/block_storage_manager + - arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa + kind: + description: | + BYOK kind type. + type: string + enum: + - AwsKey + x-immutable: true + required: + - key_arn + - kind + byok.v1.AzureKey: + type: object + description: | + The Azure BYOK details. + properties: + application_id: + description: | + The Application ID created for this key-environment combination. + type: string + readOnly: true + key_id: + description: | + The unique Key Object Identifier URL without version of an Azure Key Vault key. + type: string + example: https://vault-name.vault.azure.net/keys/key-name + x-immutable: true + key_vault_id: + description: | + Key Vault ID containing the key + type: string + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup-name/providers/Microsoft.KeyVault/vaults/vault-name + x-immutable: true + kind: + description: | + BYOK kind type. + type: string + enum: + - AzureKey + x-immutable: true + tenant_id: + description: | + Tenant ID (uuid) hosting the Key Vault containing the key + type: string + example: 00000000-0000-0000-0000-000000000000 + x-immutable: true + required: + - key_id + - key_vault_id + - kind + - tenant_id + byok.v1.GcpKey: + type: object + description: | + The GCP BYOK details + properties: + key_id: + description: | + The Google Cloud Platform key ID. + type: string + example: projects/exampleproject/locations/us-central1/keyRings/testkeyring/cryptoKeys/testbyokkey/cryptoKeyVersions/3 + x-immutable: true + security_group: + description: | + The Google security group created for this key. + type: string + example: testgroupid@domain.com + readOnly: true + kind: + description: | + BYOK kind type. + type: string + enum: + - GcpKey + x-immutable: true + required: + - key_id + - kind + byok.v1.KeyValidation: + type: object + description: | + The validation details of the key. + required: + - phase + - since + properties: + phase: + type: string + x-extensible-enum: + - INITIALIZING + - VALID + - INVALID + description: | + The validation phase of the key: + + INITIALIZING: Initial phase for new keys awaiting first successful validation. + + VALID: Last validation attempt succeeded. + + INVALID: Last validation attempt failed. + example: VALID + message: + type: string + description: | + A message describing validation events. + example: Access to key denied. + since: + type: string + format: date-time + description: | + The timestamp since which the key is in the current validation phase. + Changes to the validation message or phase will update this timestamp. + example: '2024-03-20T15:30:00Z' + region: + type: string + description: | + The cloud region where the key is deployed. This value is computed by the + API after the key is successfully validated. + example: us-west-2 + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + OverQuotaError: + x-summary: Over Quota + description: The request would exceed one or more quotas. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '402' + code: quota_exceeded + title: Kafka Clusters Per Org Quota Exceeded + detail: 'The request would exceed the quota: kafka_clusters_per_environment' + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/endpoints.yaml b/provider-dev/source/endpoints.yaml new file mode 100644 index 0000000..92e5970 --- /dev/null +++ b/provider-dev/source/endpoints.yaml @@ -0,0 +1,1475 @@ +openapi: 3.0.0 +info: + title: endpoints API + description: confluent endpoints API + version: 1.0.0 +paths: + /endpoint/v1/endpoints: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listEndpointV1Endpoints + summary: List of Endpoints + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all endpoints. + parameters: + - name: cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for cloud. + - name: region + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-west-2 + description: Filter the results by exact match for region. + - name: service + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: KAFKA + description: Filter the results by exact match for service. + - name: is_private + in: query + required: false + schema: + $ref: '#/components/schemas/BooleanFilter' + example: true + description: | + Filter the results by whether the endpoint is private (true) or public (false). + If not specified, returns both private and public endpoints. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: resource + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-abc123 + description: Filter the results by exact match for resource. + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 1000 + x-max-page-items: 5000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Endpoints (endpoint/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Endpoint. + content: + application/json: + schema: + type: object + description: |- + An Endpoint object represents a Fully Qualified Domain Name (FQDN) for a Confluent service resource + via a specific networking solution for a given Confluent Cloud environment. + This API provides a list of Confluent Cloud endpoints filtered by service, cloud provider, region, etc. + + + Related guides: + * [Resource Overview in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/resource-overview.html). + * [Manage Networking on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Endpoints Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - endpoint/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - EndpointList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + An Endpoint object represents a Fully Qualified Domain Name (FQDN) for a Confluent service resource + via a specific networking solution for a given Confluent Cloud environment. + This API provides a list of Confluent Cloud endpoints filtered by service, cloud provider, region, etc. + + + Related guides: + * [Resource Overview in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/resource-overview.html). + * [Manage Networking on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Endpoints Model + + properties: + api_version: + type: string + enum: + - endpoint/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Endpoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + readOnly: true + region: + type: string + description: The cloud service provider region in which the resource is located. + example: us-west-2 + readOnly: true + service: + type: string + description: The Confluent Cloud service. + x-extensible-enum: + - KAFKA + - SCHEMA_REGISTRY + - FLINK + example: KAFKA + readOnly: true + is_private: + type: boolean + description: Whether the endpoint is private (true) or public (false). + example: true + readOnly: true + connection_type: + type: string + description: The network connection type. + x-extensible-enum: + - PUBLIC + - PRIVATE_LINK + - PEERING + - TRANSIT_GATEWAY + - PRIVATE_NETWORK_INTERFACE + example: PRIVATE_LINK + readOnly: true + endpoint: + type: string + description: The endpoint URL or address. + example: https://lkc-abc123-ap12345.us-west-2.aws.accesspoint.glb.confluent.cloud:443 + readOnly: true + endpoint_type: + type: string + description: | + The endpoint type enum values: + * `REST` - REST API endpoint for HTTP/HTTPS access, used by Kafka/Flink/Schema Registry services. + * `BOOTSTRAP` - Kafka native protocol bootstrap servers for direct client connections, used by Kafka only. + * `LANGUAGE_SERVICE` - Flink language service endpoint for SQL/Table API, used by Flink only. + x-extensible-enum: + - REST + - BOOTSTRAP + - LANGUAGE_SERVICE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + resource: + description: | + The resource associated with the endpoint. + The resource can be one of Kafka Cluster ID (example: lkc-12345), + or Schema Registry Cluster ID (example: lsrc-12345). + May be null or omitted if not associated with a resource. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + gateway: + description: The gateway to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + access_point: + description: The access_point to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - cloud + - region + - service + - is_private + - connection_type + - endpoint + - endpoint_type + - environment + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + BooleanFilter: + type: boolean + description: Filter for whether this value is true or false. + endpoint.v1.EndpointList: + type: object + description: |- + An Endpoint object represents a Fully Qualified Domain Name (FQDN) for a Confluent service resource + via a specific networking solution for a given Confluent Cloud environment. + This API provides a list of Confluent Cloud endpoints filtered by service, cloud provider, region, etc. + + + Related guides: + * [Resource Overview in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/resource-overview.html). + * [Manage Networking on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Endpoints Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - endpoint/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - EndpointList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + An Endpoint object represents a Fully Qualified Domain Name (FQDN) for a Confluent service resource + via a specific networking solution for a given Confluent Cloud environment. + This API provides a list of Confluent Cloud endpoints filtered by service, cloud provider, region, etc. + + + Related guides: + * [Resource Overview in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/resource-overview.html). + * [Manage Networking on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Endpoints Model + + properties: + api_version: + type: string + enum: + - endpoint/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Endpoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + readOnly: true + region: + type: string + description: The cloud service provider region in which the resource is located. + example: us-west-2 + readOnly: true + service: + type: string + description: The Confluent Cloud service. + x-extensible-enum: + - KAFKA + - SCHEMA_REGISTRY + - FLINK + example: KAFKA + readOnly: true + is_private: + type: boolean + description: Whether the endpoint is private (true) or public (false). + example: true + readOnly: true + connection_type: + type: string + description: The network connection type. + x-extensible-enum: + - PUBLIC + - PRIVATE_LINK + - PEERING + - TRANSIT_GATEWAY + - PRIVATE_NETWORK_INTERFACE + example: PRIVATE_LINK + readOnly: true + endpoint: + type: string + description: The endpoint URL or address. + example: https://lkc-abc123-ap12345.us-west-2.aws.accesspoint.glb.confluent.cloud:443 + readOnly: true + endpoint_type: + type: string + description: | + The endpoint type enum values: + * `REST` - REST API endpoint for HTTP/HTTPS access, used by Kafka/Flink/Schema Registry services. + * `BOOTSTRAP` - Kafka native protocol bootstrap servers for direct client connections, used by Kafka only. + * `LANGUAGE_SERVICE` - Flink language service endpoint for SQL/Table API, used by Flink only. + x-extensible-enum: + - REST + - BOOTSTRAP + - LANGUAGE_SERVICE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + resource: + description: | + The resource associated with the endpoint. + The resource can be one of Kafka Cluster ID (example: lkc-12345), + or Schema Registry Cluster ID (example: lsrc-12345). + May be null or omitted if not associated with a resource. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + gateway: + description: The gateway to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + access_point: + description: The access_point to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - cloud + - region + - service + - is_private + - connection_type + - endpoint + - endpoint_type + - environment + uniqueItems: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + endpoint.v1.Endpoint: + type: object + description: |- + An Endpoint object represents a Fully Qualified Domain Name (FQDN) for a Confluent service resource + via a specific networking solution for a given Confluent Cloud environment. + This API provides a list of Confluent Cloud endpoints filtered by service, cloud provider, region, etc. + + + Related guides: + * [Resource Overview in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/resource-overview.html). + * [Manage Networking on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + + ## The Endpoints Model + + properties: + api_version: + type: string + enum: + - endpoint/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Endpoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + readOnly: true + region: + type: string + description: The cloud service provider region in which the resource is located. + example: us-west-2 + readOnly: true + service: + type: string + description: The Confluent Cloud service. + x-extensible-enum: + - KAFKA + - SCHEMA_REGISTRY + - FLINK + example: KAFKA + readOnly: true + is_private: + type: boolean + description: Whether the endpoint is private (true) or public (false). + example: true + readOnly: true + connection_type: + type: string + description: The network connection type. + x-extensible-enum: + - PUBLIC + - PRIVATE_LINK + - PEERING + - TRANSIT_GATEWAY + - PRIVATE_NETWORK_INTERFACE + example: PRIVATE_LINK + readOnly: true + endpoint: + type: string + description: The endpoint URL or address. + example: https://lkc-abc123-ap12345.us-west-2.aws.accesspoint.glb.confluent.cloud:443 + readOnly: true + endpoint_type: + type: string + description: | + The endpoint type enum values: + * `REST` - REST API endpoint for HTTP/HTTPS access, used by Kafka/Flink/Schema Registry services. + * `BOOTSTRAP` - Kafka native protocol bootstrap servers for direct client connections, used by Kafka only. + * `LANGUAGE_SERVICE` - Flink language service endpoint for SQL/Table API, used by Flink only. + x-extensible-enum: + - REST + - BOOTSTRAP + - LANGUAGE_SERVICE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + resource: + description: | + The resource associated with the endpoint. + The resource can be one of Kafka Cluster ID (example: lkc-12345), + or Schema Registry Cluster ID (example: lsrc-12345). + May be null or omitted if not associated with a resource. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + gateway: + description: The gateway to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + access_point: + description: The access_point to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + ObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + TypedEnvScopedObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/flink_artifacts.yaml b/provider-dev/source/flink_artifacts.yaml new file mode 100644 index 0000000..20f6695 --- /dev/null +++ b/provider-dev/source/flink_artifacts.yaml @@ -0,0 +1,2681 @@ +openapi: 3.0.0 +info: + title: flink_artifacts API + description: confluent flink_artifacts API + version: 1.0.0 +paths: + /artifact/v1/flink-artifacts: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listArtifactV1FlinkArtifacts + summary: List of Flink Artifacts + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all flink artifacts. + parameters: + - name: cloud + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for cloud. + - name: region + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-1 + description: Filter the results by exact match for region. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Flink Artifacts (artifact/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Flink Artifact. + content: + application/json: + schema: + type: object + description: |- + FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. + + + ## The Flink Artifacts Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifactList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. + + + ## The Flink Artifacts Model + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifact + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: The Cloud provider region the Flink Artifact archive is uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: Unique name of the Flink Artifact per cloud, region, environment scope. + maxLength: 60 + class: + type: string + description: Java class or alias for the artifact as provided by developer. Deprecated + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + x-immutable: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + versions: + type: array + description: Versions associated with this Flink Artifact. + items: + $ref: '#/components/schemas/artifact.v1.FlinkArtifactVersion' + required: + - id + - metadata + - cloud + - region + - environment + - display_name + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + summary: Create a new Flink Artifact. + requestBody: + content: + application/json: + schema: + type: object + properties: + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: The Cloud provider region the Flink Artifact archive is uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: Unique name of the Flink Artifact per cloud, region, environment scope. + maxLength: 60 + class: + type: string + description: Java class or alias for the artifact as provided by developer. Deprecated + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + upload_source: + type: object + description: Upload source of the Flink Artifact source. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/artifact.v1.UploadSource.PresignedUrl' + properties: + api_version: + type: string + enum: + - artifact.v1/UploadSource + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + location: + type: string + description: | + Location of the Flink Artifact source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: Upload ID returned by the `/presigned-upload-url` API. This field returns an empty string in all responses. + required: + - cloud + - region + - environment + - display_name + - upload_source + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createArtifactV1FlinkArtifact + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a flink artifact. + parameters: + - name: cloud + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Scope the operation to the given cloud. + - name: region + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-1 + description: Scope the operation to the given region. + tags: + - Flink Artifacts (artifact/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '201': + description: A Flink Artifact was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/artifact/v1/flink-artifacts/{id} + description: FlinkArtifact resource uri + content: + application/json: + schema: + type: object + description: |- + FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. + + + ## The Flink Artifacts Model + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifact + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: The Cloud provider region the Flink Artifact archive is uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: Unique name of the Flink Artifact per cloud, region, environment scope. + maxLength: 60 + class: + type: string + description: Java class or alias for the artifact as provided by developer. Deprecated + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + x-immutable: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + versions: + type: array + description: Versions associated with this Flink Artifact. + items: + $ref: '#/components/schemas/artifact.v1.FlinkArtifactVersion' + required: + - cloud + - region + - environment + - display_name + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /artifact/v1/flink-artifacts/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getArtifactV1FlinkArtifact + summary: Read a Flink Artifact + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a flink artifact. + parameters: + - name: cloud + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Scope the operation to the given cloud. + - name: region + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-1 + description: Scope the operation to the given region. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the flink artifact. + tags: + - Flink Artifacts (artifact/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Flink Artifact. + content: + application/json: + schema: + type: object + description: |- + FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. + + + ## The Flink Artifacts Model + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifact + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: The Cloud provider region the Flink Artifact archive is uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: Unique name of the Flink Artifact per cloud, region, environment scope. + maxLength: 60 + class: + type: string + description: Java class or alias for the artifact as provided by developer. Deprecated + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + x-immutable: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + versions: + type: array + description: Versions associated with this Flink Artifact. + items: + $ref: '#/components/schemas/artifact.v1.FlinkArtifactVersion' + required: + - api_version + - kind + - id + - cloud + - region + - environment + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateArtifactV1FlinkArtifact + summary: Update a Flink Artifact + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a flink artifact. + + parameters: + - name: cloud + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Scope the operation to the given cloud. + - name: region + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-1 + description: Scope the operation to the given region. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the flink artifact. + tags: + - Flink Artifacts (artifact/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/artifact.v1.FlinkArtifact' + responses: + '200': + description: Flink Artifact. + content: + application/json: + schema: + type: object + description: |- + FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. + + + ## The Flink Artifacts Model + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifact + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: The Cloud provider region the Flink Artifact archive is uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: Unique name of the Flink Artifact per cloud, region, environment scope. + maxLength: 60 + class: + type: string + description: Java class or alias for the artifact as provided by developer. Deprecated + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + x-immutable: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + versions: + type: array + description: Versions associated with this Flink Artifact. + items: + $ref: '#/components/schemas/artifact.v1.FlinkArtifactVersion' + required: + - api_version + - kind + - id + - cloud + - region + - environment + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteArtifactV1FlinkArtifact + summary: Delete a Flink Artifact + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a flink artifact. + parameters: + - name: cloud + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Scope the operation to the given cloud. + - name: region + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-1 + description: Scope the operation to the given region. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the flink artifact. + tags: + - Flink Artifacts (artifact/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Flink Artifact is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /artifact/v1/presigned-upload-url: + post: + summary: Request a presigned upload URL for a new Flink Artifact. + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Request a presigned upload URL to upload a Flink Artifact archive. + requestBody: + content: + application/json: + schema: + type: object + description: | + Request schema of the presigned upload URL. + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrlRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + content_format: + type: string + example: JAR + description: Archive format of the Flink Artifact. + x-extensible-enum: + - JAR + - ZIP + cloud: + type: string + example: AWS + description: Cloud provider where the Flink Artifact archive is uploaded. + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + example: us-east-1 + description: The Cloud provider region the Flink Artifact archive is uploaded. + maxLength: 60 + environment: + type: string + example: env-00000 + description: The Environment the uploaded Flink Artifact belongs to. + maxLength: 255 + required: + - content_format + - cloud + - region + - environment + x-lifecycle-stage: General Availability + x-self-access: true + x-name: artifact.v1.PresignedUrl + operationId: presigned-upload-urlArtifactV1PresignedUrl + tags: + - Presigned Urls (artifact/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Presigned Url. + content: + application/json: + schema: + type: object + description: |- + Request a presigned upload URL for new Flink Artifact. Note that + the URL policy expires in one hour. If the policy expires, you can request + a new presigned upload URL. + + + ## The Presigned Urls Model + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Flink Artifact archive. + example: JAR + x-extensible-enum: + - ZIP + - JAR + readOnly: true + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + readOnly: true + region: + type: string + description: The Cloud provider region the Flink Artifact archive is uploaded. + example: us-east-1 + readOnly: true + environment: + type: string + description: The Environment the uploaded Flink Artifact belongs to. + example: env-00000 + readOnly: true + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Flink Artifact archive. + example: https://confluent-flink-artifacts-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: string + description: Upload form data of the Flink Artifact. All values should be strings. (opaque JSON object) + example: + bucket: confluent-flink-artifacts-stag-us-west-2 + key: staging/flink-artifact/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/flink-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/artifact.jar + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + readOnly: true + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + artifact.v1.FlinkArtifactList: + type: object + description: |- + FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. + + + ## The Flink Artifacts Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifactList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. + + + ## The Flink Artifacts Model + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifact + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: The Cloud provider region the Flink Artifact archive is uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: Unique name of the Flink Artifact per cloud, region, environment scope. + maxLength: 60 + class: + type: string + description: Java class or alias for the artifact as provided by developer. Deprecated + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + x-immutable: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + versions: + type: array + description: Versions associated with this Flink Artifact. + items: + $ref: '#/components/schemas/artifact.v1.FlinkArtifactVersion' + required: + - id + - metadata + - cloud + - region + - environment + - display_name + uniqueItems: true + artifact.v1.UploadSource.PresignedUrl: + type: object + description: |- + Request a presigned upload URL for new Flink Artifact. Note that + the URL policy expires in one hour. If the policy expires, you can request + a new presigned upload URL. + + + ## The Presigned Urls Model + + properties: + api_version: + type: string + enum: + - artifact.v1/UploadSource + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + location: + type: string + description: | + Location of the Flink Artifact source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: Upload ID returned by the `/presigned-upload-url` API. This field returns an empty string in all responses. + artifact.v1.FlinkArtifact: + type: object + description: |- + FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. + + + ## The Flink Artifacts Model + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifact + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: The Cloud provider region the Flink Artifact archive is uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: Unique name of the Flink Artifact per cloud, region, environment scope. + maxLength: 60 + class: + type: string + description: Java class or alias for the artifact as provided by developer. Deprecated + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + x-immutable: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + versions: + type: array + description: Versions associated with this Flink Artifact. + items: + $ref: '#/components/schemas/artifact.v1.FlinkArtifactVersion' + artifact.v1.PresignedUrlRequest: + type: object + description: | + Request schema of the presigned upload URL. + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrlRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + content_format: + type: string + example: JAR + description: Archive format of the Flink Artifact. + x-extensible-enum: + - JAR + - ZIP + cloud: + type: string + example: AWS + description: Cloud provider where the Flink Artifact archive is uploaded. + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + example: us-east-1 + description: The Cloud provider region the Flink Artifact archive is uploaded. + maxLength: 60 + environment: + type: string + example: env-00000 + description: The Environment the uploaded Flink Artifact belongs to. + maxLength: 255 + artifact.v1.PresignedUrl: + type: object + description: |- + Request a presigned upload URL for new Flink Artifact. Note that + the URL policy expires in one hour. If the policy expires, you can request + a new presigned upload URL. + + + ## The Presigned Urls Model + + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + content_format: + type: string + description: Content format of the Flink Artifact archive. + example: JAR + x-extensible-enum: + - ZIP + - JAR + readOnly: true + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + x-extensible-enum: + - AWS + - GCP + - AZURE + readOnly: true + region: + type: string + description: The Cloud provider region the Flink Artifact archive is uploaded. + example: us-east-1 + readOnly: true + environment: + type: string + description: The Environment the uploaded Flink Artifact belongs to. + example: env-00000 + readOnly: true + upload_id: + type: string + description: Unique identifier of this upload. + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + readOnly: true + upload_url: + type: string + format: uri + description: Upload URL for the Flink Artifact archive. + example: https://confluent-flink-artifacts-stag-us-west-2.s3.dualstack.us-west-2.amazonaws.com/ + readOnly: true + upload_form_data: + type: string + description: Upload form data of the Flink Artifact. All values should be strings. (opaque JSON object) + example: + bucket: confluent-flink-artifacts-stag-us-west-2 + key: staging/flink-artifact/2f37f0b6-f8da-4e8b-bc5f-282ebb0511be/flink-e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66/artifact.jar + policy: string + x-amz-algorithm: AWS4-HMAC-SHA256 + x-amz-credential: string + x-amz-date: 20230725T013857Z + x-amz-security-token: string + x-amz-signature: string + readOnly: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + artifact.v1.FlinkArtifactVersion: + type: object + description: | + Version of the Flink Artifact + properties: + version: + type: string + description: Version id of the Flink Artifact. + example: cfa-ver-001 + maxLength: 60 + release_notes: + type: string + description: Release Notes of the Flink Artifact version. + maxLength: 256 + is_beta: + type: boolean + description: Flag to specify stability of the version + artifact_id: + type: object + description: The Flink Artifact this version belongs to. + properties: + api_version: + type: string + enum: + - artifact/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - FlinkArtifact + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: Cloud provider where the Flink Artifact archive is uploaded. + example: AWS + maxLength: 60 + x-extensible-enum: + - AWS + - GCP + - AZURE + region: + type: string + description: The Cloud provider region the Flink Artifact archive is uploaded. + example: us-east-1 + maxLength: 60 + environment: + type: string + description: Environment the Flink Artifact belongs to. + example: env-00000 + maxLength: 255 + display_name: + type: string + description: Unique name of the Flink Artifact per cloud, region, environment scope. + maxLength: 60 + class: + type: string + description: Java class or alias for the artifact as provided by developer. Deprecated + maxLength: 150 + pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$ + example: io.confluent.example.SumScalarFunction + deprecated: true + x-immutable: true + content_format: + type: string + description: Archive format of the Flink Artifact. + example: JAR + x-extensible-enum: + - ZIP + - JAR + description: + type: string + description: Description of the Flink Artifact. + maxLength: 256 + documentation_link: + type: string + description: Documentation link of the Flink Artifact. + maxLength: 512 + pattern: ^$|^(http://|https://).+ + runtime_language: + type: string + description: Runtime language of the Flink Artifact. + example: JAVA + default: JAVA + x-extensible-enum: + - JAVA + - PYTHON + versions: + type: array + description: Versions associated with this Flink Artifact. + items: + $ref: '#/components/schemas/artifact.v1.FlinkArtifactVersion' + upload_source: + type: object + description: Upload source of the Flink Artifact Version. + discriminator: + propertyName: location + mapping: + PRESIGNED_URL_LOCATION: '#/components/schemas/artifact.v1.UploadSource.PresignedUrl' + properties: + api_version: + type: string + enum: + - artifact.v1/UploadSource + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PresignedUrl + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + location: + type: string + description: | + Location of the Flink Artifact source. + x-extensible-enum: + - PRESIGNED_URL_LOCATION + example: PRESIGNED_URL_LOCATION + upload_id: + type: string + example: e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66 + description: Upload ID returned by the `/presigned-upload-url` API. This field returns an empty string in all responses. + required: + - version + - artifact_id + - upload_source + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/flink_compute_pools.yaml b/provider-dev/source/flink_compute_pools.yaml new file mode 100644 index 0000000..9f4524a --- /dev/null +++ b/provider-dev/source/flink_compute_pools.yaml @@ -0,0 +1,2619 @@ +openapi: 3.0.0 +info: + title: flink_compute_pools API + description: confluent flink_compute_pools API + version: 1.0.0 +paths: + /fcpm/v2/compute-pools: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listFcpmV2ComputePools + summary: List of Compute Pools + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all compute pools. + parameters: + - name: spec.region + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-west-1 + description: Filter the results by exact match for spec.region. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: n-00000 + description: Filter the results by exact match for spec.network. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Compute Pools (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Compute Pool. + content: + application/json: + schema: + type: object + description: |- + A Compute Pool represents a set of compute resources that is used to run your Queries. + The resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it. + Note that the Compute Pool API supports a limited pagination API, only the `next` field will be populated. + + + ## The Compute Pools Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePoolList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + A Compute Pool represents a set of compute resources that is used to run your Queries. + The resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it. + Note that the Compute Pool API supports a limited pagination API, only the `next` field will be populated. + + + ## The Compute Pools Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createFcpmV2ComputePool + summary: Create a Compute Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a compute pool. + tags: + - Compute Pools (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + A Compute Pool represents a set of compute resources that is used to run your Queries. + The resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it. + Note that the Compute Pool API supports a limited pagination API, only the `next` field will be populated. + + + ## The Compute Pools Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + required: + - spec + responses: + '202': + description: A Compute Pool is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/fcpm/v2/compute-pools/{id} + description: ComputePool resource uri + content: + application/json: + schema: + type: object + description: |- + A Compute Pool represents a set of compute resources that is used to run your Queries. + The resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it. + Note that the Compute Pool API supports a limited pagination API, only the `next` field will be populated. + + + ## The Compute Pools Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /fcpm/v2/compute-pools/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getFcpmV2ComputePool + summary: Read a Compute Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a compute pool. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the compute pool. + tags: + - Compute Pools (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Compute Pool. + content: + application/json: + schema: + type: object + description: |- + A Compute Pool represents a set of compute resources that is used to run your Queries. + The resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it. + Note that the Compute Pool API supports a limited pagination API, only the `next` field will be populated. + + + ## The Compute Pools Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateFcpmV2ComputePool + summary: Update a Compute Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a compute pool. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the compute pool. + tags: + - Compute Pools (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + A Compute Pool represents a set of compute resources that is used to run your Queries. + The resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it. + Note that the Compute Pool API supports a limited pagination API, only the `next` field will be populated. + + + ## The Compute Pools Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + required: + - spec + responses: + '200': + description: Compute Pool. + content: + application/json: + schema: + type: object + description: |- + A Compute Pool represents a set of compute resources that is used to run your Queries. + The resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it. + Note that the Compute Pool API supports a limited pagination API, only the `next` field will be populated. + + + ## The Compute Pools Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteFcpmV2ComputePool + summary: Delete a Compute Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a compute pool. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the compute pool. + tags: + - Compute Pools (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Compute Pool is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /fcpm/v2/regions: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listFcpmV2Regions + summary: List of Regions + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all regions. + parameters: + - name: cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for cloud. + - name: region_name + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-2 + description: Filter the results by exact match for region_name. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Regions (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Region. + content: + application/json: + schema: + type: object + description: |- + `Region` objects represent cloud provider regions available when placing Flink compute pools. + The API allows you to list Flink regions. + + + ## The Regions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RegionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Region` objects represent cloud provider regions available when placing Flink compute pools. + The API allows you to list Flink regions. + + + ## The Regions Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The display name. + example: Ohio (us-east-2) + x-immutable: true + readOnly: true + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + readOnly: true + region_name: + type: string + description: The region name. + example: us-east-2 + x-immutable: true + readOnly: true + http_endpoint: + type: string + description: The regional API endpoint for Flink compute pools. + format: uri + x-immutable: true + readOnly: true + private_http_endpoint: + type: string + description: The private regional API endpoint for Flink compute pools. + format: uri + x-immutable: true + readOnly: true + required: + - id + - metadata + - display_name + - cloud + - region_name + - http_endpoint + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /fcpm/v2/compute-pool-config: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getFcpmV2OrgComputePoolConfig + summary: Read an Org Compute Pool Config + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an org compute pool config. + tags: + - Org Compute Pool Configs (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Org Compute Pool Config. + content: + application/json: + schema: + type: object + description: |- + `OrgComputePoolConfig` manages compute pool configuration settings for an organization. + The API allows you to read and update organization-wide settings such as whether default pools are enabled + and their maximum CFU limits. + + + ## The Org Compute Pool Configs Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OrgComputePoolConfig + organization_id: + type: string + description: The ID of the organization. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + x-immutable: true + readOnly: true + spec: + type: object + description: The desired state of the organization-level Compute Pool configuration + properties: + default_pool_enabled: + type: boolean + default: true + description: | + Whether default compute pools are enabled for the organization. + When enabled, environments can have default compute pools created automatically. + x-immutable: false + default_pool_max_cfu: + type: integer + format: int32 + example: 20 + description: | + Maximum number of Confluent Flink Units (CFUs) that default compute pools + in this organization should auto-scale to. + x-extensible-enum: + - 5 + - 10 + - 20 + - 30 + - 40 + - 50 + x-immutable: false + x-immutable: false + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateFcpmV2OrgComputePoolConfig + summary: Update an Org Compute Pool Config + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an org compute pool config. + tags: + - Org Compute Pool Configs (fcpm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/fcpm.v2.OrgComputePoolConfig' + responses: + '200': + description: Org Compute Pool Config. + content: + application/json: + schema: + type: object + description: |- + `OrgComputePoolConfig` manages compute pool configuration settings for an organization. + The API allows you to read and update organization-wide settings such as whether default pools are enabled + and their maximum CFU limits. + + + ## The Org Compute Pool Configs Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OrgComputePoolConfig + organization_id: + type: string + description: The ID of the organization. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + x-immutable: true + readOnly: true + spec: + type: object + description: The desired state of the organization-level Compute Pool configuration + properties: + default_pool_enabled: + type: boolean + default: true + description: | + Whether default compute pools are enabled for the organization. + When enabled, environments can have default compute pools created automatically. + x-immutable: false + default_pool_max_cfu: + type: integer + format: int32 + example: 20 + description: | + Maximum number of Confluent Flink Units (CFUs) that default compute pools + in this organization should auto-scale to. + x-extensible-enum: + - 5 + - 10 + - 20 + - 30 + - 40 + - 50 + x-immutable: false + x-immutable: false + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + fcpm.v2.ComputePoolList: + type: object + description: |- + A Compute Pool represents a set of compute resources that is used to run your Queries. + The resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it. + Note that the Compute Pool API supports a limited pagination API, only the `next` field will be populated. + + + ## The Compute Pools Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePoolList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + A Compute Pool represents a set of compute resources that is used to run your Queries. + The resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it. + Note that the Compute Pool API supports a limited pagination API, only the `next` field will be populated. + + + ## The Compute Pools Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + fcpm.v2.ComputePool: + type: object + description: |- + A Compute Pool represents a set of compute resources that is used to run your Queries. + The resources (CPUs, memory,…) provided by a Compute Pool are shared between all Queries that use it. + Note that the Compute Pool API supports a limited pagination API, only the `next` field will be populated. + + + ## The Compute Pools Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ComputePool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/fcpm.v2.ComputePoolSpec' + status: + $ref: '#/components/schemas/fcpm.v2.ComputePoolStatus' + fcpm.v2.RegionList: + type: object + description: |- + `Region` objects represent cloud provider regions available when placing Flink compute pools. + The API allows you to list Flink regions. + + + ## The Regions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RegionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Region` objects represent cloud provider regions available when placing Flink compute pools. + The API allows you to list Flink regions. + + + ## The Regions Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The display name. + example: Ohio (us-east-2) + x-immutable: true + readOnly: true + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + readOnly: true + region_name: + type: string + description: The region name. + example: us-east-2 + x-immutable: true + readOnly: true + http_endpoint: + type: string + description: The regional API endpoint for Flink compute pools. + format: uri + x-immutable: true + readOnly: true + private_http_endpoint: + type: string + description: The private regional API endpoint for Flink compute pools. + format: uri + x-immutable: true + readOnly: true + required: + - id + - metadata + - display_name + - cloud + - region_name + - http_endpoint + uniqueItems: true + fcpm.v2.OrgComputePoolConfig: + type: object + description: |- + `OrgComputePoolConfig` manages compute pool configuration settings for an organization. + The API allows you to read and update organization-wide settings such as whether default pools are enabled + and their maximum CFU limits. + + + ## The Org Compute Pool Configs Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OrgComputePoolConfig + organization_id: + type: string + description: The ID of the organization. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + x-immutable: true + readOnly: true + spec: + type: object + description: The desired state of the organization-level Compute Pool configuration + properties: + default_pool_enabled: + type: boolean + default: true + description: | + Whether default compute pools are enabled for the organization. + When enabled, environments can have default compute pools created automatically. + x-immutable: false + default_pool_max_cfu: + type: integer + format: int32 + example: 20 + description: | + Maximum number of Confluent Flink Units (CFUs) that default compute pools + in this organization should auto-scale to. + x-extensible-enum: + - 5 + - 10 + - 20 + - 30 + - 40 + - 50 + x-immutable: false + x-immutable: false + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + fcpm.v2.ComputePoolSpec: + type: object + description: The desired state of the Compute Pool + properties: + display_name: + type: string + example: flink_compute_pool_0 + description: The name of the Flink compute pool. + pattern: ^(?:[0-9A-Za-z\-])[\w\.-]{0,63}$ + x-immutable: false + cloud: + type: string + description: The cloud service provider that runs the compute pool. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + example: us-west-1 + description: Flink compute pools in the region provided will be able to use this identity pool + x-immutable: true + max_cfu: + type: integer + format: int32 + example: 5 + description: | + Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to. + x-extensible-enum: + - 5 + - 10 + - 20 + - 30 + - 40 + - 50 + x-immutable: false + enable_ai: + type: boolean + default: false + description: | + The flag to enable AI computing using Ray for the Flink compute pool. It's available in the Early Access API + lifecycle stage only. + x-immutable: true + default_pool: + type: boolean + default: false + description: | + The flag to indicate whether the Flink compute pool is a default compute pool or not. + Only one default compute pool per environment and region is allowed. + x-immutable: false + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + description: The network to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + fcpm.v2.ComputePoolStatus: + type: object + required: + - phase + - current_cfu + description: The status of the Compute Pool + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PROVISIONED + - FAILED + - DEPROVISIONING + description: Status of the Flink compute pool. + example: PROVISIONING + readOnly: true + current_cfu: + type: integer + format: int32 + example: 4 + description: The number of Confluent Flink Units (CFUs) currently allocated to this Flink compute pool. + readOnly: true + readOnly: true + fcpm.v2.Region: + type: object + description: |- + `Region` objects represent cloud provider regions available when placing Flink compute pools. + The API allows you to list Flink regions. + + + ## The Regions Model + + properties: + api_version: + type: string + enum: + - fcpm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The display name. + example: Ohio (us-east-2) + x-immutable: true + readOnly: true + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + readOnly: true + region_name: + type: string + description: The region name. + example: us-east-2 + x-immutable: true + readOnly: true + http_endpoint: + type: string + description: The regional API endpoint for Flink compute pools. + format: uri + x-immutable: true + readOnly: true + private_http_endpoint: + type: string + description: The private regional API endpoint for Flink compute pools. + format: uri + x-immutable: true + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + GlobalObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + EnvScopedObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/iam.yaml b/provider-dev/source/iam.yaml new file mode 100644 index 0000000..7fe71fb --- /dev/null +++ b/provider-dev/source/iam.yaml @@ -0,0 +1,16241 @@ +openapi: 3.0.0 +info: + title: iam API + description: confluent iam API + version: 1.0.0 +paths: + /iam/v2/api-keys: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2ApiKeys + summary: List of API Keys + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all API keys. + + This can show all keys for a single owner (across resources - Kafka clusters), or all keys for a single + resource (across owners). If no `owner` or `resource` filters are specified, returns all API Keys in the + organization. You will only see the keys that are accessible to the account making the API request. + parameters: + - name: spec.owner + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + description: Filter the results by exact match for spec.owner. + - name: spec.resource + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + description: Filter the results by exact match for spec.resource. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - API Keys (iam/v2) + security: + - cloud-api-key: [] + responses: + '200': + description: API Key. + content: + application/json: + schema: + type: object + description: |- + `ApiKey` objects represent access to different parts of Confluent Cloud. Some types + of API keys represent access to a single cluster/resource such as a Kafka cluster, + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization + that are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API. + Tableflow API keys are not tied to a specific cluster. + + The API allows you to list, create, update and delete your API Keys. + + + Related guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + ## The API Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `apikeys_per_org` | API Keys in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKeyList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ApiKey` objects represent access to different parts of Confluent Cloud. Some types + of API keys represent access to a single cluster/resource such as a Kafka cluster, + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization + that are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API. + Tableflow API keys are not tied to a specific cluster. + + The API allows you to list, create, update and delete your API Keys. + + + Related guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + ## The API Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `apikeys_per_org` | API Keys in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKey + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/iam.v2.ApiKeySpec' + required: + - id + - metadata + - spec + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2ApiKey + summary: Create an API Key + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an API key. + tags: + - API Keys (iam/v2) + security: + - cloud-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `ApiKey` objects represent access to different parts of Confluent Cloud. Some types + of API keys represent access to a single cluster/resource such as a Kafka cluster, + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization + that are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API. + Tableflow API keys are not tied to a specific cluster. + + The API allows you to list, create, update and delete your API Keys. + + + Related guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + ## The API Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `apikeys_per_org` | API Keys in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKey + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/iam.v2.ApiKeySpec' + required: + - spec + responses: + '202': + description: An API Key is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/api-keys/{id} + description: ApiKey resource uri + content: + application/json: + schema: + type: object + description: |- + `ApiKey` objects represent access to different parts of Confluent Cloud. Some types + of API keys represent access to a single cluster/resource such as a Kafka cluster, + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization + that are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API. + Tableflow API keys are not tied to a specific cluster. + + The API allows you to list, create, update and delete your API Keys. + + + Related guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + ## The API Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `apikeys_per_org` | API Keys in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKey + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/iam.v2.ApiKeySpec' + required: + - spec + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/api-keys/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2ApiKey + summary: Read an API Key + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an API key. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the API key. + tags: + - API Keys (iam/v2) + security: + - cloud-api-key: [] + responses: + '200': + description: API Key. + content: + application/json: + schema: + type: object + description: |- + `ApiKey` objects represent access to different parts of Confluent Cloud. Some types + of API keys represent access to a single cluster/resource such as a Kafka cluster, + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization + that are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API. + Tableflow API keys are not tied to a specific cluster. + + The API allows you to list, create, update and delete your API Keys. + + + Related guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + ## The API Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `apikeys_per_org` | API Keys in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKey + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/iam.v2.ApiKeySpec' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2ApiKey + summary: Update an API Key + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an API key. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the API key. + tags: + - API Keys (iam/v2) + security: + - cloud-api-key: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.ApiKey' + responses: + '200': + description: API Key. + content: + application/json: + schema: + type: object + description: |- + `ApiKey` objects represent access to different parts of Confluent Cloud. Some types + of API keys represent access to a single cluster/resource such as a Kafka cluster, + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization + that are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API. + Tableflow API keys are not tied to a specific cluster. + + The API allows you to list, create, update and delete your API Keys. + + + Related guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + ## The API Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `apikeys_per_org` | API Keys in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKey + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/iam.v2.ApiKeySpec' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2ApiKey + summary: Delete an API Key + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an API key. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the API key. + tags: + - API Keys (iam/v2) + security: + - cloud-api-key: [] + responses: + '204': + description: An API Key is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/users: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2Users + summary: List of Users + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all users. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Users (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: User. + content: + application/json: + schema: + type: object + description: |- + `User` objects represent individuals who may access your Confluent resources. + + The API allows you to retrieve, update, and delete individual users, as well as list of all your + users. This API cannot be used to create new user accounts. + + + Related guide: [Users in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + ## The Users Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `users_per_org` | Users in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - UserList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `User` objects represent individuals who may access your Confluent resources. + + The API allows you to retrieve, update, and delete individual users, as well as list of all your + users. This API cannot be used to create new user accounts. + + + Related guide: [Users in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + ## The Users Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `users_per_org` | Users in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - User + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: marty.mcfly@example.com + description: The user's email address + x-immutable: true + full_name: + example: Marty McFly + type: string + description: The user's full name + auth_type: + type: string + description: The user's authentication method + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + readOnly: true + required: + - id + - metadata + - email + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/users/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2User + summary: Read a User + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a user. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the user. + tags: + - Users (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: User. + content: + application/json: + schema: + type: object + description: |- + `User` objects represent individuals who may access your Confluent resources. + + The API allows you to retrieve, update, and delete individual users, as well as list of all your + users. This API cannot be used to create new user accounts. + + + Related guide: [Users in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + ## The Users Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `users_per_org` | Users in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - User + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: marty.mcfly@example.com + description: The user's email address + x-immutable: true + full_name: + example: Marty McFly + type: string + description: The user's full name + auth_type: + type: string + description: The user's authentication method + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + readOnly: true + required: + - api_version + - kind + - id + - email + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2User + summary: Update a User + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a user. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the user. + tags: + - Users (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.User' + responses: + '200': + description: User. + content: + application/json: + schema: + type: object + description: |- + `User` objects represent individuals who may access your Confluent resources. + + The API allows you to retrieve, update, and delete individual users, as well as list of all your + users. This API cannot be used to create new user accounts. + + + Related guide: [Users in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + ## The Users Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `users_per_org` | Users in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - User + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: marty.mcfly@example.com + description: The user's email address + x-immutable: true + full_name: + example: Marty McFly + type: string + description: The user's full name + auth_type: + type: string + description: The user's authentication method + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + readOnly: true + required: + - api_version + - kind + - id + - email + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2User + summary: Delete a User + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a user. + + If successful, this request will also recursively delete all of the user's associated resources, + including its cloud and cluster API keys. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the user. + tags: + - Users (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A User is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/users/{id}/auth: + patch: + summary: Update Auth Type of a User + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Update the auth type of a user + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.User.ConfigureUserAuthRequest' + x-lifecycle-stage: General Availability + x-self-access: true + x-name: iam.v2.User + operationId: update_auth_typeIamV2User + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the user. + tags: + - Users (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/service-accounts: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2ServiceAccounts + summary: List of Service Accounts + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all service accounts. + parameters: + - name: display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - tf_runner_sa + - mySA + description: Filter the results by exact match for display_name. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Service Accounts (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Service Account. + content: + application/json: + schema: + type: object + description: |- + `ServiceAccount` objects are typically used to represent applications and other non-human principals + that may access your Confluent resources. + + The API allows you to create, retrieve, update, and delete individual service accounts, as well as + list all your service accounts. + + + Related guide: [Service Accounts in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + ## The Service Accounts Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `service_accounts_per_org` | Service Accounts in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccountList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ServiceAccount` objects are typically used to represent applications and other non-human principals + that may access your Confluent resources. + + The API allows you to create, retrieve, update, and delete individual service accounts, as well as + list all your service accounts. + + + Related guide: [Service Accounts in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + ## The Service Accounts Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `service_accounts_per_org` | Service Accounts in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccount + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: DeLorean_auto_repair + description: A human-readable name for the Service Account + description: + type: string + example: Doc's repair bot for the DeLorean + description: A free-form description of the Service Account + required: + - id + - metadata + - display_name + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2ServiceAccount + summary: Create a Service Account + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a service account. + parameters: + - name: assigned_resource_owner + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: u-a83k9b + description: The resource_id of the principal who will be assigned resource owner on the created service account. Principal can be group-mapping (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx). + tags: + - Service Accounts (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `ServiceAccount` objects are typically used to represent applications and other non-human principals + that may access your Confluent resources. + + The API allows you to create, retrieve, update, and delete individual service accounts, as well as + list all your service accounts. + + + Related guide: [Service Accounts in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + ## The Service Accounts Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `service_accounts_per_org` | Service Accounts in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccount + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: DeLorean_auto_repair + description: A human-readable name for the Service Account + description: + type: string + example: Doc's repair bot for the DeLorean + description: A free-form description of the Service Account + required: + - display_name + responses: + '201': + description: A Service Account was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/service-accounts/{id} + description: ServiceAccount resource uri + content: + application/json: + schema: + type: object + description: |- + `ServiceAccount` objects are typically used to represent applications and other non-human principals + that may access your Confluent resources. + + The API allows you to create, retrieve, update, and delete individual service accounts, as well as + list all your service accounts. + + + Related guide: [Service Accounts in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + ## The Service Accounts Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `service_accounts_per_org` | Service Accounts in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccount + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: DeLorean_auto_repair + description: A human-readable name for the Service Account + description: + type: string + example: Doc's repair bot for the DeLorean + description: A free-form description of the Service Account + required: + - display_name + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/service-accounts/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2ServiceAccount + summary: Read a Service Account + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a service account. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the service account. + tags: + - Service Accounts (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Service Account. + content: + application/json: + schema: + type: object + description: |- + `ServiceAccount` objects are typically used to represent applications and other non-human principals + that may access your Confluent resources. + + The API allows you to create, retrieve, update, and delete individual service accounts, as well as + list all your service accounts. + + + Related guide: [Service Accounts in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + ## The Service Accounts Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `service_accounts_per_org` | Service Accounts in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccount + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: DeLorean_auto_repair + description: A human-readable name for the Service Account + description: + type: string + example: Doc's repair bot for the DeLorean + description: A free-form description of the Service Account + required: + - api_version + - kind + - id + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2ServiceAccount + summary: Update a Service Account + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a service account. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the service account. + tags: + - Service Accounts (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.ServiceAccount' + responses: + '200': + description: Service Account. + content: + application/json: + schema: + type: object + description: |- + `ServiceAccount` objects are typically used to represent applications and other non-human principals + that may access your Confluent resources. + + The API allows you to create, retrieve, update, and delete individual service accounts, as well as + list all your service accounts. + + + Related guide: [Service Accounts in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + ## The Service Accounts Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `service_accounts_per_org` | Service Accounts in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccount + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: DeLorean_auto_repair + description: A human-readable name for the Service Account + description: + type: string + example: Doc's repair bot for the DeLorean + description: A free-form description of the Service Account + required: + - api_version + - kind + - id + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2ServiceAccount + summary: Delete a Service Account + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a service account. + + If successful, this request will also recursively delete all of the service account's associated resources, + including its cloud and cluster API keys. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the service account. + tags: + - Service Accounts (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Service Account is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/invitations: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2Invitations + summary: List of Invitations + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all invitations. + parameters: + - name: email + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: johndoe@confluent.io + description: Filter the results by exact match for email. + - name: status + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: INVITE_STATUS_SENT + description: Filter the results by exact match for status. + - name: user + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: u-j93dy8 + description: Filter the results by exact match for user. + - name: creator + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: u-m2r9o7 + description: Filter the results by exact match for creator. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Invitations (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Invitation. + content: + application/json: + schema: + type: object + description: |- + `Invitation` objects represent invitations to invite users to join your organizations in Confluent Cloud. + + The API allows you to list all your invitations, as well as create, read, and delete a specified invitation. + + + Related guide: [User invitations in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + ## The Invitations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `invitations_per_org` | Invitations in a Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - InvitationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Invitation` objects represent invitations to invite users to join your organizations in Confluent Cloud. + + The API allows you to list all your invitations, as well as create, read, and delete a specified invitation. + + + Related guide: [User invitations in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + ## The Invitations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `invitations_per_org` | Invitations in a Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Invitation + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: johndoe@confluent.io + description: The user/invitee's email address + x-immutable: true + auth_type: + type: string + description: | + The user/invitee's authentication type. Note that only the [OrganizationAdmin role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) + can invite AUTH_TYPE_LOCAL users to SSO organizations. + The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. + Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default. + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + status: + type: string + example: INVITE_STATUS_SENT + description: The status of invitations + x-extensible-enum: + - INVITE_STATUS_SENT + - INVITE_STATUS_STAGED + - INVITE_STATUS_ACCEPTED + - INVITE_STATUS_EXPIRED + - INVITE_STATUS_DEACTIVATED + readOnly: true + accepted_at: + type: string + format: date-time + example: '2022-07-06T17:21:33.000Z' + description: The timestamp that the invitation was accepted + nullable: true + readOnly: true + expires_at: + type: string + format: date-time + example: '2022-07-07T17:22:39.000Z' + description: The timestamp that the invitation will expire + readOnly: true + user: + description: The user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + creator: + description: The invitation creator + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - email + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2Invitation + summary: Create an Invitation + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an invitation. + + The newly invited user will not have any permissions. Give the user permission by assigning them to one or + more roles by creating + [role bindings](https://docs.confluent.io/cloud/current/api.html#tag/Role-Bindings-(iamv2)) + for the created `user`. + tags: + - Invitations (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Invitation` objects represent invitations to invite users to join your organizations in Confluent Cloud. + + The API allows you to list all your invitations, as well as create, read, and delete a specified invitation. + + + Related guide: [User invitations in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + ## The Invitations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `invitations_per_org` | Invitations in a Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Invitation + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: johndoe@confluent.io + description: The user/invitee's email address + x-immutable: true + auth_type: + type: string + description: | + The user/invitee's authentication type. Note that only the [OrganizationAdmin role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) + can invite AUTH_TYPE_LOCAL users to SSO organizations. + The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. + Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default. + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + status: + type: string + example: INVITE_STATUS_SENT + description: The status of invitations + x-extensible-enum: + - INVITE_STATUS_SENT + - INVITE_STATUS_STAGED + - INVITE_STATUS_ACCEPTED + - INVITE_STATUS_EXPIRED + - INVITE_STATUS_DEACTIVATED + readOnly: true + accepted_at: + type: string + format: date-time + example: '2022-07-06T17:21:33.000Z' + description: The timestamp that the invitation was accepted + nullable: true + readOnly: true + expires_at: + type: string + format: date-time + example: '2022-07-07T17:22:39.000Z' + description: The timestamp that the invitation will expire + readOnly: true + user: + description: The user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + creator: + description: The invitation creator + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - email + responses: + '201': + description: An Invitation was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/invitations/{id} + description: Invitation resource uri + content: + application/json: + schema: + type: object + description: |- + `Invitation` objects represent invitations to invite users to join your organizations in Confluent Cloud. + + The API allows you to list all your invitations, as well as create, read, and delete a specified invitation. + + + Related guide: [User invitations in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + ## The Invitations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `invitations_per_org` | Invitations in a Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Invitation + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: johndoe@confluent.io + description: The user/invitee's email address + x-immutable: true + auth_type: + type: string + description: | + The user/invitee's authentication type. Note that only the [OrganizationAdmin role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) + can invite AUTH_TYPE_LOCAL users to SSO organizations. + The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. + Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default. + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + status: + type: string + example: INVITE_STATUS_SENT + description: The status of invitations + x-extensible-enum: + - INVITE_STATUS_SENT + - INVITE_STATUS_STAGED + - INVITE_STATUS_ACCEPTED + - INVITE_STATUS_EXPIRED + - INVITE_STATUS_DEACTIVATED + readOnly: true + accepted_at: + type: string + format: date-time + example: '2022-07-06T17:21:33.000Z' + description: The timestamp that the invitation was accepted + nullable: true + readOnly: true + expires_at: + type: string + format: date-time + example: '2022-07-07T17:22:39.000Z' + description: The timestamp that the invitation will expire + readOnly: true + user: + description: The user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + creator: + description: The invitation creator + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - email + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/invitations/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2Invitation + summary: Read an Invitation + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an invitation. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the invitation. + tags: + - Invitations (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Invitation. + content: + application/json: + schema: + type: object + description: |- + `Invitation` objects represent invitations to invite users to join your organizations in Confluent Cloud. + + The API allows you to list all your invitations, as well as create, read, and delete a specified invitation. + + + Related guide: [User invitations in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + ## The Invitations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `invitations_per_org` | Invitations in a Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Invitation + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: johndoe@confluent.io + description: The user/invitee's email address + x-immutable: true + auth_type: + type: string + description: | + The user/invitee's authentication type. Note that only the [OrganizationAdmin role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) + can invite AUTH_TYPE_LOCAL users to SSO organizations. + The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. + Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default. + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + status: + type: string + example: INVITE_STATUS_SENT + description: The status of invitations + x-extensible-enum: + - INVITE_STATUS_SENT + - INVITE_STATUS_STAGED + - INVITE_STATUS_ACCEPTED + - INVITE_STATUS_EXPIRED + - INVITE_STATUS_DEACTIVATED + readOnly: true + accepted_at: + type: string + format: date-time + example: '2022-07-06T17:21:33.000Z' + description: The timestamp that the invitation was accepted + nullable: true + readOnly: true + expires_at: + type: string + format: date-time + example: '2022-07-07T17:22:39.000Z' + description: The timestamp that the invitation will expire + readOnly: true + user: + description: The user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + creator: + description: The invitation creator + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - email + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2Invitation + summary: Delete an Invitation + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an invitation. + + Delete will deactivate the user if the user didn't accept the invitation yet. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the invitation. + tags: + - Invitations (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Invitation is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/ip-groups: + get: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + operationId: listIamV2IpGroups + summary: List of IP Groups + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all IP groups. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 25 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - IP Groups (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: IP Group. + content: + application/json: + schema: + type: object + description: |- + Definitions of networks which can be named and referred by IP blocks, commonly used to attach to IP Filter rules. + + + ## The IP Groups Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroupList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + Definitions of networks which can be named and referred by IP blocks, commonly used to attach to IP Filter rules. + + + ## The IP Groups Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroup + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + group_name: + type: string + minLength: 1 + maxLength: 64 + example: CorpNet + description: | + A human readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or + any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + cidr_blocks: + type: array + items: + type: string + minItems: 1 + maxItems: 25 + example: + - 192.168.0.0/24 + - 192.168.7.0/24 + description: A list of CIDRs. + required: + - id + - metadata + - group_name + - cidr_blocks + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-page-first-available: true + x-page-last-available: true + x-page-from-start: true + x-page-from-end: true + post: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + operationId: createIamV2IpGroup + summary: Create an IP Group + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an IP group. + tags: + - IP Groups (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + Definitions of networks which can be named and referred by IP blocks, commonly used to attach to IP Filter rules. + + + ## The IP Groups Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroup + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + group_name: + type: string + minLength: 1 + maxLength: 64 + example: CorpNet + description: | + A human readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or + any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + cidr_blocks: + type: array + items: + type: string + minItems: 1 + maxItems: 25 + example: + - 192.168.0.0/24 + - 192.168.7.0/24 + description: A list of CIDRs. + required: + - group_name + - cidr_blocks + responses: + '201': + description: An IP Group was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/ip-groups/{id} + description: IpGroup resource uri + content: + application/json: + schema: + type: object + description: |- + Definitions of networks which can be named and referred by IP blocks, commonly used to attach to IP Filter rules. + + + ## The IP Groups Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroup + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + group_name: + type: string + minLength: 1 + maxLength: 64 + example: CorpNet + description: | + A human readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or + any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + cidr_blocks: + type: array + items: + type: string + minItems: 1 + maxItems: 25 + example: + - 192.168.0.0/24 + - 192.168.7.0/24 + description: A list of CIDRs. + required: + - group_name + - cidr_blocks + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + /iam/v2/ip-groups/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + operationId: getIamV2IpGroup + summary: Read an IP Group + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an IP group. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP group. + tags: + - IP Groups (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: IP Group. + content: + application/json: + schema: + type: object + description: |- + Definitions of networks which can be named and referred by IP blocks, commonly used to attach to IP Filter rules. + + + ## The IP Groups Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroup + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + group_name: + type: string + minLength: 1 + maxLength: 64 + example: CorpNet + description: | + A human readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or + any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + cidr_blocks: + type: array + items: + type: string + minItems: 1 + maxItems: 25 + example: + - 192.168.0.0/24 + - 192.168.7.0/24 + description: A list of CIDRs. + required: + - api_version + - kind + - id + - group_name + - cidr_blocks + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + operationId: updateIamV2IpGroup + summary: Update an IP Group + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an IP group. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP group. + tags: + - IP Groups (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.IpGroup' + responses: + '200': + description: IP Group. + content: + application/json: + schema: + type: object + description: |- + Definitions of networks which can be named and referred by IP blocks, commonly used to attach to IP Filter rules. + + + ## The IP Groups Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroup + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + group_name: + type: string + minLength: 1 + maxLength: 64 + example: CorpNet + description: | + A human readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or + any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + cidr_blocks: + type: array + items: + type: string + minItems: 1 + maxItems: 25 + example: + - 192.168.0.0/24 + - 192.168.7.0/24 + description: A list of CIDRs. + required: + - api_version + - kind + - id + - group_name + - cidr_blocks + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + operationId: deleteIamV2IpGroup + summary: Delete an IP Group + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an IP group. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP group. + tags: + - IP Groups (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An IP Group is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Groups API + /iam/v2/ip-filters: + get: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + operationId: listIamV2IpFilters + summary: List of IP Filters + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all IP filters. + parameters: + - name: resource_scope + in: query + required: false + schema: + type: string + description: Lists all filters belonging to the specified resource scope. + - name: include_parent_scopes + in: query + required: false + schema: + type: string + description: If set to true, this includes filters defined at the organization level. The resource scope must also be set to use this parameter. + - name: page_size + in: query + required: false + schema: + type: integer + default: 25 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - IP Filters (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: IP Filter. + content: + application/json: + schema: + type: object + description: |- + `IP Filter` objects are bindings between IP Groups and Confluent resource(s). + For example, a binding between "CorpNet" and "Management APIs" will enforce that + access must come from one of the CIDR blocks associated with CorpNet. + If there are multiple IP filters bound to a resource, a request matching any of the CIDR blocks + for any of the IP Group will allow the request. + If there are no IP Filters for a resource, then access will be granted to requests originating + from any IP Address. + + + ## The IP Filters Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `IP Filter` objects are bindings between IP Groups and Confluent resource(s). + For example, a binding between "CorpNet" and "Management APIs" will enforce that + access must come from one of the CIDR blocks associated with CorpNet. + If there are multiple IP filters bound to a resource, a request matching any of the CIDR blocks + for any of the IP Group will allow the request. + If there are no IP Filters for a resource, then access will be granted to requests originating + from any IP Address. + + + ## The IP Filters Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilter + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + filter_name: + type: string + minLength: 1 + maxLength: 64 + example: Management API Rules + description: | + A human readable name for an IP Filter. Can contain any unicode letter or number, the ASCII space character, + or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + resource_group: + type: string + example: management + description: | + Scope of resources covered by this IP filter. Available resource groups include "management" and "multiple". + resource_scope: + type: string + example: crn://confluent.cloud/organization=org-123/environment=env-abc + format: uri + pattern: ^crn://.+$ + description: | + A CRN that specifies the scope of the ip filter, specifically the organization + or environment. Without specifying this property, the ip filter + would apply to the whole organization. + operation_groups: + type: array + items: + type: string + example: + - MANAGEMENT + - SCHEMA + - FLINK + description: | + Scope of resources covered by this IP filter. Resource group must be set to 'multiple' + in order to use this property.During update operations, note that the operation + groups passed in will replace the list of existing operation groups + (passing in an empty list will remove all operation groups) from the filter + (in line with the behavior for ip_groups). + ip_groups: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: A list of IP Groups. + minItems: 1 + maxItems: 25 + required: + - id + - metadata + - filter_name + - resource_group + - ip_groups + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-page-first-available: true + x-page-last-available: true + x-page-from-start: true + x-page-from-end: true + post: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + operationId: createIamV2IpFilter + summary: Create an IP Filter + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an IP filter. + tags: + - IP Filters (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `IP Filter` objects are bindings between IP Groups and Confluent resource(s). + For example, a binding between "CorpNet" and "Management APIs" will enforce that + access must come from one of the CIDR blocks associated with CorpNet. + If there are multiple IP filters bound to a resource, a request matching any of the CIDR blocks + for any of the IP Group will allow the request. + If there are no IP Filters for a resource, then access will be granted to requests originating + from any IP Address. + + + ## The IP Filters Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilter + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + filter_name: + type: string + minLength: 1 + maxLength: 64 + example: Management API Rules + description: | + A human readable name for an IP Filter. Can contain any unicode letter or number, the ASCII space character, + or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + resource_group: + type: string + example: management + description: | + Scope of resources covered by this IP filter. Available resource groups include "management" and "multiple". + resource_scope: + type: string + example: crn://confluent.cloud/organization=org-123/environment=env-abc + format: uri + pattern: ^crn://.+$ + description: | + A CRN that specifies the scope of the ip filter, specifically the organization + or environment. Without specifying this property, the ip filter + would apply to the whole organization. + operation_groups: + type: array + items: + type: string + example: + - MANAGEMENT + - SCHEMA + - FLINK + description: | + Scope of resources covered by this IP filter. Resource group must be set to 'multiple' + in order to use this property.During update operations, note that the operation + groups passed in will replace the list of existing operation groups + (passing in an empty list will remove all operation groups) from the filter + (in line with the behavior for ip_groups). + ip_groups: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: A list of IP Groups. + minItems: 1 + maxItems: 25 + required: + - filter_name + - resource_group + - ip_groups + responses: + '201': + description: An IP Filter was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/ip-filters/{id} + description: IpFilter resource uri + content: + application/json: + schema: + type: object + description: |- + `IP Filter` objects are bindings between IP Groups and Confluent resource(s). + For example, a binding between "CorpNet" and "Management APIs" will enforce that + access must come from one of the CIDR blocks associated with CorpNet. + If there are multiple IP filters bound to a resource, a request matching any of the CIDR blocks + for any of the IP Group will allow the request. + If there are no IP Filters for a resource, then access will be granted to requests originating + from any IP Address. + + + ## The IP Filters Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilter + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + filter_name: + type: string + minLength: 1 + maxLength: 64 + example: Management API Rules + description: | + A human readable name for an IP Filter. Can contain any unicode letter or number, the ASCII space character, + or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + resource_group: + type: string + example: management + description: | + Scope of resources covered by this IP filter. Available resource groups include "management" and "multiple". + resource_scope: + type: string + example: crn://confluent.cloud/organization=org-123/environment=env-abc + format: uri + pattern: ^crn://.+$ + description: | + A CRN that specifies the scope of the ip filter, specifically the organization + or environment. Without specifying this property, the ip filter + would apply to the whole organization. + operation_groups: + type: array + items: + type: string + example: + - MANAGEMENT + - SCHEMA + - FLINK + description: | + Scope of resources covered by this IP filter. Resource group must be set to 'multiple' + in order to use this property.During update operations, note that the operation + groups passed in will replace the list of existing operation groups + (passing in an empty list will remove all operation groups) from the filter + (in line with the behavior for ip_groups). + ip_groups: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: A list of IP Groups. + minItems: 1 + maxItems: 25 + required: + - filter_name + - resource_group + - ip_groups + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + /iam/v2/ip-filters/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + operationId: getIamV2IpFilter + summary: Read an IP Filter + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an IP filter. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP filter. + tags: + - IP Filters (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: IP Filter. + content: + application/json: + schema: + type: object + description: |- + `IP Filter` objects are bindings between IP Groups and Confluent resource(s). + For example, a binding between "CorpNet" and "Management APIs" will enforce that + access must come from one of the CIDR blocks associated with CorpNet. + If there are multiple IP filters bound to a resource, a request matching any of the CIDR blocks + for any of the IP Group will allow the request. + If there are no IP Filters for a resource, then access will be granted to requests originating + from any IP Address. + + + ## The IP Filters Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilter + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + filter_name: + type: string + minLength: 1 + maxLength: 64 + example: Management API Rules + description: | + A human readable name for an IP Filter. Can contain any unicode letter or number, the ASCII space character, + or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + resource_group: + type: string + example: management + description: | + Scope of resources covered by this IP filter. Available resource groups include "management" and "multiple". + resource_scope: + type: string + example: crn://confluent.cloud/organization=org-123/environment=env-abc + format: uri + pattern: ^crn://.+$ + description: | + A CRN that specifies the scope of the ip filter, specifically the organization + or environment. Without specifying this property, the ip filter + would apply to the whole organization. + operation_groups: + type: array + items: + type: string + example: + - MANAGEMENT + - SCHEMA + - FLINK + description: | + Scope of resources covered by this IP filter. Resource group must be set to 'multiple' + in order to use this property.During update operations, note that the operation + groups passed in will replace the list of existing operation groups + (passing in an empty list will remove all operation groups) from the filter + (in line with the behavior for ip_groups). + ip_groups: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: A list of IP Groups. + minItems: 1 + maxItems: 25 + required: + - api_version + - kind + - id + - filter_name + - resource_group + - ip_groups + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + operationId: updateIamV2IpFilter + summary: Update an IP Filter + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an IP filter. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP filter. + tags: + - IP Filters (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.IpFilter' + responses: + '200': + description: IP Filter. + content: + application/json: + schema: + type: object + description: |- + `IP Filter` objects are bindings between IP Groups and Confluent resource(s). + For example, a binding between "CorpNet" and "Management APIs" will enforce that + access must come from one of the CIDR blocks associated with CorpNet. + If there are multiple IP filters bound to a resource, a request matching any of the CIDR blocks + for any of the IP Group will allow the request. + If there are no IP Filters for a resource, then access will be granted to requests originating + from any IP Address. + + + ## The IP Filters Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilter + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + filter_name: + type: string + minLength: 1 + maxLength: 64 + example: Management API Rules + description: | + A human readable name for an IP Filter. Can contain any unicode letter or number, the ASCII space character, + or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + resource_group: + type: string + example: management + description: | + Scope of resources covered by this IP filter. Available resource groups include "management" and "multiple". + resource_scope: + type: string + example: crn://confluent.cloud/organization=org-123/environment=env-abc + format: uri + pattern: ^crn://.+$ + description: | + A CRN that specifies the scope of the ip filter, specifically the organization + or environment. Without specifying this property, the ip filter + would apply to the whole organization. + operation_groups: + type: array + items: + type: string + example: + - MANAGEMENT + - SCHEMA + - FLINK + description: | + Scope of resources covered by this IP filter. Resource group must be set to 'multiple' + in order to use this property.During update operations, note that the operation + groups passed in will replace the list of existing operation groups + (passing in an empty list will remove all operation groups) from the filter + (in line with the behavior for ip_groups). + ip_groups: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: A list of IP Groups. + minItems: 1 + maxItems: 25 + required: + - api_version + - kind + - id + - filter_name + - resource_group + - ip_groups + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + operationId: deleteIamV2IpFilter + summary: Delete an IP Filter + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an IP filter. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the IP filter. + tags: + - IP Filters (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An IP Filter is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filters API + /iam/v2/ip-filter-summary: + get: + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filter Summary API + operationId: getIamV2IpFilterSummary + summary: Read an IP Filter Summary + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an IP filter summary. + parameters: + - name: scope + in: query + required: true + schema: + type: string + example: crn://confluent.cloud/organization=org-123/environment=env-abc + description: Scope the operation to the given scope. + tags: + - IP Filter Summaries (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: IP Filter Summary. + content: + application/json: + schema: + type: object + description: | + The IP Filter Summary endpoint returns an aggregation of the IP Filters across the system. + This API can be queried in the context of an organization or an environment. It returns a + summary of every operation group in the system grouped with a higher summary by operation + group category. + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilterSummary + scope: + type: string + description: The scope associated with this object. + categories: + type: array + items: + type: object + properties: + name: + type: string + description: Name of the category. + status: + type: string + description: Open, limited, or mixed. + operation_groups: + type: array + description: Operation groups part of this category. + items: + type: object + properties: + name: + type: string + description: Name of the operation group. + status: + type: string + description: Open, limited, or no access. + example: + - name: management + status: MIXED + operation_groups: + - name: MANAGEMENT + status: LIMITED + description: | + Summary of the operation groups and IP filters created in those operation groups. + required: + - api_version + - kind + - categories + - scope + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: false + x-request-access-name: IP Filter Summary API + /iam/v2/role-bindings: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2RoleBindings + summary: List of Role Bindings + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all role bindings. + parameters: + - name: principal + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: User:u-111aaa + description: Filter the results by exact match for principal. + - name: role_name + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: CloudClusterAdmin + description: Filter the results by exact match for role_name. + - name: crn_pattern + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + description: Filter the results by a partial search of crn_pattern. + - name: page_size + in: query + required: false + schema: + type: integer + default: 1000 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Role Bindings (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Role Binding. + content: + application/json: + schema: + type: object + description: |- + A role binding grants a Principal a role on resources that match a pattern. + + The API allows you to perform create, delete, and list operations on role bindings. + + + Related guide: [Role-Based Access Control (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + ## The Role Bindings Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBindingList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + A role binding grants a Principal a role on resources that match a pattern. + + The API allows you to perform create, delete, and list operations on role bindings. + + + Related guide: [Role-Based Access Control (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + ## The Role Bindings Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBinding + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + principal: + type: string + description: The principal User to bind the role to + pattern: (^User:.+$) + example: User:u-111aaa + role_name: + type: string + description: The name of the role to bind to the principal + example: CloudClusterAdmin + crn_pattern: + type: string + description: A CRN that specifies the scope and resource patterns necessary for the role to bind + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + required: + - id + - metadata + - principal + - role_name + - crn_pattern + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2RoleBinding + summary: Create a Role Binding + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a role binding. + tags: + - Role Bindings (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + A role binding grants a Principal a role on resources that match a pattern. + + The API allows you to perform create, delete, and list operations on role bindings. + + + Related guide: [Role-Based Access Control (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + ## The Role Bindings Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBinding + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + principal: + type: string + description: The principal User to bind the role to + pattern: (^User:.+$) + example: User:u-111aaa + role_name: + type: string + description: The name of the role to bind to the principal + example: CloudClusterAdmin + crn_pattern: + type: string + description: A CRN that specifies the scope and resource patterns necessary for the role to bind + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + required: + - principal + - role_name + - crn_pattern + responses: + '201': + description: A Role Binding was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/role-bindings/{id} + description: RoleBinding resource uri + content: + application/json: + schema: + type: object + description: |- + A role binding grants a Principal a role on resources that match a pattern. + + The API allows you to perform create, delete, and list operations on role bindings. + + + Related guide: [Role-Based Access Control (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + ## The Role Bindings Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBinding + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + principal: + type: string + description: The principal User to bind the role to + pattern: (^User:.+$) + example: User:u-111aaa + role_name: + type: string + description: The name of the role to bind to the principal + example: CloudClusterAdmin + crn_pattern: + type: string + description: A CRN that specifies the scope and resource patterns necessary for the role to bind + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + required: + - principal + - role_name + - crn_pattern + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/role-bindings/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2RoleBinding + summary: Read a Role Binding + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a role binding. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the role binding. + tags: + - Role Bindings (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Role Binding. + content: + application/json: + schema: + type: object + description: |- + A role binding grants a Principal a role on resources that match a pattern. + + The API allows you to perform create, delete, and list operations on role bindings. + + + Related guide: [Role-Based Access Control (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + ## The Role Bindings Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBinding + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + principal: + type: string + description: The principal User to bind the role to + pattern: (^User:.+$) + example: User:u-111aaa + role_name: + type: string + description: The name of the role to bind to the principal + example: CloudClusterAdmin + crn_pattern: + type: string + description: A CRN that specifies the scope and resource patterns necessary for the role to bind + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + required: + - api_version + - kind + - id + - principal + - role_name + - crn_pattern + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2RoleBinding + summary: Delete a Role Binding + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a role binding. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the role binding. + tags: + - Role Bindings (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: A Role Binding is being deleted. + content: + application/json: + schema: + type: object + description: |- + A role binding grants a Principal a role on resources that match a pattern. + + The API allows you to perform create, delete, and list operations on role bindings. + + + Related guide: [Role-Based Access Control (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + ## The Role Bindings Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBinding + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + principal: + type: string + description: The principal User to bind the role to + pattern: (^User:.+$) + example: User:u-111aaa + role_name: + type: string + description: The name of the role to bind to the principal + example: CloudClusterAdmin + crn_pattern: + type: string + description: A CRN that specifies the scope and resource patterns necessary for the role to bind + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + required: + - api_version + - kind + - id + - principal + - role_name + - crn_pattern + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/identity-providers: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2IdentityProviders + summary: List of Identity Providers + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all identity providers. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 255 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Identity Providers (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Identity Provider. + content: + application/json: + schema: + type: object + description: |- + `IdentityProvider` objects represent external OAuth-OIDC providers in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Identity Provider. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Identity Providers Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_providers_per_org` | Number of OAuth identity providers per organization | + | `public_keys_per_provider` | Number of public keys saved per identity provider | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProviderList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `IdentityProvider` objects represent external OAuth-OIDC providers in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Identity Provider. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Identity Providers Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_providers_per_org` | Number of OAuth identity providers per organization | + | `public_keys_per_provider` | Number of public keys saved per identity provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProvider + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the OAuth identity provider. + example: My OIDC Provider + description: + type: string + description: A description of the identity provider. + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). This appears + in audit log records. Note: if the client specifies mapping to one identity pool ID, the identity + claim configured with that pool will be used instead. + Note - The attribute is in an [Early Access lifecycle stage] + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: claims.sub + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity provider. + example: ENABLED + readOnly: true + issuer: + type: string + format: uri + description: |- + A publicly accessible URL uniquely identifying the OAuth + identity provider authorized to issue access tokens. + example: https://login.microsoftonline.com/{tenantid}/v2.0 + x-immutable: false + jwks_uri: + type: string + format: uri + description: |- + A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth + identity provider. JWKS provides a set of crypotgraphic keys + used to verify the authenticity and integrity of JSON Web + Tokens (JWTs) issued by the OAuth identity provider. + example: https://login.microsoftonline.com/common/discovery/v2.0/keys + x-immutable: false + keys: + type: array + items: + $ref: '#/components/schemas/iam.v2.JwksObject' + description: |- + The JWKS issued by the OAuth identity provider. Only `kid` (key ID) + and `alg` (algorithm) properties for each key set are included. + readOnly: true + required: + - id + - metadata + - display_name + - description + - state + - issuer + - jwks_uri + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2IdentityProvider + summary: Create an Identity Provider + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an identity provider. + tags: + - Identity Providers (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `IdentityProvider` objects represent external OAuth-OIDC providers in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Identity Provider. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Identity Providers Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_providers_per_org` | Number of OAuth identity providers per organization | + | `public_keys_per_provider` | Number of public keys saved per identity provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProvider + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the OAuth identity provider. + example: My OIDC Provider + description: + type: string + description: A description of the identity provider. + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). This appears + in audit log records. Note: if the client specifies mapping to one identity pool ID, the identity + claim configured with that pool will be used instead. + Note - The attribute is in an [Early Access lifecycle stage] + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: claims.sub + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity provider. + example: ENABLED + readOnly: true + issuer: + type: string + format: uri + description: |- + A publicly accessible URL uniquely identifying the OAuth + identity provider authorized to issue access tokens. + example: https://login.microsoftonline.com/{tenantid}/v2.0 + x-immutable: false + jwks_uri: + type: string + format: uri + description: |- + A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth + identity provider. JWKS provides a set of crypotgraphic keys + used to verify the authenticity and integrity of JSON Web + Tokens (JWTs) issued by the OAuth identity provider. + example: https://login.microsoftonline.com/common/discovery/v2.0/keys + x-immutable: false + keys: + type: array + items: + $ref: '#/components/schemas/iam.v2.JwksObject' + description: |- + The JWKS issued by the OAuth identity provider. Only `kid` (key ID) + and `alg` (algorithm) properties for each key set are included. + readOnly: true + required: + - display_name + - description + - issuer + - jwks_uri + responses: + '201': + description: An Identity Provider was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/identity-providers/{id} + description: IdentityProvider resource uri + content: + application/json: + schema: + type: object + description: |- + `IdentityProvider` objects represent external OAuth-OIDC providers in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Identity Provider. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Identity Providers Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_providers_per_org` | Number of OAuth identity providers per organization | + | `public_keys_per_provider` | Number of public keys saved per identity provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProvider + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the OAuth identity provider. + example: My OIDC Provider + description: + type: string + description: A description of the identity provider. + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). This appears + in audit log records. Note: if the client specifies mapping to one identity pool ID, the identity + claim configured with that pool will be used instead. + Note - The attribute is in an [Early Access lifecycle stage] + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: claims.sub + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity provider. + example: ENABLED + readOnly: true + issuer: + type: string + format: uri + description: |- + A publicly accessible URL uniquely identifying the OAuth + identity provider authorized to issue access tokens. + example: https://login.microsoftonline.com/{tenantid}/v2.0 + x-immutable: false + jwks_uri: + type: string + format: uri + description: |- + A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth + identity provider. JWKS provides a set of crypotgraphic keys + used to verify the authenticity and integrity of JSON Web + Tokens (JWTs) issued by the OAuth identity provider. + example: https://login.microsoftonline.com/common/discovery/v2.0/keys + x-immutable: false + keys: + type: array + items: + $ref: '#/components/schemas/iam.v2.JwksObject' + description: |- + The JWKS issued by the OAuth identity provider. Only `kid` (key ID) + and `alg` (algorithm) properties for each key set are included. + readOnly: true + required: + - display_name + - description + - issuer + - jwks_uri + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/identity-providers/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2IdentityProvider + summary: Read an Identity Provider + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an identity provider. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity provider. + tags: + - Identity Providers (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Identity Provider. + content: + application/json: + schema: + type: object + description: |- + `IdentityProvider` objects represent external OAuth-OIDC providers in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Identity Provider. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Identity Providers Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_providers_per_org` | Number of OAuth identity providers per organization | + | `public_keys_per_provider` | Number of public keys saved per identity provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProvider + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the OAuth identity provider. + example: My OIDC Provider + description: + type: string + description: A description of the identity provider. + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). This appears + in audit log records. Note: if the client specifies mapping to one identity pool ID, the identity + claim configured with that pool will be used instead. + Note - The attribute is in an [Early Access lifecycle stage] + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: claims.sub + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity provider. + example: ENABLED + readOnly: true + issuer: + type: string + format: uri + description: |- + A publicly accessible URL uniquely identifying the OAuth + identity provider authorized to issue access tokens. + example: https://login.microsoftonline.com/{tenantid}/v2.0 + x-immutable: false + jwks_uri: + type: string + format: uri + description: |- + A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth + identity provider. JWKS provides a set of crypotgraphic keys + used to verify the authenticity and integrity of JSON Web + Tokens (JWTs) issued by the OAuth identity provider. + example: https://login.microsoftonline.com/common/discovery/v2.0/keys + x-immutable: false + keys: + type: array + items: + $ref: '#/components/schemas/iam.v2.JwksObject' + description: |- + The JWKS issued by the OAuth identity provider. Only `kid` (key ID) + and `alg` (algorithm) properties for each key set are included. + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - state + - issuer + - jwks_uri + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2IdentityProvider + summary: Update an Identity Provider + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an identity provider. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity provider. + tags: + - Identity Providers (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.IdentityProvider' + responses: + '200': + description: Identity Provider. + content: + application/json: + schema: + type: object + description: |- + `IdentityProvider` objects represent external OAuth-OIDC providers in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Identity Provider. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Identity Providers Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_providers_per_org` | Number of OAuth identity providers per organization | + | `public_keys_per_provider` | Number of public keys saved per identity provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProvider + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the OAuth identity provider. + example: My OIDC Provider + description: + type: string + description: A description of the identity provider. + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). This appears + in audit log records. Note: if the client specifies mapping to one identity pool ID, the identity + claim configured with that pool will be used instead. + Note - The attribute is in an [Early Access lifecycle stage] + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: claims.sub + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity provider. + example: ENABLED + readOnly: true + issuer: + type: string + format: uri + description: |- + A publicly accessible URL uniquely identifying the OAuth + identity provider authorized to issue access tokens. + example: https://login.microsoftonline.com/{tenantid}/v2.0 + x-immutable: false + jwks_uri: + type: string + format: uri + description: |- + A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth + identity provider. JWKS provides a set of crypotgraphic keys + used to verify the authenticity and integrity of JSON Web + Tokens (JWTs) issued by the OAuth identity provider. + example: https://login.microsoftonline.com/common/discovery/v2.0/keys + x-immutable: false + keys: + type: array + items: + $ref: '#/components/schemas/iam.v2.JwksObject' + description: |- + The JWKS issued by the OAuth identity provider. Only `kid` (key ID) + and `alg` (algorithm) properties for each key set are included. + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - state + - issuer + - jwks_uri + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2IdentityProvider + summary: Delete an Identity Provider + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an identity provider. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity provider. + tags: + - Identity Providers (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Identity Provider is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/identity-providers/{provider_id}/jwks: + patch: + summary: Refresh a provider's JWKS + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to refresh the provider's JWKS + + x-lifecycle-stage: General Availability + x-self-access: true + operationId: refreshIamV2JsonWebKeySet + parameters: + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + tags: + - Jwks (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.Jwks' + responses: + '200': + description: Jwks. + content: + application/json: + schema: + type: object + description: |- + `JWKS` objects represent public key sets for a specific OAuth/OpenID Connect provider within + Confluent Cloud. + + The API allows you to refresh JWKS public key data. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Jwks Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Jwks + spec: + $ref: '#/components/schemas/iam.v2.JwksSpec' + status: + $ref: '#/components/schemas/iam.v2.JwksStatus' + required: + - api_version + - kind + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/identity-providers/{provider_id}/identity-pools: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2IdentityPools + summary: List of Identity Pools + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all identity pools. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 255 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + tags: + - Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Identity Pool. + content: + application/json: + schema: + type: object + description: |- + `IdentityPool` objects represent groups of identities tied to a given a `IdentityProvider` + that authorizes them to Confluent Cloud resources. + + It provides a mapping functionality of your `Identity Provider` user to a Confluent identity pool that + is then used to provide access to Confluent Resources. + + + Related guide: [Use identity pools with your OAuth provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + ## The Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_provider` | Number of Identity Pools per Identity Provider | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPoolList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `IdentityPool` objects represent groups of identities tied to a given a `IdentityProvider` + that authorizes them to Confluent Cloud resources. + + It provides a mapping functionality of your `Identity Provider` user to a Confluent identity pool that + is then used to provide access to Confluent Resources. + + + Related guide: [Use identity pools with your OAuth provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + ## The Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_provider` | Number of Identity Pools per Identity Provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + (see [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) for more details). + This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access + topic A". + example: claims.sub + filter: + type: string + description: A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) that specifies which identities can authenticate using your identity pool (see [Set identity pool filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) for more details). + maxLength: 300 + example: claims.aud=="confluent" && claims.group!="invalid_group" + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - identity_claim + - filter + - principal + - state + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2IdentityPool + summary: Create an Identity Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an identity pool. + parameters: + - name: assigned_resource_owner + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: u-a83k9b + description: The resource_id of the principal who will be assigned resource owner on the created identity pool. Principal can be group-mapping (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx). + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + tags: + - Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `IdentityPool` objects represent groups of identities tied to a given a `IdentityProvider` + that authorizes them to Confluent Cloud resources. + + It provides a mapping functionality of your `Identity Provider` user to a Confluent identity pool that + is then used to provide access to Confluent Resources. + + + Related guide: [Use identity pools with your OAuth provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + ## The Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_provider` | Number of Identity Pools per Identity Provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + (see [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) for more details). + This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access + topic A". + example: claims.sub + filter: + type: string + description: A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) that specifies which identities can authenticate using your identity pool (see [Set identity pool filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) for more details). + maxLength: 300 + example: claims.aud=="confluent" && claims.group!="invalid_group" + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - display_name + - description + - identity_claim + - filter + responses: + '201': + description: An Identity Pool was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/identity-providers/{provider_id}/identity-pools/{id} + description: IdentityPool resource uri + content: + application/json: + schema: + type: object + description: |- + `IdentityPool` objects represent groups of identities tied to a given a `IdentityProvider` + that authorizes them to Confluent Cloud resources. + + It provides a mapping functionality of your `Identity Provider` user to a Confluent identity pool that + is then used to provide access to Confluent Resources. + + + Related guide: [Use identity pools with your OAuth provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + ## The Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_provider` | Number of Identity Pools per Identity Provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + (see [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) for more details). + This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access + topic A". + example: claims.sub + filter: + type: string + description: A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) that specifies which identities can authenticate using your identity pool (see [Set identity pool filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) for more details). + maxLength: 300 + example: claims.aud=="confluent" && claims.group!="invalid_group" + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - display_name + - description + - identity_claim + - filter + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/identity-providers/{provider_id}/identity-pools/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2IdentityPool + summary: Read an Identity Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an identity pool. + parameters: + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity pool. + tags: + - Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Identity Pool. + content: + application/json: + schema: + type: object + description: |- + `IdentityPool` objects represent groups of identities tied to a given a `IdentityProvider` + that authorizes them to Confluent Cloud resources. + + It provides a mapping functionality of your `Identity Provider` user to a Confluent identity pool that + is then used to provide access to Confluent Resources. + + + Related guide: [Use identity pools with your OAuth provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + ## The Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_provider` | Number of Identity Pools per Identity Provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + (see [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) for more details). + This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access + topic A". + example: claims.sub + filter: + type: string + description: A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) that specifies which identities can authenticate using your identity pool (see [Set identity pool filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) for more details). + maxLength: 300 + example: claims.aud=="confluent" && claims.group!="invalid_group" + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - identity_claim + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2IdentityPool + summary: Update an Identity Pool + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an identity pool. + + parameters: + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity pool. + tags: + - Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.IdentityPool' + responses: + '200': + description: Identity Pool. + content: + application/json: + schema: + type: object + description: |- + `IdentityPool` objects represent groups of identities tied to a given a `IdentityProvider` + that authorizes them to Confluent Cloud resources. + + It provides a mapping functionality of your `Identity Provider` user to a Confluent identity pool that + is then used to provide access to Confluent Resources. + + + Related guide: [Use identity pools with your OAuth provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + ## The Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_provider` | Number of Identity Pools per Identity Provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + (see [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) for more details). + This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access + topic A". + example: claims.sub + filter: + type: string + description: A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) that specifies which identities can authenticate using your identity pool (see [Set identity pool filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) for more details). + maxLength: 300 + example: claims.aud=="confluent" && claims.group!="invalid_group" + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - identity_claim + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2IdentityPool + summary: Delete an Identity Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an identity pool. + parameters: + - name: provider_id + in: path + required: true + schema: + type: string + description: The Provider + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the identity pool. + tags: + - Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Identity Pool is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/sso/group-mappings: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2SsoGroupMappings + summary: List of Group Mappings + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all group mappings. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 255 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Group Mappings (iam/v2/sso) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Group Mapping. + content: + application/json: + schema: + type: object + description: |- + `GroupMapping` objects establish relationships between user groups in your SSO + identity provider and specific RBAC roles in Confluent Cloud. + + Group mappings enable automated and secure access control to Confluent Cloud resources, + reducing administrative workload by streamlining user provisioning and authorization. + + + Related guide: [Use group mappings with your SSO identity provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + ## The Group Mappings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `group_mappings_per_org` | Number of group mappings per organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMappingList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `GroupMapping` objects establish relationships between user groups in your SSO + identity provider and specific RBAC roles in Confluent Cloud. + + Group mappings enable automated and secure access control to Confluent Cloud resources, + reducing administrative workload by streamlining user provisioning and authorization. + + + Related guide: [Use group mappings with your SSO identity provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + ## The Group Mappings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `group_mappings_per_org` | Number of group mappings per organization | + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMapping + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the group mapping. + example: Application Developers + description: + type: string + description: A description explaining the purpose and use of the group mapping. + example: Admin access to production environment for Engineering + filter: + type: string + description: A single group identifier or a condition based on [supported CEL operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) that defines which groups are included. + maxLength: 300 + example: '"kafka" in groups && "all" in groups || "everyone" in groups' + principal: + type: string + description: The unique federated identity associated with this group mapping. + example: group-a1b2 + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the group mapping. + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - filter + - principal + - state + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2SsoGroupMapping + summary: Create a Group Mapping + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a group mapping. + tags: + - Group Mappings (iam/v2/sso) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `GroupMapping` objects establish relationships between user groups in your SSO + identity provider and specific RBAC roles in Confluent Cloud. + + Group mappings enable automated and secure access control to Confluent Cloud resources, + reducing administrative workload by streamlining user provisioning and authorization. + + + Related guide: [Use group mappings with your SSO identity provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + ## The Group Mappings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `group_mappings_per_org` | Number of group mappings per organization | + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMapping + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the group mapping. + example: Application Developers + description: + type: string + description: A description explaining the purpose and use of the group mapping. + example: Admin access to production environment for Engineering + filter: + type: string + description: A single group identifier or a condition based on [supported CEL operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) that defines which groups are included. + maxLength: 300 + example: '"kafka" in groups && "all" in groups || "everyone" in groups' + principal: + type: string + description: The unique federated identity associated with this group mapping. + example: group-a1b2 + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the group mapping. + example: ENABLED + readOnly: true + required: + - display_name + - description + - filter + responses: + '201': + description: A Group Mapping was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/sso/group-mappings/{id} + description: GroupMapping resource uri + content: + application/json: + schema: + type: object + description: |- + `GroupMapping` objects establish relationships between user groups in your SSO + identity provider and specific RBAC roles in Confluent Cloud. + + Group mappings enable automated and secure access control to Confluent Cloud resources, + reducing administrative workload by streamlining user provisioning and authorization. + + + Related guide: [Use group mappings with your SSO identity provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + ## The Group Mappings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `group_mappings_per_org` | Number of group mappings per organization | + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMapping + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the group mapping. + example: Application Developers + description: + type: string + description: A description explaining the purpose and use of the group mapping. + example: Admin access to production environment for Engineering + filter: + type: string + description: A single group identifier or a condition based on [supported CEL operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) that defines which groups are included. + maxLength: 300 + example: '"kafka" in groups && "all" in groups || "everyone" in groups' + principal: + type: string + description: The unique federated identity associated with this group mapping. + example: group-a1b2 + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the group mapping. + example: ENABLED + readOnly: true + required: + - display_name + - description + - filter + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/sso/group-mappings/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2SsoGroupMapping + summary: Read a Group Mapping + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a group mapping. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the group mapping. + tags: + - Group Mappings (iam/v2/sso) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Group Mapping. + content: + application/json: + schema: + type: object + description: |- + `GroupMapping` objects establish relationships between user groups in your SSO + identity provider and specific RBAC roles in Confluent Cloud. + + Group mappings enable automated and secure access control to Confluent Cloud resources, + reducing administrative workload by streamlining user provisioning and authorization. + + + Related guide: [Use group mappings with your SSO identity provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + ## The Group Mappings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `group_mappings_per_org` | Number of group mappings per organization | + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMapping + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the group mapping. + example: Application Developers + description: + type: string + description: A description explaining the purpose and use of the group mapping. + example: Admin access to production environment for Engineering + filter: + type: string + description: A single group identifier or a condition based on [supported CEL operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) that defines which groups are included. + maxLength: 300 + example: '"kafka" in groups && "all" in groups || "everyone" in groups' + principal: + type: string + description: The unique federated identity associated with this group mapping. + example: group-a1b2 + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the group mapping. + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2SsoGroupMapping + summary: Update a Group Mapping + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a group mapping. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the group mapping. + tags: + - Group Mappings (iam/v2/sso) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.sso.GroupMapping' + responses: + '200': + description: Group Mapping. + content: + application/json: + schema: + type: object + description: |- + `GroupMapping` objects establish relationships between user groups in your SSO + identity provider and specific RBAC roles in Confluent Cloud. + + Group mappings enable automated and secure access control to Confluent Cloud resources, + reducing administrative workload by streamlining user provisioning and authorization. + + + Related guide: [Use group mappings with your SSO identity provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + ## The Group Mappings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `group_mappings_per_org` | Number of group mappings per organization | + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMapping + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the group mapping. + example: Application Developers + description: + type: string + description: A description explaining the purpose and use of the group mapping. + example: Admin access to production environment for Engineering + filter: + type: string + description: A single group identifier or a condition based on [supported CEL operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) that defines which groups are included. + maxLength: 300 + example: '"kafka" in groups && "all" in groups || "everyone" in groups' + principal: + type: string + description: The unique federated identity associated with this group mapping. + example: group-a1b2 + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the group mapping. + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2SsoGroupMapping + summary: Delete a Group Mapping + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a group mapping. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the group mapping. + tags: + - Group Mappings (iam/v2/sso) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Group Mapping is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/certificate-authorities: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2CertificateAuthorities + summary: List of Certificate Authorities + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all certificate authorities. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 255 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Certificate Authorities (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Certificate Authority. + content: + application/json: + schema: + type: object + description: | + `CertificateAuthority` objects represent signing certificate authorities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Certificate Authority. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthorityList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: | + `CertificateAuthority` objects represent signing certificate authorities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Certificate Authority. + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthority + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + fingerprints: + type: array + items: + type: string + description: |- + The fingerprints for each certificate in the certificate chain. These are SHA-1 encoded + strings that act as unique identifiers for the certificates in the chain. + example: + - B1BC968BD4f49D622AA89A81F2150152A41D829C + readOnly: true + expiration_dates: + type: array + items: + type: string + format: date-time + description: The expiration dates of certificates in the chain. + example: + - '2017-07-21T17:32:28.000Z' + readOnly: true + serial_numbers: + type: array + items: + type: string + description: The serial numbers for each certificate in the certificate chain. + example: + - 219C542DE8f6EC7177FA4EE8C3705797 + readOnly: true + certificate_chain_filename: + type: string + description: The file name of the uploaded pem file for this certificate authority. + example: certificate.pem + readOnly: true + crl_source: + type: string + description: |- + The source specifies whether the Certificate Revocation List (CRL) is updated from + either local file uploaded (LOCAL) or from url of CRL (URL). + x-extensible-enum: + - LOCAL + - URL + example: LOCAL + readOnly: true + crl_url: + type: string + format: uri + description: The url from which to fetch the CRL for the certificate authority if crl_source is URL. + readOnly: true + crl_updated_at: + type: string + format: date-time + description: The timestamp for when CRL was last updated. + example: '2017-07-21T17:32:28.000Z' + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the certificate authority. + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - fingerprints + - expiration_dates + - serial_numbers + - certificate_chain_filename + - state + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.CreateCertRequest' + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2CertificateAuthority + summary: Create a Certificate Authority + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a certificate authority. + tags: + - Certificate Authorities (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '201': + description: A Certificate Authority was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/certificate-authorities/{id} + description: CertificateAuthority resource uri + content: + application/json: + schema: + type: object + description: | + `CertificateAuthority` objects represent signing certificate authorities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Certificate Authority. + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthority + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + fingerprints: + type: array + items: + type: string + description: |- + The fingerprints for each certificate in the certificate chain. These are SHA-1 encoded + strings that act as unique identifiers for the certificates in the chain. + example: + - B1BC968BD4f49D622AA89A81F2150152A41D829C + readOnly: true + expiration_dates: + type: array + items: + type: string + format: date-time + description: The expiration dates of certificates in the chain. + example: + - '2017-07-21T17:32:28.000Z' + readOnly: true + serial_numbers: + type: array + items: + type: string + description: The serial numbers for each certificate in the certificate chain. + example: + - 219C542DE8f6EC7177FA4EE8C3705797 + readOnly: true + certificate_chain_filename: + type: string + description: The file name of the uploaded pem file for this certificate authority. + example: certificate.pem + readOnly: true + crl_source: + type: string + description: |- + The source specifies whether the Certificate Revocation List (CRL) is updated from + either local file uploaded (LOCAL) or from url of CRL (URL). + x-extensible-enum: + - LOCAL + - URL + example: LOCAL + readOnly: true + crl_url: + type: string + format: uri + description: The url from which to fetch the CRL for the certificate authority if crl_source is URL. + readOnly: true + crl_updated_at: + type: string + format: date-time + description: The timestamp for when CRL was last updated. + example: '2017-07-21T17:32:28.000Z' + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the certificate authority. + example: ENABLED + readOnly: true + required: + - display_name + - description + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/certificate-authorities/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2CertificateAuthority + summary: Read a Certificate Authority + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a certificate authority. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate authority. + tags: + - Certificate Authorities (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Certificate Authority. + content: + application/json: + schema: + type: object + description: | + `CertificateAuthority` objects represent signing certificate authorities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Certificate Authority. + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthority + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + fingerprints: + type: array + items: + type: string + description: |- + The fingerprints for each certificate in the certificate chain. These are SHA-1 encoded + strings that act as unique identifiers for the certificates in the chain. + example: + - B1BC968BD4f49D622AA89A81F2150152A41D829C + readOnly: true + expiration_dates: + type: array + items: + type: string + format: date-time + description: The expiration dates of certificates in the chain. + example: + - '2017-07-21T17:32:28.000Z' + readOnly: true + serial_numbers: + type: array + items: + type: string + description: The serial numbers for each certificate in the certificate chain. + example: + - 219C542DE8f6EC7177FA4EE8C3705797 + readOnly: true + certificate_chain_filename: + type: string + description: The file name of the uploaded pem file for this certificate authority. + example: certificate.pem + readOnly: true + crl_source: + type: string + description: |- + The source specifies whether the Certificate Revocation List (CRL) is updated from + either local file uploaded (LOCAL) or from url of CRL (URL). + x-extensible-enum: + - LOCAL + - URL + example: LOCAL + readOnly: true + crl_url: + type: string + format: uri + description: The url from which to fetch the CRL for the certificate authority if crl_source is URL. + readOnly: true + crl_updated_at: + type: string + format: date-time + description: The timestamp for when CRL was last updated. + example: '2017-07-21T17:32:28.000Z' + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the certificate authority. + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - fingerprints + - expiration_dates + - serial_numbers + - certificate_chain_filename + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.UpdateCertRequest' + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2CertificateAuthority + summary: Update a Certificate Authority + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a certificate authority. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate authority. + tags: + - Certificate Authorities (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Certificate Authority. + content: + application/json: + schema: + type: object + description: | + `CertificateAuthority` objects represent signing certificate authorities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Certificate Authority. + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthority + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + fingerprints: + type: array + items: + type: string + description: |- + The fingerprints for each certificate in the certificate chain. These are SHA-1 encoded + strings that act as unique identifiers for the certificates in the chain. + example: + - B1BC968BD4f49D622AA89A81F2150152A41D829C + readOnly: true + expiration_dates: + type: array + items: + type: string + format: date-time + description: The expiration dates of certificates in the chain. + example: + - '2017-07-21T17:32:28.000Z' + readOnly: true + serial_numbers: + type: array + items: + type: string + description: The serial numbers for each certificate in the certificate chain. + example: + - 219C542DE8f6EC7177FA4EE8C3705797 + readOnly: true + certificate_chain_filename: + type: string + description: The file name of the uploaded pem file for this certificate authority. + example: certificate.pem + readOnly: true + crl_source: + type: string + description: |- + The source specifies whether the Certificate Revocation List (CRL) is updated from + either local file uploaded (LOCAL) or from url of CRL (URL). + x-extensible-enum: + - LOCAL + - URL + example: LOCAL + readOnly: true + crl_url: + type: string + format: uri + description: The url from which to fetch the CRL for the certificate authority if crl_source is URL. + readOnly: true + crl_updated_at: + type: string + format: date-time + description: The timestamp for when CRL was last updated. + example: '2017-07-21T17:32:28.000Z' + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the certificate authority. + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - fingerprints + - expiration_dates + - serial_numbers + - certificate_chain_filename + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2CertificateAuthority + summary: Delete a Certificate Authority + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a certificate authority. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate authority. + tags: + - Certificate Authorities (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: A Certificate Authority is being deleted. + content: + application/json: + schema: + type: object + description: | + `CertificateAuthority` objects represent signing certificate authorities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Certificate Authority. + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthority + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + fingerprints: + type: array + items: + type: string + description: |- + The fingerprints for each certificate in the certificate chain. These are SHA-1 encoded + strings that act as unique identifiers for the certificates in the chain. + example: + - B1BC968BD4f49D622AA89A81F2150152A41D829C + readOnly: true + expiration_dates: + type: array + items: + type: string + format: date-time + description: The expiration dates of certificates in the chain. + example: + - '2017-07-21T17:32:28.000Z' + readOnly: true + serial_numbers: + type: array + items: + type: string + description: The serial numbers for each certificate in the certificate chain. + example: + - 219C542DE8f6EC7177FA4EE8C3705797 + readOnly: true + certificate_chain_filename: + type: string + description: The file name of the uploaded pem file for this certificate authority. + example: certificate.pem + readOnly: true + crl_source: + type: string + description: |- + The source specifies whether the Certificate Revocation List (CRL) is updated from + either local file uploaded (LOCAL) or from url of CRL (URL). + x-extensible-enum: + - LOCAL + - URL + example: LOCAL + readOnly: true + crl_url: + type: string + format: uri + description: The url from which to fetch the CRL for the certificate authority if crl_source is URL. + readOnly: true + crl_updated_at: + type: string + format: date-time + description: The timestamp for when CRL was last updated. + example: '2017-07-21T17:32:28.000Z' + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the certificate authority. + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - fingerprints + - expiration_dates + - serial_numbers + - certificate_chain_filename + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listIamV2CertificateIdentityPools + summary: List of Certificate Identity Pools + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all certificate identity pools. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 255 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + - name: certificate_authority_id + in: path + required: true + schema: + type: string + description: The Certificate Authority + tags: + - Certificate Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Certificate Identity Pool. + content: + application/json: + schema: + type: object + description: |- + `Identitypool` objects represent workload identities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your identity pools associated + with Certificate Authorities + + + Related guide: [Manage Certificate Identity Pools for Granular Client Access Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + ## The Certificate Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_certificate_authority` | Number of Identity Pools per Certificate Authority | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPoolList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Identitypool` objects represent workload identities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your identity pools associated + with Certificate Authorities + + + Related guide: [Manage Certificate Identity Pools for Granular Client Access Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + ## The Certificate Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_certificate_authority` | Number of Identity Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) that specifies which identities can authenticate using your certificate identity pool (see [CEL filter for mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - external_identifier + - filter + - principal + - state + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createIamV2CertificateIdentityPool + summary: Create a Certificate Identity Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a certificate identity pool. + parameters: + - name: assigned_resource_owner + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: u-a83k9b + description: The resource_id of the principal who will be assigned resource owner on the created certificate identity pool. Principal can be group-mapping (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx). + - name: certificate_authority_id + in: path + required: true + schema: + type: string + description: The Certificate Authority + tags: + - Certificate Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Identitypool` objects represent workload identities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your identity pools associated + with Certificate Authorities + + + Related guide: [Manage Certificate Identity Pools for Granular Client Access Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + ## The Certificate Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_certificate_authority` | Number of Identity Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) that specifies which identities can authenticate using your certificate identity pool (see [CEL filter for mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - display_name + - description + - external_identifier + - filter + responses: + '201': + description: A Certificate Identity Pool was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id} + description: CertificateIdentityPool resource uri + content: + application/json: + schema: + type: object + description: |- + `Identitypool` objects represent workload identities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your identity pools associated + with Certificate Authorities + + + Related guide: [Manage Certificate Identity Pools for Granular Client Access Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + ## The Certificate Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_certificate_authority` | Number of Identity Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) that specifies which identities can authenticate using your certificate identity pool (see [CEL filter for mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - display_name + - description + - external_identifier + - filter + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getIamV2CertificateIdentityPool + summary: Read a Certificate Identity Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a certificate identity pool. + parameters: + - name: certificate_authority_id + in: path + required: true + schema: + type: string + description: The Certificate Authority + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate identity pool. + tags: + - Certificate Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Certificate Identity Pool. + content: + application/json: + schema: + type: object + description: |- + `Identitypool` objects represent workload identities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your identity pools associated + with Certificate Authorities + + + Related guide: [Manage Certificate Identity Pools for Granular Client Access Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + ## The Certificate Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_certificate_authority` | Number of Identity Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) that specifies which identities can authenticate using your certificate identity pool (see [CEL filter for mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - external_identifier + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateIamV2CertificateIdentityPool + summary: Update a Certificate Identity Pool + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a certificate identity pool. + + parameters: + - name: certificate_authority_id + in: path + required: true + schema: + type: string + description: The Certificate Authority + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate identity pool. + tags: + - Certificate Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iam.v2.CertificateIdentityPool' + responses: + '200': + description: Certificate Identity Pool. + content: + application/json: + schema: + type: object + description: |- + `Identitypool` objects represent workload identities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your identity pools associated + with Certificate Authorities + + + Related guide: [Manage Certificate Identity Pools for Granular Client Access Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + ## The Certificate Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_certificate_authority` | Number of Identity Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) that specifies which identities can authenticate using your certificate identity pool (see [CEL filter for mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - external_identifier + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteIamV2CertificateIdentityPool + summary: Delete a Certificate Identity Pool + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a certificate identity pool. + parameters: + - name: certificate_authority_id + in: path + required: true + schema: + type: string + description: The Certificate Authority + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the certificate identity pool. + tags: + - Certificate Identity Pools (iam/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: A Certificate Identity Pool is being deleted. + content: + application/json: + schema: + type: object + description: |- + `Identitypool` objects represent workload identities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your identity pools associated + with Certificate Authorities + + + Related guide: [Manage Certificate Identity Pools for Granular Client Access Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + ## The Certificate Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_certificate_authority` | Number of Identity Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) that specifies which identities can authenticate using your certificate identity pool (see [CEL filter for mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - api_version + - kind + - id + - display_name + - description + - external_identifier + - filter + - principal + - state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + iam.v2.ApiKeyList: + type: object + description: |- + `ApiKey` objects represent access to different parts of Confluent Cloud. Some types + of API keys represent access to a single cluster/resource such as a Kafka cluster, + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization + that are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API. + Tableflow API keys are not tied to a specific cluster. + + The API allows you to list, create, update and delete your API Keys. + + + Related guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + ## The API Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `apikeys_per_org` | API Keys in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKeyList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ApiKey` objects represent access to different parts of Confluent Cloud. Some types + of API keys represent access to a single cluster/resource such as a Kafka cluster, + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization + that are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API. + Tableflow API keys are not tied to a specific cluster. + + The API allows you to list, create, update and delete your API Keys. + + + Related guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + ## The API Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `apikeys_per_org` | API Keys in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKey + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/iam.v2.ApiKeySpec' + required: + - id + - metadata + - spec + uniqueItems: true + iam.v2.ApiKey: + type: object + description: |- + `ApiKey` objects represent access to different parts of Confluent Cloud. Some types + of API keys represent access to a single cluster/resource such as a Kafka cluster, + Schema Registry cluster or a ksqlDB cluster. Cloud API Keys represent access to resources within an organization + that are not tied to a specific cluster, such as the Org API, IAM API, Metrics API or Connect API. + Tableflow API keys are not tied to a specific cluster. + + The API allows you to list, create, update and delete your API Keys. + + + Related guide: [API Keys in Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/api-keys.html). + + ## The API Keys Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `apikeys_per_org` | API Keys in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ApiKey + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/iam.v2.ApiKeySpec' + iam.v2.UserList: + type: object + description: |- + `User` objects represent individuals who may access your Confluent resources. + + The API allows you to retrieve, update, and delete individual users, as well as list of all your + users. This API cannot be used to create new user accounts. + + + Related guide: [Users in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + ## The Users Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `users_per_org` | Users in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - UserList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `User` objects represent individuals who may access your Confluent resources. + + The API allows you to retrieve, update, and delete individual users, as well as list of all your + users. This API cannot be used to create new user accounts. + + + Related guide: [Users in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + ## The Users Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `users_per_org` | Users in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - User + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: marty.mcfly@example.com + description: The user's email address + x-immutable: true + full_name: + example: Marty McFly + type: string + description: The user's full name + auth_type: + type: string + description: The user's authentication method + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + readOnly: true + required: + - id + - metadata + - email + uniqueItems: true + iam.v2.User: + type: object + description: |- + `User` objects represent individuals who may access your Confluent resources. + + The API allows you to retrieve, update, and delete individual users, as well as list of all your + users. This API cannot be used to create new user accounts. + + + Related guide: [Users in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/user-account.html). + + ## The Users Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `users_per_org` | Users in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - User + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: marty.mcfly@example.com + description: The user's email address + x-immutable: true + full_name: + example: Marty McFly + type: string + description: The user's full name + auth_type: + type: string + description: The user's authentication method + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + readOnly: true + iam.v2.User.ConfigureUserAuthRequest: + type: object + description: Configure user auth type + properties: + api_version: + type: string + enum: + - iam.v2/User + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConfigureUserAuthRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + auth_type: + type: string + description: The user's authentication method. + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + MultipleSearchFilter: + description: Filter a collection by a string search for one or more values + type: array + items: + type: string + iam.v2.ServiceAccountList: + type: object + description: |- + `ServiceAccount` objects are typically used to represent applications and other non-human principals + that may access your Confluent resources. + + The API allows you to create, retrieve, update, and delete individual service accounts, as well as + list all your service accounts. + + + Related guide: [Service Accounts in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + ## The Service Accounts Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `service_accounts_per_org` | Service Accounts in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccountList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ServiceAccount` objects are typically used to represent applications and other non-human principals + that may access your Confluent resources. + + The API allows you to create, retrieve, update, and delete individual service accounts, as well as + list all your service accounts. + + + Related guide: [Service Accounts in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + ## The Service Accounts Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `service_accounts_per_org` | Service Accounts in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccount + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: DeLorean_auto_repair + description: A human-readable name for the Service Account + description: + type: string + example: Doc's repair bot for the DeLorean + description: A free-form description of the Service Account + required: + - id + - metadata + - display_name + uniqueItems: true + iam.v2.ServiceAccount: + type: object + description: |- + `ServiceAccount` objects are typically used to represent applications and other non-human principals + that may access your Confluent resources. + + The API allows you to create, retrieve, update, and delete individual service accounts, as well as + list all your service accounts. + + + Related guide: [Service Accounts in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/service-account.html). + + ## The Service Accounts Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `service_accounts_per_org` | Service Accounts in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ServiceAccount + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: DeLorean_auto_repair + description: A human-readable name for the Service Account + description: + type: string + example: Doc's repair bot for the DeLorean + description: A free-form description of the Service Account + iam.v2.InvitationList: + type: object + description: |- + `Invitation` objects represent invitations to invite users to join your organizations in Confluent Cloud. + + The API allows you to list all your invitations, as well as create, read, and delete a specified invitation. + + + Related guide: [User invitations in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + ## The Invitations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `invitations_per_org` | Invitations in a Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - InvitationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Invitation` objects represent invitations to invite users to join your organizations in Confluent Cloud. + + The API allows you to list all your invitations, as well as create, read, and delete a specified invitation. + + + Related guide: [User invitations in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + ## The Invitations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `invitations_per_org` | Invitations in a Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Invitation + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: johndoe@confluent.io + description: The user/invitee's email address + x-immutable: true + auth_type: + type: string + description: | + The user/invitee's authentication type. Note that only the [OrganizationAdmin role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) + can invite AUTH_TYPE_LOCAL users to SSO organizations. + The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. + Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default. + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + status: + type: string + example: INVITE_STATUS_SENT + description: The status of invitations + x-extensible-enum: + - INVITE_STATUS_SENT + - INVITE_STATUS_STAGED + - INVITE_STATUS_ACCEPTED + - INVITE_STATUS_EXPIRED + - INVITE_STATUS_DEACTIVATED + readOnly: true + accepted_at: + type: string + format: date-time + example: '2022-07-06T17:21:33.000Z' + description: The timestamp that the invitation was accepted + nullable: true + readOnly: true + expires_at: + type: string + format: date-time + example: '2022-07-07T17:22:39.000Z' + description: The timestamp that the invitation will expire + readOnly: true + user: + description: The user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + creator: + description: The invitation creator + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - email + uniqueItems: true + iam.v2.Invitation: + type: object + description: |- + `Invitation` objects represent invitations to invite users to join your organizations in Confluent Cloud. + + The API allows you to list all your invitations, as well as create, read, and delete a specified invitation. + + + Related guide: [User invitations in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html). + + ## The Invitations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `invitations_per_org` | Invitations in a Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Invitation + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + email: + type: string + format: email + example: johndoe@confluent.io + description: The user/invitee's email address + x-immutable: true + auth_type: + type: string + description: | + The user/invitee's authentication type. Note that only the [OrganizationAdmin role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) + can invite AUTH_TYPE_LOCAL users to SSO organizations. + The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. + Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default. + example: AUTH_TYPE_SSO + x-extensible-enum: + - AUTH_TYPE_LOCAL + - AUTH_TYPE_SSO + status: + type: string + example: INVITE_STATUS_SENT + description: The status of invitations + x-extensible-enum: + - INVITE_STATUS_SENT + - INVITE_STATUS_STAGED + - INVITE_STATUS_ACCEPTED + - INVITE_STATUS_EXPIRED + - INVITE_STATUS_DEACTIVATED + readOnly: true + accepted_at: + type: string + format: date-time + example: '2022-07-06T17:21:33.000Z' + description: The timestamp that the invitation was accepted + nullable: true + readOnly: true + expires_at: + type: string + format: date-time + example: '2022-07-07T17:22:39.000Z' + description: The timestamp that the invitation will expire + readOnly: true + user: + description: The user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + creator: + description: The invitation creator + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + iam.v2.IpGroupList: + type: object + description: |- + Definitions of networks which can be named and referred by IP blocks, commonly used to attach to IP Filter rules. + + + ## The IP Groups Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroupList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + Definitions of networks which can be named and referred by IP blocks, commonly used to attach to IP Filter rules. + + + ## The IP Groups Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroup + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + group_name: + type: string + minLength: 1 + maxLength: 64 + example: CorpNet + description: | + A human readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or + any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + cidr_blocks: + type: array + items: + type: string + minItems: 1 + maxItems: 25 + example: + - 192.168.0.0/24 + - 192.168.7.0/24 + description: A list of CIDRs. + required: + - id + - metadata + - group_name + - cidr_blocks + uniqueItems: true + iam.v2.IpGroup: + type: object + description: |- + Definitions of networks which can be named and referred by IP blocks, commonly used to attach to IP Filter rules. + + + ## The IP Groups Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpGroup + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + group_name: + type: string + minLength: 1 + maxLength: 64 + example: CorpNet + description: | + A human readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or + any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + cidr_blocks: + type: array + items: + type: string + minItems: 1 + maxItems: 25 + example: + - 192.168.0.0/24 + - 192.168.7.0/24 + description: A list of CIDRs. + iam.v2.IpFilterList: + type: object + description: |- + `IP Filter` objects are bindings between IP Groups and Confluent resource(s). + For example, a binding between "CorpNet" and "Management APIs" will enforce that + access must come from one of the CIDR blocks associated with CorpNet. + If there are multiple IP filters bound to a resource, a request matching any of the CIDR blocks + for any of the IP Group will allow the request. + If there are no IP Filters for a resource, then access will be granted to requests originating + from any IP Address. + + + ## The IP Filters Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `IP Filter` objects are bindings between IP Groups and Confluent resource(s). + For example, a binding between "CorpNet" and "Management APIs" will enforce that + access must come from one of the CIDR blocks associated with CorpNet. + If there are multiple IP filters bound to a resource, a request matching any of the CIDR blocks + for any of the IP Group will allow the request. + If there are no IP Filters for a resource, then access will be granted to requests originating + from any IP Address. + + + ## The IP Filters Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilter + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + filter_name: + type: string + minLength: 1 + maxLength: 64 + example: Management API Rules + description: | + A human readable name for an IP Filter. Can contain any unicode letter or number, the ASCII space character, + or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + resource_group: + type: string + example: management + description: | + Scope of resources covered by this IP filter. Available resource groups include "management" and "multiple". + resource_scope: + type: string + example: crn://confluent.cloud/organization=org-123/environment=env-abc + format: uri + pattern: ^crn://.+$ + description: | + A CRN that specifies the scope of the ip filter, specifically the organization + or environment. Without specifying this property, the ip filter + would apply to the whole organization. + operation_groups: + type: array + items: + type: string + example: + - MANAGEMENT + - SCHEMA + - FLINK + description: | + Scope of resources covered by this IP filter. Resource group must be set to 'multiple' + in order to use this property.During update operations, note that the operation + groups passed in will replace the list of existing operation groups + (passing in an empty list will remove all operation groups) from the filter + (in line with the behavior for ip_groups). + ip_groups: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: A list of IP Groups. + minItems: 1 + maxItems: 25 + required: + - id + - metadata + - filter_name + - resource_group + - ip_groups + uniqueItems: true + iam.v2.IpFilter: + type: object + description: |- + `IP Filter` objects are bindings between IP Groups and Confluent resource(s). + For example, a binding between "CorpNet" and "Management APIs" will enforce that + access must come from one of the CIDR blocks associated with CorpNet. + If there are multiple IP filters bound to a resource, a request matching any of the CIDR blocks + for any of the IP Group will allow the request. + If there are no IP Filters for a resource, then access will be granted to requests originating + from any IP Address. + + + ## The IP Filters Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilter + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + filter_name: + type: string + minLength: 1 + maxLength: 64 + example: Management API Rules + description: | + A human readable name for an IP Filter. Can contain any unicode letter or number, the ASCII space character, + or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. + resource_group: + type: string + example: management + description: | + Scope of resources covered by this IP filter. Available resource groups include "management" and "multiple". + resource_scope: + type: string + example: crn://confluent.cloud/organization=org-123/environment=env-abc + format: uri + pattern: ^crn://.+$ + description: | + A CRN that specifies the scope of the ip filter, specifically the organization + or environment. Without specifying this property, the ip filter + would apply to the whole organization. + operation_groups: + type: array + items: + type: string + example: + - MANAGEMENT + - SCHEMA + - FLINK + description: | + Scope of resources covered by this IP filter. Resource group must be set to 'multiple' + in order to use this property.During update operations, note that the operation + groups passed in will replace the list of existing operation groups + (passing in an empty list will remove all operation groups) from the filter + (in line with the behavior for ip_groups). + ip_groups: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: A list of IP Groups. + minItems: 1 + maxItems: 25 + iam.v2.IpFilterSummary: + type: object + description: | + The IP Filter Summary endpoint returns an aggregation of the IP Filters across the system. + This API can be queried in the context of an organization or an environment. It returns a + summary of every operation group in the system grouped with a higher summary by operation + group category. + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpFilterSummary + scope: + type: string + description: The scope associated with this object. + categories: + type: array + items: + type: object + properties: + name: + type: string + description: Name of the category. + status: + type: string + description: Open, limited, or mixed. + operation_groups: + type: array + description: Operation groups part of this category. + items: + type: object + properties: + name: + type: string + description: Name of the operation group. + status: + type: string + description: Open, limited, or no access. + example: + - name: management + status: MIXED + operation_groups: + - name: MANAGEMENT + status: LIMITED + description: | + Summary of the operation groups and IP filters created in those operation groups. + iam.v2.RoleBindingList: + type: object + description: |- + A role binding grants a Principal a role on resources that match a pattern. + + The API allows you to perform create, delete, and list operations on role bindings. + + + Related guide: [Role-Based Access Control (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + ## The Role Bindings Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBindingList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + A role binding grants a Principal a role on resources that match a pattern. + + The API allows you to perform create, delete, and list operations on role bindings. + + + Related guide: [Role-Based Access Control (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + ## The Role Bindings Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBinding + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + principal: + type: string + description: The principal User to bind the role to + pattern: (^User:.+$) + example: User:u-111aaa + role_name: + type: string + description: The name of the role to bind to the principal + example: CloudClusterAdmin + crn_pattern: + type: string + description: A CRN that specifies the scope and resource patterns necessary for the role to bind + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + required: + - id + - metadata + - principal + - role_name + - crn_pattern + uniqueItems: true + iam.v2.RoleBinding: + type: object + description: |- + A role binding grants a Principal a role on resources that match a pattern. + + The API allows you to perform create, delete, and list operations on role bindings. + + + Related guide: [Role-Based Access Control (RBAC)](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html). + + ## The Role Bindings Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RoleBinding + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + principal: + type: string + description: The principal User to bind the role to + pattern: (^User:.+$) + example: User:u-111aaa + role_name: + type: string + description: The name of the role to bind to the principal + example: CloudClusterAdmin + crn_pattern: + type: string + description: A CRN that specifies the scope and resource patterns necessary for the role to bind + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa + iam.v2.IdentityProviderList: + type: object + description: |- + `IdentityProvider` objects represent external OAuth-OIDC providers in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Identity Provider. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Identity Providers Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_providers_per_org` | Number of OAuth identity providers per organization | + | `public_keys_per_provider` | Number of public keys saved per identity provider | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProviderList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `IdentityProvider` objects represent external OAuth-OIDC providers in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Identity Provider. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Identity Providers Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_providers_per_org` | Number of OAuth identity providers per organization | + | `public_keys_per_provider` | Number of public keys saved per identity provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProvider + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the OAuth identity provider. + example: My OIDC Provider + description: + type: string + description: A description of the identity provider. + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). This appears + in audit log records. Note: if the client specifies mapping to one identity pool ID, the identity + claim configured with that pool will be used instead. + Note - The attribute is in an [Early Access lifecycle stage] + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: claims.sub + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity provider. + example: ENABLED + readOnly: true + issuer: + type: string + format: uri + description: |- + A publicly accessible URL uniquely identifying the OAuth + identity provider authorized to issue access tokens. + example: https://login.microsoftonline.com/{tenantid}/v2.0 + x-immutable: false + jwks_uri: + type: string + format: uri + description: |- + A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth + identity provider. JWKS provides a set of crypotgraphic keys + used to verify the authenticity and integrity of JSON Web + Tokens (JWTs) issued by the OAuth identity provider. + example: https://login.microsoftonline.com/common/discovery/v2.0/keys + x-immutable: false + keys: + type: array + items: + $ref: '#/components/schemas/iam.v2.JwksObject' + description: |- + The JWKS issued by the OAuth identity provider. Only `kid` (key ID) + and `alg` (algorithm) properties for each key set are included. + readOnly: true + required: + - id + - metadata + - display_name + - description + - state + - issuer + - jwks_uri + uniqueItems: true + iam.v2.IdentityProvider: + type: object + description: |- + `IdentityProvider` objects represent external OAuth-OIDC providers in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Identity Provider. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Identity Providers Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_providers_per_org` | Number of OAuth identity providers per organization | + | `public_keys_per_provider` | Number of public keys saved per identity provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityProvider + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the OAuth identity provider. + example: My OIDC Provider + description: + type: string + description: A description of the identity provider. + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). This appears + in audit log records. Note: if the client specifies mapping to one identity pool ID, the identity + claim configured with that pool will be used instead. + Note - The attribute is in an [Early Access lifecycle stage] + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: claims.sub + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity provider. + example: ENABLED + readOnly: true + issuer: + type: string + format: uri + description: |- + A publicly accessible URL uniquely identifying the OAuth + identity provider authorized to issue access tokens. + example: https://login.microsoftonline.com/{tenantid}/v2.0 + x-immutable: false + jwks_uri: + type: string + format: uri + description: |- + A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth + identity provider. JWKS provides a set of crypotgraphic keys + used to verify the authenticity and integrity of JSON Web + Tokens (JWTs) issued by the OAuth identity provider. + example: https://login.microsoftonline.com/common/discovery/v2.0/keys + x-immutable: false + keys: + type: array + items: + $ref: '#/components/schemas/iam.v2.JwksObject' + description: |- + The JWKS issued by the OAuth identity provider. Only `kid` (key ID) + and `alg` (algorithm) properties for each key set are included. + readOnly: true + iam.v2.Jwks: + type: object + description: |- + `JWKS` objects represent public key sets for a specific OAuth/OpenID Connect provider within + Confluent Cloud. + + The API allows you to refresh JWKS public key data. + + + Related guide: [OAuth for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/overview.html). + + ## The Jwks Model + + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Jwks + spec: + $ref: '#/components/schemas/iam.v2.JwksSpec' + status: + $ref: '#/components/schemas/iam.v2.JwksStatus' + iam.v2.IdentityPoolList: + type: object + description: |- + `IdentityPool` objects represent groups of identities tied to a given a `IdentityProvider` + that authorizes them to Confluent Cloud resources. + + It provides a mapping functionality of your `Identity Provider` user to a Confluent identity pool that + is then used to provide access to Confluent Resources. + + + Related guide: [Use identity pools with your OAuth provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + ## The Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_provider` | Number of Identity Pools per Identity Provider | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPoolList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `IdentityPool` objects represent groups of identities tied to a given a `IdentityProvider` + that authorizes them to Confluent Cloud resources. + + It provides a mapping functionality of your `Identity Provider` user to a Confluent identity pool that + is then used to provide access to Confluent Resources. + + + Related guide: [Use identity pools with your OAuth provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + ## The Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_provider` | Number of Identity Pools per Identity Provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + (see [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) for more details). + This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access + topic A". + example: claims.sub + filter: + type: string + description: A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) that specifies which identities can authenticate using your identity pool (see [Set identity pool filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) for more details). + maxLength: 300 + example: claims.aud=="confluent" && claims.group!="invalid_group" + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - identity_claim + - filter + - principal + - state + uniqueItems: true + iam.v2.IdentityPool: + type: object + description: |- + `IdentityPool` objects represent groups of identities tied to a given a `IdentityProvider` + that authorizes them to Confluent Cloud resources. + + It provides a mapping functionality of your `Identity Provider` user to a Confluent identity pool that + is then used to provide access to Confluent Resources. + + + Related guide: [Use identity pools with your OAuth provider](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html). + + ## The Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_provider` | Number of Identity Pools per Identity Provider | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + identity_claim: + type: string + description: |- + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + (see [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) for more details). + This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access + topic A". + example: claims.sub + filter: + type: string + description: A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) that specifies which identities can authenticate using your identity pool (see [Set identity pool filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) for more details). + maxLength: 300 + example: claims.aud=="confluent" && claims.group!="invalid_group" + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + iam.v2.sso.GroupMappingList: + type: object + description: |- + `GroupMapping` objects establish relationships between user groups in your SSO + identity provider and specific RBAC roles in Confluent Cloud. + + Group mappings enable automated and secure access control to Confluent Cloud resources, + reducing administrative workload by streamlining user provisioning and authorization. + + + Related guide: [Use group mappings with your SSO identity provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + ## The Group Mappings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `group_mappings_per_org` | Number of group mappings per organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMappingList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `GroupMapping` objects establish relationships between user groups in your SSO + identity provider and specific RBAC roles in Confluent Cloud. + + Group mappings enable automated and secure access control to Confluent Cloud resources, + reducing administrative workload by streamlining user provisioning and authorization. + + + Related guide: [Use group mappings with your SSO identity provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + ## The Group Mappings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `group_mappings_per_org` | Number of group mappings per organization | + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMapping + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the group mapping. + example: Application Developers + description: + type: string + description: A description explaining the purpose and use of the group mapping. + example: Admin access to production environment for Engineering + filter: + type: string + description: A single group identifier or a condition based on [supported CEL operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) that defines which groups are included. + maxLength: 300 + example: '"kafka" in groups && "all" in groups || "everyone" in groups' + principal: + type: string + description: The unique federated identity associated with this group mapping. + example: group-a1b2 + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the group mapping. + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - filter + - principal + - state + uniqueItems: true + iam.v2.sso.GroupMapping: + type: object + description: |- + `GroupMapping` objects establish relationships between user groups in your SSO + identity provider and specific RBAC roles in Confluent Cloud. + + Group mappings enable automated and secure access control to Confluent Cloud resources, + reducing administrative workload by streamlining user provisioning and authorization. + + + Related guide: [Use group mappings with your SSO identity provider](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html). + + ## The Group Mappings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `group_mappings_per_org` | Number of group mappings per organization | + properties: + api_version: + type: string + enum: + - iam.v2/sso + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GroupMapping + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the group mapping. + example: Application Developers + description: + type: string + description: A description explaining the purpose and use of the group mapping. + example: Admin access to production environment for Engineering + filter: + type: string + description: A single group identifier or a condition based on [supported CEL operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) that defines which groups are included. + maxLength: 300 + example: '"kafka" in groups && "all" in groups || "everyone" in groups' + principal: + type: string + description: The unique federated identity associated with this group mapping. + example: group-a1b2 + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the group mapping. + example: ENABLED + readOnly: true + iam.v2.CertificateAuthorityList: + type: object + description: | + `CertificateAuthority` objects represent signing certificate authorities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Certificate Authority. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthorityList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: | + `CertificateAuthority` objects represent signing certificate authorities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Certificate Authority. + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthority + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + fingerprints: + type: array + items: + type: string + description: |- + The fingerprints for each certificate in the certificate chain. These are SHA-1 encoded + strings that act as unique identifiers for the certificates in the chain. + example: + - B1BC968BD4f49D622AA89A81F2150152A41D829C + readOnly: true + expiration_dates: + type: array + items: + type: string + format: date-time + description: The expiration dates of certificates in the chain. + example: + - '2017-07-21T17:32:28.000Z' + readOnly: true + serial_numbers: + type: array + items: + type: string + description: The serial numbers for each certificate in the certificate chain. + example: + - 219C542DE8f6EC7177FA4EE8C3705797 + readOnly: true + certificate_chain_filename: + type: string + description: The file name of the uploaded pem file for this certificate authority. + example: certificate.pem + readOnly: true + crl_source: + type: string + description: |- + The source specifies whether the Certificate Revocation List (CRL) is updated from + either local file uploaded (LOCAL) or from url of CRL (URL). + x-extensible-enum: + - LOCAL + - URL + example: LOCAL + readOnly: true + crl_url: + type: string + format: uri + description: The url from which to fetch the CRL for the certificate authority if crl_source is URL. + readOnly: true + crl_updated_at: + type: string + format: date-time + description: The timestamp for when CRL was last updated. + example: '2017-07-21T17:32:28.000Z' + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the certificate authority. + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - fingerprints + - expiration_dates + - serial_numbers + - certificate_chain_filename + - state + uniqueItems: true + iam.v2.CreateCertRequest: + type: object + description: This contains the json schema used to create a Certificate Authority + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CreateCertRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + certificate_chain: + type: string + description: |- + The PEM encoded string containing the signing certificate chain + used to validate client certs. + example: |- + -----BEGIN CERTIFICATE----- + MIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx + GTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds + b2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV + BAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD + VQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa + DuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc + THAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb + Kk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP + c1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX + gzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV + HRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF + AAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj + Y1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG + j/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH + hm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC + X4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A== + -----END CERTIFICATE----- + certificate_chain_filename: + type: string + description: The name of the certificate file. + example: certificate.pem + crl_url: + type: string + format: uri + description: The url from which to fetch the CRL for the certificate authority if crl_source is URL. + crl_chain: + type: string + description: |- + The PEM encoded string containing the CRL for this certificate authority. + Defaults to this over `crl_url` if available. + example: |- + -----BEGIN X509 CRL----- + MIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD + VQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1 + ZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0 + eS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt + MS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl + AhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U + BAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX + CKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4 + xqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl + gIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE + jatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6 + cGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg= + -----END X509 CRL----- + iam.v2.CertificateAuthority: + type: object + description: | + `CertificateAuthority` objects represent signing certificate authorities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Certificate Authority. + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateAuthority + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + fingerprints: + type: array + items: + type: string + description: |- + The fingerprints for each certificate in the certificate chain. These are SHA-1 encoded + strings that act as unique identifiers for the certificates in the chain. + example: + - B1BC968BD4f49D622AA89A81F2150152A41D829C + readOnly: true + expiration_dates: + type: array + items: + type: string + format: date-time + description: The expiration dates of certificates in the chain. + example: + - '2017-07-21T17:32:28.000Z' + readOnly: true + serial_numbers: + type: array + items: + type: string + description: The serial numbers for each certificate in the certificate chain. + example: + - 219C542DE8f6EC7177FA4EE8C3705797 + readOnly: true + certificate_chain_filename: + type: string + description: The file name of the uploaded pem file for this certificate authority. + example: certificate.pem + readOnly: true + crl_source: + type: string + description: |- + The source specifies whether the Certificate Revocation List (CRL) is updated from + either local file uploaded (LOCAL) or from url of CRL (URL). + x-extensible-enum: + - LOCAL + - URL + example: LOCAL + readOnly: true + crl_url: + type: string + format: uri + description: The url from which to fetch the CRL for the certificate authority if crl_source is URL. + readOnly: true + crl_updated_at: + type: string + format: date-time + description: The timestamp for when CRL was last updated. + example: '2017-07-21T17:32:28.000Z' + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the certificate authority. + example: ENABLED + readOnly: true + iam.v2.UpdateCertRequest: + type: object + description: This contains the form fields used to update a Certificate Authority + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - UpdateCertRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The human-readable name of the certificate authority. + example: My Certificate Authority + description: + type: string + description: A description of the certificate authority. + example: Sample description text + certificate_chain: + type: string + description: |- + The PEM encoded string containing the signing certificate chain + used to validate client certs. + example: |- + -----BEGIN CERTIFICATE----- + MIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx + GTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds + b2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV + BAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD + VQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa + DuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc + THAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb + Kk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP + c1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX + gzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV + HRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF + AAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj + Y1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG + j/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH + hm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC + X4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A== + -----END CERTIFICATE----- + certificate_chain_filename: + type: string + description: The name of the certificate file. Must be set if certificate is updated. + example: certificate.pem + crl_url: + type: string + format: uri + description: The url from which to fetch the CRL for the certificate authority if crl_source is URL. + crl_chain: + type: string + description: |- + The PEM encoded string containing the CRL for this certificate authority. + Defaults to this over `crl_url` if available. + example: |- + -----BEGIN X509 CRL----- + MIICNTCCAR0CAQEwDQYJKoZIhvcNAQELBQAwgbExCzAJBgNVBAYTAlVTMQswCQYD + VQQIDAJDQTEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzESMBAGA1UECgwJQ29uZmx1 + ZW50MRMwEQYDVQQLDApzZWN1cml0eS0xMSYwJAYDVQQDDB1tdGxzMS5zZWN1cml0 + eS0xLmNvbmZsdWVudC5pbzEsMCoGCSqGSIb3DQEJARYdbXRsczFAc2VjdXJpdHkt + MS5jb25mbHVlbnQuaW8XDTI0MDgyNTE3NTYyNloXDTI0MTEyMzE3NTYyNlowJzAl + AhQERu3UxH2q3eUglbdeQY8y0vT7rRcNMjQwODI1MTc1NTE2WqAOMAwwCgYDVR0U + BAMCAQEwDQYJKoZIhvcNAQELBQADggEBAGvmflwxVAnqZbRx8njb2t6yXqeIOBaX + CKhMq5CUWrWhMX/JrV5NhVfzeB2tgCCfM4J7gbKSArOKqjYpQBFL+r5eCjPBBcG4 + xqh1J60l5DDsiUcXQM5FtlWTBBZFxvvvWsLP4qA/0meYRY69YQNqgEQgQ65l0Ehl + gIUx8WkEo82A8MDY/t91PaFHufnffPKu4CxFtcpGwuvA2n9mpxB2TsSTiV8THsfE + jatuFwYgumI6t5wIWb71j/1oqQDYtbgpgUvX9gD+g7HlCC4u6Dynd0q8lsimrbf6 + cGf5Vs3JfMcr1kYNruT7kg4f4hc3p4CcuWtxYmHOcWNyZbi+W9Fdakg= + -----END X509 CRL----- + iam.v2.CertificateIdentityPoolList: + type: object + description: |- + `Identitypool` objects represent workload identities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your identity pools associated + with Certificate Authorities + + + Related guide: [Manage Certificate Identity Pools for Granular Client Access Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + ## The Certificate Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_certificate_authority` | Number of Identity Pools per Certificate Authority | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPoolList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Identitypool` objects represent workload identities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your identity pools associated + with Certificate Authorities + + + Related guide: [Manage Certificate Identity Pools for Granular Client Access Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + ## The Certificate Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_certificate_authority` | Number of Identity Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) that specifies which identities can authenticate using your certificate identity pool (see [CEL filter for mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + required: + - id + - metadata + - display_name + - description + - external_identifier + - filter + - principal + - state + uniqueItems: true + iam.v2.CertificateIdentityPool: + type: object + description: |- + `Identitypool` objects represent workload identities in Confluent Cloud. + + The API allows you to list, create, read, update, and delete your identity pools associated + with Certificate Authorities + + + Related guide: [Manage Certificate Identity Pools for Granular Client Access Management](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/configure.html#step-2-create-certificate-identity-pools-for-granular-access-control). + + ## The Certificate Identity Pools Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `identity_pools_per_certificate_authority` | Number of Identity Pools per Certificate Authority | + properties: + api_version: + type: string + enum: + - iam/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CertificateIdentityPool + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: The name of the `IdentityPool`. + example: My Identity Pool + description: + type: string + description: A description of how this `IdentityPool` is used + example: Prod Access to Kafka clusters to Release Engineering + external_identifier: + type: string + description: |- + The certificate field that will be used to represent the + pool's external identifier for audit logging. + example: UID + filter: + type: string + description: A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) that specifies which identities can authenticate using your certificate identity pool (see [CEL filter for mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) for more details). + maxLength: 300 + example: C=='Canada' && O=='Confluent' + principal: + type: string + description: Represents the federated identity associated with this pool. + example: pool-abc + readOnly: true + state: + type: string + x-extensible-enum: + - ENABLED + description: The current state of the identity pool + example: ENABLED + readOnly: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + iam.v2.ApiKeySpec: + type: object + description: The desired state of the Api Key + properties: + secret: + type: string + example: R15hoiDIq8Nxu/lY4mPO3DwAVIfU5W7OI+efsB607mLgHTnVW5XJGVqX2ysDx987 + description: The API key secret. Only provided in `create` responses, not in `get` or `list`. + x-redact: true + x-immutable: true + readOnly: true + display_name: + type: string + example: CI kafka access key + description: A human readable name for the API key + description: + type: string + example: This API key provides kafka access to cluster x + description: A human readable description for the API key + owner: + description: The owner to which this belongs. The owner can be one of iam.v2.User, iam.v2.ServiceAccount. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + resource: + nullable: true + description: | + The resource associated with this object. The resource can be one of Kafka Cluster ID (example: lkc-12345), + Schema Registry Cluster ID (example: lsrc-12345), ksqlDB Cluster ID (example: lksqlc-12345), or Flink + (Environment + Region pair, example: env-abc123.aws.us-east-2). + May be null or omitted if not associated with a resource. For creating Cloud API key, resource should be `CLOUD`, + for creating Tableflow API key, resource should be `TABLEFLOW`. The resource id is case-insensitive. + [Learn more in Authentication](https://docs.confluent.io/cloud/current/api.html#section/Authentication). + + Note - Flink is in the [Preview lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + GlobalObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + iam.v2.JwksObject: + type: object + description: '`JWKS` contains the published keys for the given OpenIDProvider' + required: + - kty + - kid + - alg + properties: + kty: + type: string + x-extensible-enum: + - RSA + description: Specifies the cryptographic algorithm family used with the key + example: RSA + kid: + type: string + description: Specifies the key-id issued by the OpenIDProvider for the particular tenant + example: nOo3ZDrODXEK1jKWhXslHR_KXEg + alg: + type: string + description: Specifies the algorithm to be used to generate the public key + example: RS256 + use: + type: string + description: Specifies the intended usage of the key + example: sig + 'n': + type: string + description: Specifies the modulus of the RSA public key. Represented as a Base64urlUInt-encoded value + e: + type: string + description: Specifies the exponent of the RSA public key. + example: AQAB + iam.v2.JwksSpec: + type: object + description: The desired state of the Jwks + properties: + jwks_status: + type: string + x-extensible-enum: + - REFRESHED + description: The desired state of the public key data + example: REFRESHED + x-enable-id: false + x-enable-listmeta: true + x-enable-objectmeta: false + iam.v2.JwksStatus: + description: The status of the Jwks + type: object + properties: + jwks_status: + type: string + x-extensible-enum: + - REFRESHED + - OK + - INVALID_JWKS_URI + - ERROR_FETCHING_JWKS + description: The actual state of the public key data + example: REFRESHED + jwks_last_refresh_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + description: The last successful refresh time for the public key data + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + TypedGlobalObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + TypedEnvScopedObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + OverQuotaError: + x-summary: Over Quota + description: The request would exceed one or more quotas. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '402' + code: quota_exceeded + title: Kafka Clusters Per Org Quota Exceeded + detail: 'The request would exceed the quota: kafka_clusters_per_environment' + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/kafka.yaml b/provider-dev/source/kafka.yaml new file mode 100644 index 0000000..a0b4e61 --- /dev/null +++ b/provider-dev/source/kafka.yaml @@ -0,0 +1,5023 @@ +openapi: 3.0.0 +info: + title: kafka API + description: confluent kafka API + version: 1.0.0 +paths: + /kafka/v3/clusters/{cluster_id}: + get: + summary: Get Cluster + operationId: getKafkaCluster + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the Kafka cluster with the specified ``cluster_id``. + tags: + - Cluster (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetClusterResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/acls:batch: + post: + summary: Batch Create ACLs + operationId: batchCreateKafkaAcls + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Create ACLs. + tags: + - ACL (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/BatchCreateAclRequest' + responses: + '201': + description: Created + '400': + $ref: '#/components/responses/BadRequestErrorResponse_CreateAcls' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/acls: + get: + summary: List ACLs + operationId: getKafkaAcls + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + - When calling `/acls` without the `principal` parameter, service + accounts are returned in numeric ID format (e.g., `User:12345`). + - To retrieve service accounts in the `sa-xxx` format, use + `/acls?principal=UserV2:*`. + - The `principal` parameter supports both legacy `User:` format and + new `UserV2:` format for service accounts. + Return a list of ACLs that match the search criteria. + tags: + - ACL (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/AclResourceType' + - $ref: '#/components/parameters/AclResourceName' + - $ref: '#/components/parameters/AclPatternType' + - $ref: '#/components/parameters/AclPrincipal' + - $ref: '#/components/parameters/AclHost' + - $ref: '#/components/parameters/AclOperation' + - $ref: '#/components/parameters/AclPermission' + responses: + '200': + $ref: '#/components/responses/SearchAclsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + post: + summary: Create an ACL + operationId: createKafkaAcls + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Create an ACL. + tags: + - ACL (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/CreateAclRequest' + responses: + '201': + description: Created + '400': + $ref: '#/components/responses/BadRequestErrorResponse_CreateAcls' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Delete ACLs + operationId: deleteKafkaAcls + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete the ACLs that match the search criteria. + tags: + - ACL (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/AclResourceTypeRequired' + - $ref: '#/components/parameters/AclResourceName' + - $ref: '#/components/parameters/AclPatternTypeRequired' + - $ref: '#/components/parameters/AclPrincipal' + - $ref: '#/components/parameters/AclHost' + - $ref: '#/components/parameters/AclOperationRequired' + - $ref: '#/components/parameters/AclPermissionRequired' + responses: + '200': + $ref: '#/components/responses/DeleteAclsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse_DeleteAcls' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/broker-configs: + get: + summary: List Dynamic Broker Configs + operationId: listKafkaClusterConfigs + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return a list of dynamic cluster-wide broker configuration parameters for the specified Kafka + cluster. Returns an empty list if there are no dynamic cluster-wide broker configuration parameters. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListClusterConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/broker-configs:alter: + post: + summary: Batch Alter Dynamic Broker Configs + operationId: updateKafkaClusterConfigs + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Update or delete a set of dynamic cluster-wide broker configuration parameters. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterClusterConfigBatchRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/broker-configs/{name}: + get: + summary: Get Dynamic Broker Config + operationId: getKafkaClusterConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the dynamic cluster-wide broker configuration parameter specified by ``name``. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetClusterConfigResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + put: + summary: Update Dynamic Broker Config + operationId: updateKafkaClusterConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Update the dynamic cluster-wide broker configuration parameter specified by ``name``. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/UpdateClusterConfigRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Reset Dynamic Broker Config + operationId: deleteKafkaClusterConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Reset the configuration parameter specified by ``name`` to its + default value by deleting a dynamic cluster-wide configuration. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConfigName' + /kafka/v3/clusters/{cluster_id}/consumer-groups: + get: + summary: List Consumer Groups + operationId: listKafkaConsumerGroups + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the list of consumer groups that belong to the specified + Kafka cluster. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListConsumerGroupsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}: + get: + summary: Get Consumer Group + operationId: getKafkaConsumerGroup + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the consumer group specified by the ``consumer_group_id``. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetConsumerGroupResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers: + get: + summary: List Consumers + operationId: listKafkaConsumers + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return a list of consumers that belong to the specified consumer + group. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListConsumersResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary: + get: + summary: Get Consumer Group Lag Summary + operationId: getKafkaConsumerGroupLagSummary + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Available in dedicated clusters only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) + + Return the maximum and total lag of the consumers belonging to the + specified consumer group. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetConsumerGroupLagSummaryResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags: + get: + summary: List Consumer Lags + operationId: listKafkaConsumerLags + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Available in dedicated clusters only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) + + Return a list of consumer lags of the consumers belonging to the + specified consumer group. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListConsumerLagsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id}: + get: + summary: Get Consumer Lag + operationId: getKafkaConsumerLag + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Available in dedicated clusters only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) + + Return the consumer lag on a partition with the given `partition_id`. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetConsumerLagResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/PartitionId' + /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id}: + get: + summary: Get Consumer + operationId: getKafkaConsumer + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the consumer specified by the ``consumer_id``. + tags: + - Consumer Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetConsumerResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + - $ref: '#/components/parameters/ConsumerId' + /kafka/v3/clusters/{cluster_id}/topics: + get: + summary: List Topics + operationId: listKafkaTopics + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the list of topics that belong to the specified Kafka cluster. + tags: + - Topic (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListTopicsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + post: + summary: Create Topic + operationId: createKafkaTopic + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Create a topic. + Also supports a dry-run mode that only validates whether the topic creation would succeed + if the ``validate_only`` request property is explicitly specified and set to true. Note that + when dry-run mode is being used the response status would be 200 OK instead of 201 Created. + tags: + - Topic (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/CreateTopicRequest' + responses: + '200': + $ref: '#/components/responses/CreateTopicResponse' + '201': + $ref: '#/components/responses/CreateTopicResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse_CreateTopic' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}: + get: + summary: Get Topic + operationId: getKafkaTopic + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the topic with the given `topic_name`. + tags: + - Topic (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/IncludeAuthorizedOperations' + responses: + '200': + $ref: '#/components/responses/GetTopicResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + patch: + summary: Update Partition Count + operationId: updatePartitionCountKafkaTopic + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Increase the number of partitions for a topic. To update other topic + configurations, see https://docs.confluent.io/cloud/current/api.html#tag/Configs-(v3)/operation/updateKafkaTopicConfig. + tags: + - Topic (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePartitionCountRequestData' + responses: + '200': + $ref: '#/components/responses/GetTopicResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse_UpdatePartitionCountTopic' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Delete Topic + operationId: deleteKafkaTopic + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete the topic with the given `topic_name`. + tags: + - Topic (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs: + get: + summary: List Topic Configs + operationId: listKafkaTopicConfigs + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the list of configuration parameters that belong to the specified topic. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListTopicConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs:alter: + post: + summary: Batch Alter Topic Configs + operationId: updateKafkaTopicConfigBatch + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Update or delete a set of topic configuration parameters. + Also supports a dry-run mode that only validates whether the operation would succeed if the + ``validate_only`` request property is explicitly specified and set to true. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterTopicConfigBatchRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name}: + get: + summary: Get Topic Config + operationId: getKafkaTopicConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the configuration parameter with the given `name`. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetTopicConfigResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + put: + summary: Update Topic Config + operationId: updateKafkaTopicConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Update the configuration parameter with given `name`. To update the + number of partitions, see + https://docs.confluent.io/cloud/current/api.html#tag/Topic-(v3)/operation/updatePartitionCountKafkaTopic. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/UpdateTopicConfigRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Reset Topic Config + operationId: deleteKafkaTopicConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Reset the configuration parameter with given `name` to its default value. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/ConfigName' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions: + get: + summary: List Partitions + operationId: listKafkaPartitions + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the list of partitions that belong to the specified topic. + tags: + - Partition (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListPartitionsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}: + get: + summary: Get Partition + operationId: getKafkaPartition + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the partition with the given `partition_id`. + tags: + - Partition (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetPartitionResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/PartitionId' + /kafka/v3/clusters/{cluster_id}/topics/-/configs: + get: + summary: List All Topic Configs + operationId: listKafkaAllTopicConfigs + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Return the list of configuration parameters for all topics hosted by the specified + cluster. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListTopicConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/records: + post: + summary: Produce Records + operationId: produceRecord + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Produce records to the given topic, returning delivery reports for each + record produced. This API can be used in streaming mode by setting + "Transfer-Encoding: chunked" header. For as long as the connection is + kept open, the server will keep accepting records. Records are streamed + to and from the server as Concatenated JSON. For each record sent to the + server, the server will asynchronously send back a delivery report, in + the same order, each with its own error_code. An error_code of 200 + indicates success. The HTTP status code will be HTTP 200 OK as long as + the connection is successfully established. To identify records that + have encountered an error, check the error_code of each delivery report. + + Note that the cluster_id is validated only when running in Confluent Cloud. + + This API currently does not support Schema Registry integration. Sending + schemas is not supported. Only BINARY, JSON, and STRING formats are + supported. + tags: + - Records (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/ProduceRequest' + responses: + '200': + $ref: '#/components/responses/ProduceResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse_ProduceRecords' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '413': + $ref: '#/components/responses/RequestEntityTooLargeErrorResponse' + '415': + $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse' + '422': + $ref: '#/components/responses/UnprocessableEntity_ProduceRecord' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + /kafka/v3/clusters/{cluster_id}/links: + get: + summary: List all cluster links in the dest cluster + operationId: listKafkaLinks + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead. + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListLinksResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + post: + summary: Create a cluster link + operationId: createKafkaLink + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Cluster link creation requires source cluster security configurations in + the configs JSON section of the data request payload. + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/QueryParamLinkName' + - $ref: '#/components/parameters/ValidateOnly' + - $ref: '#/components/parameters/ValidateLink' + requestBody: + $ref: '#/components/requestBodies/CreateLinkRequest' + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/links/{link_name}: + get: + summary: Describe the cluster link + operationId: getKafkaLink + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead. + tags: + - Cluster Linking (v3) + parameters: + - $ref: '#/components/parameters/IncludeTasks' + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetLinkResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Delete the cluster link + operationId: deleteKafkaLink + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/Force' + - $ref: '#/components/parameters/ValidateOnly' + responses: + '200': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/default-configs: + get: + summary: List New Topic Default Configs + operationId: listKafkaDefaultTopicConfigs + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + List the default configuration parameters used if the topic were to be newly created. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListTopicConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs: + get: + summary: List all configs of the cluster link + operationId: listKafkaLinkConfigs + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListLinkConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name}: + get: + summary: Describe the config under the cluster link + operationId: getKafkaLinkConfigs + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetLinkConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + put: + summary: Alter the config under the cluster link + operationId: updateKafkaLinkConfig + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/UpdateLinkConfigRequest' + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Reset the given config to default value + operationId: deleteKafkaLinkConfig + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/LinkConfigName' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs:alter: + put: + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Batch Alter Cluster Link Configs + operationId: updateKafkaLinkConfigBatch + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/ValidateOnly' + requestBody: + $ref: '#/components/requestBodies/AlterLinkConfigBatchRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + summary: Batch Alter Cluster Link Configs + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors: + post: + summary: Create a mirror topic + operationId: createKafkaMirrorTopic + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Create a topic in the destination cluster mirroring a topic in + the source cluster + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/CreateMirrorTopicRequest' + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + get: + summary: List mirror topics + operationId: listKafkaMirrorTopicsUnderLink + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + List all mirror topics under the link + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/MirrorTopicStatus' + responses: + '200': + $ref: '#/components/responses/ListMirrorTopicsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + /kafka/v3/clusters/{cluster_id}/links/-/mirrors: + get: + summary: List mirror topics + operationId: listKafkaMirrorTopics + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + List all mirror topics in the cluster + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/MirrorTopicStatus' + responses: + '200': + $ref: '#/components/responses/ListMirrorTopicsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors/{mirror_topic_name}: + get: + summary: Describe the mirror topic + operationId: readKafkaMirrorTopic + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' + tags: + - Cluster Linking (v3) + parameters: + - $ref: '#/components/parameters/IncludeStateTransitionErrors' + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/DescribeMirrorTopicResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/MirrorTopicName' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:promote: + post: + summary: Promote the mirror topics + operationId: updateKafkaMirrorTopicsPromote + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:failover: + post: + summary: Failover the mirror topics + operationId: updateKafkaMirrorTopicsFailover + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:pause: + post: + summary: Pause the mirror topics + operationId: updateKafkaMirrorTopicsPause + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:resume: + post: + summary: Resume the mirror topics + operationId: updateKafkaMirrorTopicsResume + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-start-mirror: + post: + summary: Reverse the local mirror topic and start the remote mirror topic + operationId: updateKafkaMirrorTopicsReverseAndStartMirror + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-pause-mirror: + post: + summary: Reverse the local mirror topic and Pause the remote mirror topic + operationId: updateKafkaMirrorTopicsReverseAndPauseMirror + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' + /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:truncate-and-restore: + post: + summary: Truncates the local topic to the remote stopped mirror log end offsets and restores mirroring to the local topic to mirror from the remote topic + operationId: updateKafkaMirrorTopicsTruncateAndRestoreMirror + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' + tags: + - Cluster Linking (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/AlterMirrorsRequest' + responses: + '200': + $ref: '#/components/responses/AlterMirrorStatusResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/IncludePartitionLevelTruncationData' + - $ref: '#/components/parameters/ValidateOnly' + /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs: + get: + summary: List all configs of the group + operationId: listKafkaGroupConfigs + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + List all configurations for the specified group. This API supports consumer groups, share groups, and streams groups. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListGroupConfigsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name}: + get: + summary: Get group config + operationId: getKafkaGroupConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Get the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetGroupConfigResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + put: + summary: Update group config + operationId: updateKafkaGroupConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Update the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + $ref: '#/components/requestBodies/UpdateGroupConfigRequest' + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Delete group config + operationId: deleteKafkaGroupConfig + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete the dynamic configuration override with the specified name for the specified group. After deletion, the default group configuration will be applied. This API supports consumer groups, share groups, and streams groups. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConfigName' + /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs:alter: + post: + summary: Batch Alter Group Configs + operationId: updateKafkaGroupConfigBatch + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Batch alter configurations for the specified group. This API supports consumer groups, share groups, and streams groups. + tags: + - Configs (v3) + security: + - resource-api-key: [] + - external-access-token: [] + parameters: + - $ref: '#/components/parameters/ValidateOnly' + requestBody: + $ref: '#/components/requestBodies/AlterGroupConfigBatchRequest' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' +components: + schemas: + UpdatePartitionCountRequestData: + type: object + required: + - partitions_count + properties: + partitions_count: + type: integer + format: int32 + ClusterData: + type: object + required: + - kind + - metadata + - cluster_id + - acls + - brokers + - broker_configs + - consumer_groups + - topics + - partition_reassignments + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + controller: + $ref: '#/components/schemas/Relationship' + acls: + $ref: '#/components/schemas/Relationship' + brokers: + $ref: '#/components/schemas/Relationship' + broker_configs: + $ref: '#/components/schemas/Relationship' + consumer_groups: + $ref: '#/components/schemas/Relationship' + topics: + $ref: '#/components/schemas/Relationship' + partition_reassignments: + $ref: '#/components/schemas/Relationship' + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + CreateAclRequestDataList: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/CreateAclRequestData' + AclResourceType: + type: string + enum: + - UNKNOWN + - ANY + - TOPIC + - GROUP + - CLUSTER + - TRANSACTIONAL_ID + - DELEGATION_TOKEN + AclPatternType: + type: string + x-extensible-enum: + - UNKNOWN + - ANY + - MATCH + - LITERAL + - PREFIXED + AclOperation: + type: string + x-extensible-enum: + - UNKNOWN + - ANY + - ALL + - READ + - WRITE + - CREATE + - DELETE + - ALTER + - DESCRIBE + - CLUSTER_ACTION + - DESCRIBE_CONFIGS + - ALTER_CONFIGS + - IDEMPOTENT_WRITE + AclPermission: + type: string + x-extensible-enum: + - UNKNOWN + - ANY + - DENY + - ALLOW + AclDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/AclData' + CreateAclRequestData: + type: object + required: + - resource_type + - resource_name + - pattern_type + - principal + - host + - operation + - permission + properties: + resource_type: + $ref: '#/components/schemas/AclResourceType' + resource_name: + type: string + pattern_type: + $ref: '#/components/schemas/AclPatternType' + principal: + type: string + host: + type: string + operation: + $ref: '#/components/schemas/AclOperation' + permission: + $ref: '#/components/schemas/AclPermission' + AclData: + type: object + required: + - kind + - metadata + - cluster_id + - resource_type + - resource_name + - pattern_type + - principal + - host + - operation + - permission + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + resource_type: + $ref: '#/components/schemas/AclResourceType' + resource_name: + type: string + pattern_type: + $ref: '#/components/schemas/AclPatternType' + principal: + type: string + host: + type: string + operation: + $ref: '#/components/schemas/AclOperation' + permission: + $ref: '#/components/schemas/AclPermission' + ClusterConfigDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ClusterConfigData' + AlterConfigBatchRequestData: + type: object + required: + - data + properties: + data: + type: array + items: + type: object + required: + - name + properties: + name: + type: string + value: + type: string + nullable: true + operation: + type: string + x-extensible-enum: + - SET + - DELETE + nullable: true + validate_only: + type: boolean + ClusterConfigData: + type: object + required: + - kind + - metadata + - cluster_id + - name + - is_default + - is_read_only + - is_sensitive + - source + - synonyms + - config_type + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + name: + type: string + value: + type: string + nullable: true + is_default: + type: boolean + is_read_only: + type: boolean + is_sensitive: + type: boolean + source: + $ref: '#/components/schemas/ConfigSource' + synonyms: + type: array + items: + $ref: '#/components/schemas/ConfigSynonymData' + config_type: + $ref: '#/components/schemas/ClusterConfigType' + UpdateConfigRequestData: + type: object + properties: + value: + type: string + nullable: true + ConsumerGroupDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ConsumerGroupData' + ConsumerGroupData: + type: object + required: + - kind + - metadata + - cluster_id + - consumer_group_id + - is_simple + - partition_assignor + - state + - type + - is_mixed_consumer_group + - coordinator + - consumers + - lag_summary + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + consumer_group_id: + type: string + is_simple: + type: boolean + partition_assignor: + type: string + state: + $ref: '#/components/schemas/ConsumerGroupState' + type: + $ref: '#/components/schemas/ConsumerGroupType' + is_mixed_consumer_group: + type: boolean + coordinator: + $ref: '#/components/schemas/Relationship' + consumers: + $ref: '#/components/schemas/Relationship' + lag_summary: + $ref: '#/components/schemas/Relationship' + ConsumerDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ConsumerData' + ConsumerGroupLagSummaryData: + type: object + required: + - kind + - metadata + - cluster_id + - consumer_group_id + - max_lag_consumer_id + - max_lag_client_id + - max_lag_topic_name + - max_lag_partition_id + - max_lag + - total_lag + - max_lag_consumer + - max_lag_partition + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + consumer_group_id: + type: string + max_lag_consumer_id: + type: string + max_lag_instance_id: + type: string + nullable: true + max_lag_client_id: + type: string + max_lag_topic_name: + type: string + max_lag_partition_id: + type: integer + max_lag: + type: integer + format: int64 + total_lag: + type: integer + format: int64 + max_lag_consumer: + $ref: '#/components/schemas/Relationship' + max_lag_partition: + $ref: '#/components/schemas/Relationship' + ConsumerLagDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ConsumerLagData' + ConsumerLagData: + type: object + required: + - kind + - metadata + - cluster_id + - consumer_group_id + - topic_name + - partition_id + - current_offset + - log_end_offset + - lag + - consumer_id + - client_id + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + consumer_group_id: + type: string + topic_name: + type: string + partition_id: + type: integer + current_offset: + type: integer + format: int64 + log_end_offset: + type: integer + format: int64 + lag: + type: integer + format: int64 + consumer_id: + type: string + instance_id: + type: string + nullable: true + client_id: + type: string + ConsumerData: + type: object + required: + - kind + - metadata + - cluster_id + - consumer_group_id + - consumer_id + - client_id + - assignments + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + consumer_group_id: + type: string + consumer_id: + type: string + instance_id: + type: string + nullable: true + client_id: + type: string + assignments: + $ref: '#/components/schemas/Relationship' + TopicDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/TopicData' + CreateTopicRequestData: + type: object + required: + - topic_name + properties: + topic_name: + type: string + partitions_count: + type: integer + replication_factor: + type: integer + configs: + type: array + items: + type: object + required: + - name + properties: + name: + type: string + value: + type: string + nullable: true + validate_only: + type: boolean + TopicData: + type: object + required: + - kind + - metadata + - cluster_id + - topic_name + - is_internal + - replication_factor + - partitions_count + - partitions + - configs + - partition_reassignments + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + topic_name: + type: string + is_internal: + type: boolean + replication_factor: + type: integer + partitions_count: + type: integer + partitions: + $ref: '#/components/schemas/Relationship' + configs: + $ref: '#/components/schemas/Relationship' + partition_reassignments: + $ref: '#/components/schemas/Relationship' + authorized_operations: + $ref: '#/components/schemas/AuthorizedOperations' + TopicConfigDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/TopicConfigData' + TopicConfigData: + type: object + required: + - kind + - metadata + - cluster_id + - name + - is_default + - is_read_only + - is_sensitive + - source + - synonyms + - topic_name + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + name: + type: string + value: + type: string + nullable: true + is_default: + type: boolean + is_read_only: + type: boolean + is_sensitive: + type: boolean + source: + $ref: '#/components/schemas/ConfigSource' + synonyms: + type: array + items: + $ref: '#/components/schemas/ConfigSynonymData' + topic_name: + type: string + PartitionDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/PartitionData' + PartitionData: + type: object + required: + - kind + - metadata + - cluster_id + - topic_name + - partition_id + - replicas + - reassignment + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + topic_name: + type: string + partition_id: + type: integer + leader: + $ref: '#/components/schemas/Relationship' + replicas: + $ref: '#/components/schemas/Relationship' + reassignment: + $ref: '#/components/schemas/Relationship' + ProduceRequest: + type: object + properties: + partition_id: + type: integer + nullable: true + format: int32 + headers: + type: array + items: + $ref: '#/components/schemas/ProduceRequestHeader' + key: + $ref: '#/components/schemas/ProduceRequestData' + value: + $ref: '#/components/schemas/ProduceRequestData' + timestamp: + type: string + format: date-time + nullable: true + ProduceResponse: + type: object + required: + - error_code + properties: + error_code: + type: integer + format: int32 + message: + type: string + cluster_id: + type: string + topic_name: + type: string + partition_id: + type: integer + format: int32 + offset: + type: integer + format: int64 + timestamp: + type: string + format: date-time + nullable: true + key: + $ref: '#/components/schemas/ProduceResponseData' + value: + $ref: '#/components/schemas/ProduceResponseData' + ListLinksResponseDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ListLinksResponseData' + CreateLinkRequestData: + properties: + source_cluster_id: + type: string + destination_cluster_id: + type: string + remote_cluster_id: + description: The expected remote cluster ID. + type: string + cluster_link_id: + description: The expected cluster link ID. Can be provided when creating the second side of a bidirectional link for validating the link ID is as expected. If it's not provided, it's inferred from the remote cluster. + type: string + configs: + items: + $ref: '#/components/schemas/ConfigData' + type: array + type: object + ListLinksResponseData: + type: object + required: + - kind + - metadata + - link_name + - cluster_link_id + - topic_names + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + source_cluster_id: + type: string + nullable: true + destination_cluster_id: + type: string + nullable: true + remote_cluster_id: + type: string + nullable: true + link_name: + type: string + link_id: + type: string + deprecated: true + cluster_link_id: + type: string + topic_names: + type: array + items: + type: string + link_error: + $ref: '#/components/schemas/LinkError' + nullable: true + link_error_message: + type: string + nullable: true + link_state: + $ref: '#/components/schemas/LinkState' + nullable: true + tasks: + nullable: true + type: array + items: + $ref: '#/components/schemas/LinkTask' + category_counts: + nullable: true + type: array + items: + $ref: '#/components/schemas/LinkCategory' + ListLinkConfigsResponseDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ListLinkConfigsResponseData' + ListLinkConfigsResponseData: + type: object + required: + - kind + - metadata + - cluster_id + - name + - value + - is_default + - is_read_only + - is_sensitive + - source + - synonyms + - link_name + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + name: + type: string + value: + type: string + is_default: + type: boolean + is_read_only: + type: boolean + is_sensitive: + type: boolean + source: + type: string + x-extensible-enum: + - DYNAMIC_CLUSTER_LINK_CONFIG + synonyms: + type: array + items: + type: string + link_name: + type: string + UpdateLinkConfigRequestData: + properties: + value: + type: string + required: + - value + type: object + CreateMirrorTopicRequestData: + properties: + source_topic_name: + type: string + mirror_topic_name: + type: string + replication_factor: + type: integer + configs: + type: array + items: + $ref: '#/components/schemas/ConfigData' + required: + - source_topic_name + type: object + MirrorTopicStatus: + enum: + - ACTIVE + - FAILED + - LINK_FAILED + - LINK_PAUSED + - PAUSED + - PENDING_STOPPED + - SOURCE_UNAVAILABLE + - STOPPED + - PENDING_MIRROR + - PENDING_SYNCHRONIZE + - PENDING_SETUP_FOR_RESTORE + - PENDING_RESTORE + type: string + ListMirrorTopicsResponseDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ListMirrorTopicsResponseData' + ListMirrorTopicsResponseData: + type: object + required: + - kind + - metadata + - link_name + - mirror_topic_name + - source_topic_name + - num_partitions + - mirror_lags + - mirror_status + - state_time_ms + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + link_name: + type: string + mirror_topic_name: + type: string + source_topic_name: + type: string + num_partitions: + type: integer + mirror_lags: + $ref: '#/components/schemas/MirrorLags' + mirror_status: + $ref: '#/components/schemas/MirrorTopicStatus' + mirror_topic_error: + $ref: '#/components/schemas/MirrorTopicError' + state_time_ms: + type: integer + format: int64 + mirror_state_transition_errors: + type: array + items: + $ref: '#/components/schemas/LinkTaskError' + AlterMirrorsRequestData: + properties: + mirror_topic_names: + description: The mirror topics specified as a list of topic names. + type: array + items: + type: string + mirror_topic_name_pattern: + description: The mirror topics specified as a pattern. + type: string + type: object + AlterMirrorStatusResponseDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/AlterMirrorStatusResponseData' + GroupConfigDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/GroupConfigData' + GroupConfigData: + type: object + required: + - kind + - metadata + - cluster_id + - group_id + - name + - is_default + - is_read_only + - is_sensitive + - source + - synonyms + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + group_id: + type: string + name: + type: string + value: + type: string + nullable: true + is_default: + type: boolean + is_read_only: + type: boolean + is_sensitive: + type: boolean + source: + $ref: '#/components/schemas/ConfigSource' + synonyms: + type: array + items: + $ref: '#/components/schemas/ConfigSynonymData' + UpdateGroupConfigRequestData: + properties: + value: + type: string + required: + - value + type: object + Resource: + type: object + required: + - kind + - metadata + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + Relationship: + type: object + required: + - related + properties: + related: + type: string + ResourceCollection: + type: object + required: + - kind + - metadata + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + AbstractConfigData: + type: object + required: + - kind + - metadata + - cluster_id + - name + - is_default + - is_read_only + - is_sensitive + - source + - synonyms + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + name: + type: string + value: + type: string + nullable: true + is_default: + type: boolean + is_read_only: + type: boolean + is_sensitive: + type: boolean + source: + $ref: '#/components/schemas/ConfigSource' + synonyms: + type: array + items: + $ref: '#/components/schemas/ConfigSynonymData' + ClusterConfigType: + type: string + x-extensible-enum: + - BROKER + ConsumerGroupState: + type: string + x-extensible-enum: + - UNKNOWN + - PREPARING_REBALANCE + - COMPLETING_REBALANCE + - ASSIGNING + - RECONCILING + - STABLE + - DEAD + - EMPTY + ConsumerGroupType: + type: string + x-extensible-enum: + - UNKNOWN + - CLASSIC + - CONSUMER + - SHARE + AuthorizedOperations: + type: array + items: + type: string + x-extensible-enum: + - UNKNOWN + - ALL + - READ + - WRITE + - CREATE + - DELETE + - ALTER + - DESCRIBE + - CLUSTER_ACTION + - DESCRIBE_CONFIGS + - ALTER_CONFIGS + - IDEMPOTENT_WRITE + ProduceRequestHeader: + type: object + required: + - name + properties: + name: + type: string + value: + type: string + format: byte + nullable: true + ProduceRequestData: + type: object + properties: + type: + type: string + x-extensible-enum: + - BINARY + - JSON + - STRING + data: + $ref: '#/components/schemas/AnyValue' + nullable: true + ProduceResponseData: + type: object + required: + - size + - type + properties: + size: + type: integer + type: + type: string + x-extensible-enum: + - BINARY + - JSON + - STRING + nullable: true + ConfigData: + example: + name: name + value: value + properties: + name: + type: string + value: + nullable: true + type: string + required: + - name + - value + type: object + LinkError: + type: string + x-extensible-enum: + - UNKNOWN + - NO_ERROR + - AUTHENTICATION_ERROR + - UNRESOLVABLE_BOOTSTRAP_ERROR + - INVALID_BOOTSTRAP_INTERNAL_ENDPOINT_ERROR + - BOOTSTRAP_TCP_CONNECTION_FAILED_ERROR + - TIMEOUT_ERROR + LinkState: + type: string + x-extensible-enum: + - ACTIVE + - FAILED + - UNAVAILABLE + - PAUSED + - UNKNOWN + LinkTask: + type: object + required: + - task_name + - state + - errors + properties: + task_name: + type: string + state: + $ref: '#/components/schemas/LinkTaskState' + errors: + type: array + items: + $ref: '#/components/schemas/LinkTaskError' + LinkCategory: + type: object + required: + - state_category + - count + properties: + state_category: + $ref: '#/components/schemas/StateCategory' + count: + type: integer + format: int32 + example: 123 + MirrorLags: + type: array + items: + $ref: '#/components/schemas/MirrorLag' + MirrorTopicError: + type: string + x-extensible-enum: + - UNKNOWN + - NOT_SET + - NO_ERROR + - SOURCE_TOPIC_MAY_BE_DELETED + - SOURCE_TOPIC_ID_CHANGED + - SOURCE_PARTITIONS_DECREASED + - NON_MONOTONIC_LOG_APPEND_EPOCH + - UNEXPECTED_TRUNCATION + - UNSUPPORTED_MESSAGE_FORMAT + - NON_MONOTONIC_SOURCE_EPOCH + - ILLEGAL_STATE + - UNSUPPORTED_MIRROR_STATE + LinkTaskError: + type: object + required: + - error_code + - error_message + properties: + error_code: + type: string + error_message: + type: string + AlterMirrorStatusResponseData: + type: object + required: + - kind + - metadata + - mirror_topic_name + - error_message + - error_code + - mirror_lags + - messages_truncated + - partition_level_truncation_data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + mirror_topic_name: + type: string + error_message: + type: string + nullable: true + error_code: + type: integer + nullable: true + mirror_lags: + $ref: '#/components/schemas/MirrorLags' + messages_truncated: + type: integer + format: int64 + nullable: true + partition_level_truncation_data: + $ref: '#/components/schemas/PartitionLevelTruncationDataList' + nullable: true + ConfigSource: + type: string + x-extensible-enum: + - DYNAMIC_CLUSTER_LINK_CONFIG + - DYNAMIC_TOPIC_CONFIG + - DYNAMIC_BROKER_LOGGER_CONFIG + - DYNAMIC_BROKER_CONFIG + - DYNAMIC_DEFAULT_BROKER_CONFIG + - STATIC_BROKER_CONFIG + - DEFAULT_CONFIG + - UNKNOWN + ConfigSynonymData: + type: object + required: + - name + - source + properties: + name: + type: string + value: + type: string + nullable: true + source: + $ref: '#/components/schemas/ConfigSource' + ResourceMetadata: + type: object + required: + - self + properties: + self: + type: string + resource_name: + type: string + nullable: true + ResourceCollectionMetadata: + type: object + required: + - self + properties: + self: + type: string + next: + type: string + nullable: true + AnyValue: + nullable: true + LinkTaskState: + type: string + x-extensible-enum: + - UNKNOWN + - ACTIVE + - IN_ERROR + - NOT_CONFIGURED + - LINK_FAILED + - LINK_UNAVAILABLE + - LINK_PAUSED + StateCategory: + type: string + x-extensible-enum: + - PAUSED + - IN_ERROR + - PENDING + - ACTIVE + - NOT_APPLICABLE + MirrorLag: + type: object + required: + - partition + - lag + - last_source_fetch_offset + properties: + partition: + type: integer + lag: + type: integer + format: int64 + last_source_fetch_offset: + type: integer + format: int64 + PartitionLevelTruncationDataList: + type: array + items: + $ref: '#/components/schemas/PartitionLevelTruncationData' + PartitionLevelTruncationData: + type: object + required: + - partition_id + - offset_truncated_to + - messages_truncated + properties: + partition_id: + type: integer + offset_truncated_to: + type: integer + format: int64 + messages_truncated: + type: integer + format: int64 + responses: + GetClusterResponse: + description: The Kafka cluster. + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterData' + example: + kind: KafkaCluster + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1 + resource_name: crn:///kafka=cluster-1 + cluster_id: cluster-1 + controller: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + acls: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls + brokers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers + broker_configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs + consumer_groups: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups + topics: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics + partition_reassignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/-/partitions/-/reassignment + BadRequestErrorResponse: + description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + bad_request_cannot_deserialize: + description: Thrown when trying to deserialize an integer from non-integer data. + value: + error_code: 400 + message: 'Cannot deserialize value of type `java.lang.Integer` from String "A": not a valid `java.lang.Integer` value' + unsupported_version_exception: + description: Thrown when the version of this API is not supported in the underlying Kafka cluster. + value: + error_code: 40035 + message: The version of this API is not supported in the underlying Kafka cluster. + UnauthorizedErrorResponse: + description: Indicates a client authentication error. Kafka authentication failures will contain error code 40101 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + kafka_authentication_failed: + description: Thrown when using Basic authentication with wrong Kafka credentials. + value: + error_code: 40101 + message: Authentication failed + ForbiddenErrorResponse: + description: Indicates a client authorization error. Kafka authorization failures will contain error code 40301 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + kafka_authorization_failed: + description: Thrown when the caller is not authorized to perform the underlying operation. + value: + error_code: 40301 + message: Request is not authorized + TooManyRequestsErrorResponse: + description: Indicates that a rate limit threshold has been reached, and the client should retry again later. + content: + text/html: + schema: + type: string + example: + description: A sample response from Jetty's DoSFilter. + value: Error 429 Too Many Requests

HTTP ERROR 429 Too Many Requests

URI: /v3/clusters/my-cluster
STATUS: 429
MESSAGE: Too Many Requests
SERVLET: default
+ ServerErrorResponse: + description: A server-side problem that might not be addressable from the client side. Retriable Kafka errors will contain error code 50003 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + generic_internal_server_error: + description: Thrown for generic HTTP 500 errors. + value: + error_code: 500 + message: Internal Server Error + BadRequestErrorResponse_CreateAcls: + description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + create_acls_cluster_name_invalid: + description: Thrown when creating an ACL for a CLUSTER resource specifying the wrong resource name. + value: + error_code: 40002 + message: The only valid name for the CLUSTER resource is kafka-cluster" + SearchAclsResponse: + description: The list of ACLs. + content: + application/json: + schema: + $ref: '#/components/schemas/AclDataList' + example: + kind: KafkaAclList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?principal=User%3Aalice + data: + - kind: KafkaAcl + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=TOPIC&resource_name=topic-&pattern_type=PREFIXED&principal=User%3Aalice&host=*&operation=ALL&permission=ALLOW + cluster_id: cluster-1 + resource_type: TOPIC + resource_name: topic- + pattern_type: PREFIXED + principal: User:alice + host: '*' + operation: ALL + permission: ALLOW + - kind: KafkaAcl + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=CLUSTER&resource_name=kafka-cluster&pattern_type=LITERAL&principal=User%3Aalice&host=*&operation=DESCRIBE&permission=DENY + cluster_id: cluster-1 + resource_type: CLUSTER + resource_name: kafka-cluster + pattern_type: LITERAL + principal: User:alice + host: '*' + operation: DESCRIBE + permission: DENY + DeleteAclsResponse: + description: The list of deleted ACLs. + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/AclData' + example: + data: + - kind: KafkaAcl + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=TOPIC&resource_name=topic-&pattern_type=PREFIXED&principal=User%3Aalice&host=*&operation=ALL&permission=ALLOW + cluster_id: cluster-1 + resource_type: TOPIC + resource_name: topic- + pattern_type: PREFIXED + principal: User:alice + host: '*' + operation: ALL + permission: ALLOW + - kind: KafkaAcl + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=CLUSTER&resource_name=kafka-cluster&pattern_type=LITERAL&principal=User%3Aalice&host=*&operation=DESCRIBE&permission=DENY + cluster_id: cluster-1 + resource_type: CLUSTER + resource_name: kafka-cluster + pattern_type: LITERAL + principal: User:alice + host: '*' + operation: DESCRIBE + permission: DENY + BadRequestErrorResponse_DeleteAcls: + description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + delete_acls_unspecified_resource_type: + description: Thrown when trying to delete ACLs without specifying a valid resource type. + value: + error_code: 400 + message: resource_type cannot be unspecified or UNKNOWN + ListClusterConfigsResponse: + description: The list of cluster configs. + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterConfigDataList' + example: + kind: KafkaClusterConfigList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs + next: null + data: + - kind: KafkaClusterConfig + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/max.connections + resource_name: crn:///kafka=cluster-1/broker-config=max.connections + cluster_id: cluster-1 + config_type: BROKER + name: max.connections + value: '1000' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_DEFAULT_BROKER_CONFIG + synonyms: + - name: max.connections + value: '1000' + source: DYNAMIC_DEFAULT_BROKER_CONFIG + - name: max.connections + value: '2147483647' + source: DEFAULT_CONFIG + - kind: KafkaClusterConfig + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type + resource_name: crn:///kafka=cluster-1/broker-config=compression.type + cluster_id: cluster-1 + config_type: BROKER + name: compression.type + value: gzip + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_DEFAULT_BROKER_CONFIG + synonyms: + - name: compression.type + value: gzip + source: DYNAMIC_DEFAULT_BROKER_CONFIG + - name: compression.type + value: producer + source: DEFAULT_CONFIG + GetClusterConfigResponse: + description: The cluster configuration parameter. + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterConfigData' + example: + kind: KafkaClusterConfig + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type + resource_name: crn:///kafka=cluster-1/broker-config=compression.type + cluster_id: cluster-1 + config_type: BROKER + name: compression.type + value: gzip + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_DEFAULT_BROKER_CONFIG + synonyms: + - name: compression.type + value: gzip + source: DYNAMIC_DEFAULT_BROKER_CONFIG + - name: compression.type + value: producer + source: DEFAULT_CONFIG + ListConsumerGroupsResponse: + description: The list of consumer groups. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerGroupDataList' + example: + kind: KafkaConsumerGroupList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups + next: null + data: + - kind: KafkaConsumerGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + is_simple: false + partition_assignor: org.apache.kafka.clients.consumer.RoundRobinAssignor + state: STABLE + type: CLASSIC + is_mixed_consumer_group: false + coordinator: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + consumers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers + lag_summary: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary + - kind: KafkaConsumerGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-2 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-2 + cluster_id: cluster-1 + consumer_group_id: consumer-group-2 + is_simple: false + partition_assignor: org.apache.kafka.clients.consumer.StickyAssignor + state: PREPARING_REBALANCE + type: CLASSIC + is_mixed_consumer_group: false + coordinator: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 + consumers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-2/consumers + lag_summary: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-2/lag-summary + - kind: KafkaConsumerGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-3 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-3 + cluster_id: cluster-1 + consumer_group_id: consumer-group-3 + is_simple: false + partition_assignor: org.apache.kafka.clients.consumer.RangeAssignor + state: DEAD + type: CLASSIC + is_mixed_consumer_group: false + coordinator: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/3 + consumers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-3/consumers + lag_summary: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-3/lag-summary + GetConsumerGroupResponse: + description: The consumer group. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerGroupData' + example: + kind: KafkaConsumerGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + is_simple: false + partition_assignor: org.apache.kafka.clients.consumer.RoundRobinAssignor + state: STABLE + type: CLASSIC + is_mixed_consumer_group: false + coordinator: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + consumers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers + lag_summary: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary + ListConsumersResponse: + description: The list of consumers. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerDataList' + example: + kind: KafkaConsumerList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers + next: null + data: + - kind: KafkaConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-1 + instance_id: consumer-instance-1 + client_id: client-1 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1/assignments + - kind: KafkaConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-2 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-2 + instance_id: consumer-instance-2 + client_id: client-2 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2/assignments + - kind: KafkaConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-2 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-2 + instance_id: consumer-instance-2 + client_id: client-2 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2/assignments + GetConsumerGroupLagSummaryResponse: + description: The max and total consumer lag in a consumer group. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerGroupLagSummaryData' + example: + kind: KafkaConsumerGroupLagSummary + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary + resource_name: crn:///kafka=cluster-1/consumer-groups=consumer-group-1/lag-summary + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + max_lag_consumer_id: consumer-1 + max_lag_instance_id: consumer-instance-1 + max_lag_client_id: client-1 + max_lag_topic_name: topic-1 + max_lag_partition_id: 1 + max_lag: 100 + total_lag: 110 + max_lag_consumer: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1 + max_lag_partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + ListConsumerLagsResponse: + description: The list of consumer lags. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerLagDataList' + example: + kind: KafkaConsumerLagList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags + next: null + data: + - kind: KafkaConsumerLag + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + topic_name: topic-1 + partition_id: 1 + consumer_id: consumer-1 + instance_id: consumer-instance-1 + client_id: client-1 + current_offset: 1 + log_end_offset: 101 + lag: 100 + - kind: KafkaConsumerLag + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/2 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=2 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + topic_name: topic-1 + partition_id: 2 + consumer_id: consumer-2 + instance_id: consumer-instance-2 + client_id: client-2 + current_offset: 1 + log_end_offset: 11 + lag: 10 + - kind: KafkaConsumerLag + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/3 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=3 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + topic_name: topic-1 + partition_id: 3 + consumer_id: consumer-3 + instance_id: consumer-instance-3 + client_id: client-3 + current_offset: 1 + log_end_offset: 1 + lag: 0 + GetConsumerLagResponse: + description: The consumer lag. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerLagData' + example: + kind: KafkaConsumerLag + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + topic_name: topic-1 + partition_id: 1 + consumer_id: consumer-1 + instance_id: consumer-instance-1 + client_id: client-1 + current_offset: 1 + log_end_offset: 101 + lag: 100 + GetConsumerResponse: + description: The consumer. + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerData' + example: + kind: KafkaConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1 + resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-1 + cluster_id: cluster-1 + consumer_group_id: consumer-group-1 + consumer_id: consumer-1 + instance_id: consumer-instance-1 + client_id: client-1 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1/assignments + ListTopicsResponse: + description: The list of topics. + content: + application/json: + schema: + $ref: '#/components/schemas/TopicDataList' + example: + kind: KafkaTopicList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics + next: null + data: + - kind: KafkaTopic + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1 + resource_name: crn:///kafka=cluster-1/topic=topic-1 + cluster_id: cluster-1 + topic_name: topic-1 + is_internal: false + replication_factor: 3 + partitions_count: 1 + partitions: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions + configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs + partition_reassignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/-/reassignments + - kind: KafkaTopic + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2 + resource_name: crn:///kafka=cluster-1/topic=topic-2 + cluster_id: cluster-1 + topic_name: topic-2 + is_internal: true + replication_factor: 4 + partitions_count: 1 + partitions: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions + configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/configs + partition_reassignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions/-/reassignments + - kind: KafkaTopic + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3 + resource_name: crn:///kafka=cluster-1/topic=topic-3 + cluster_id: cluster-1 + topic_name: topic-3 + is_internal: false + replication_factor: 5 + partitions_count: 1 + partitions: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions + configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/configs + partition_reassignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions/-/reassignments + CreateTopicResponse: + description: The created topic. + content: + application/json: + schema: + $ref: '#/components/schemas/TopicData' + example: + kind: KafkaTopic + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X + resource_name: crn:///kafka=cluster-1/topic=topic-X + cluster_id: cluster-1 + topic_name: topic-X + is_internal: false + replication_factor: 3 + partitions_count: 1 + partitions: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X/partitions + configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X/configs + partition_reassignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X/partitions/-/reassignments + BadRequestErrorResponse_CreateTopic: + description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + create_topic_already_exists: + description: Thrown when trying to create a topic with a name already used by an existing topic. + value: + error_code: 40002 + message: Topic 'my-topic' already exists. + create_topic_replication_factor_too_large: + description: Thrown when trying to create a topic with a replication factor larger than the number of brokers. + value: + error_code: 40002 + message: 'Replication factor: 2 larger than available brokers: 1.' + GetTopicResponse: + description: The topic. + content: + application/json: + schema: + $ref: '#/components/schemas/TopicData' + example: + kind: KafkaTopic + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1 + resource_name: crn:///kafka=cluster-1/topic=topic-1 + cluster_id: cluster-1 + topic_name: topic-1 + is_internal: false + replication_factor: 3 + partitions_count: 1 + partitions: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions + configs: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs + partition_reassignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/-/reassignments + NotFoundErrorResponse: + description: Indicates attempted access to an unreachable or non-existing resource like e.g. an unknown topic or partition. GET requests to endpoints not allowed in the accesslists will also result in this response. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + endpoint_not_found: + description: Thrown for generic HTTP 404 errors. + value: + error_code: 404 + message: HTTP 404 Not Found + cluster_not_found: + description: Thrown when using a non-existing cluster ID. + value: + error_code: 404 + message: Cluster my-cluster cannot be found. + unknown_topic_or_partition: + description: Thrown when using a non-existing topic name or partition ID. + value: + error_code: 40403 + message: This server does not host this topic-partition. + BadRequestErrorResponse_UpdatePartitionCountTopic: + description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + topic_update_partitions_invalid: + description: Thrown when trying to update the number of partitions incorrectly. + value: + error_code: 40002 + message: Topic already has 1 partitions. + ListTopicConfigsResponse: + description: The list of cluster configs. + content: + application/json: + schema: + $ref: '#/components/schemas/TopicConfigDataList' + example: + kind: KafkaTopicConfigList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs + next: null + data: + - kind: KafkaTopicConfig + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/cleanup.policy + resource_name: crn:///kafka=cluster-1/topic=topic-1/config=cleanup.policy + cluster_id: cluster-1 + topic_name: topic-1 + name: cleanup.policy + value: compact + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_TOPIC_CONFIG + synonyms: + - name: cleanup.policy + value: compact + source: DYNAMIC_TOPIC_CONFIG + - name: cleanup.policy + value: delete + source: DEFAULT_CONFIG + - kind: KafkaTopicConfig + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type + resource_name: crn:///kafka=cluster-1/topic=topic-1/config=compression.type + cluster_id: cluster-1 + topic_name: topic-1 + name: compression.type + value: gzip + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_TOPIC_CONFIG + synonyms: + - name: compression.type + value: gzip + source: DYNAMIC_TOPIC_CONFIG + - name: compression.type + value: producer + source: DEFAULT_CONFIG + GetTopicConfigResponse: + description: The topic configuration parameter. + content: + application/json: + schema: + $ref: '#/components/schemas/TopicConfigData' + example: + kind: KafkaTopicConfig + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/compression.type + resource_name: crn:///kafka=cluster-1/topic=topic-1/config=compression.type + cluster_id: cluster-1 + topic_name: topic-1 + name: compression.type + value: gzip + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_TOPIC_CONFIG + synonyms: + - name: compression.type + value: gzip + source: DYNAMIC_TOPIC_CONFIG + - name: compression.type + value: producer + source: DEFAULT_CONFIG + ListPartitionsResponse: + description: The list of partitions. + content: + application/json: + schema: + $ref: '#/components/schemas/PartitionDataList' + example: + kind: KafkaPartitionList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions + next: null + data: + - kind: KafkaPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=1 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + leader: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas/1 + replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas + reassignment: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/reassignment + - kind: KafkaPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=2 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 2 + leader: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/replicas/2 + replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/replicas + reassignment: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/reassignment + - kind: KafkaPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=3 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 3 + leader: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/replicas/3 + replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/replicas + reassignment: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/reassignment + GetPartitionResponse: + description: The partition + content: + application/json: + schema: + $ref: '#/components/schemas/PartitionData' + example: + kind: KafkaPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=1 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + leader: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas/1 + replicas: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas + reassignment: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/reassignment + ProduceResponse: + description: |- + The response containing a delivery report for a record produced to a topic. In streaming mode, + for each record sent, a separate delivery report will be returned, in the same order, + each with its own error_code. + content: + application/json: + schema: + $ref: '#/components/schemas/ProduceResponse' + examples: + produce_record_success: + description: The record was successfully produced to the topic. + value: + error_code: 200 + cluster_id: cluster-1 + topic_name: topic-1 + partition_id: 1 + offset: 0 + timestamp: '2021-02-05T19:14:42Z' + key: + type: BINARY + size: 7 + value: + type: JSON + size: 15 + produce_record_bad_binary_data: + description: Thrown when sending a BINARY value which is not a base64-encoded string. + value: + error_code: 400 + message: 'Bad Request: data=1 is not a base64 string.' + BadRequestErrorResponse_ProduceRecords: + description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + header_not_base64_encoded: + description: Thrown when headers in the produce-record are not base64 encoded. + value: + error_code: 400 + message: 'Cannot deserialize value of type `byte[]` from String "": Unexpected end of base64-encoded String: base64 variant ''MIME-NO-LINEFEEDS'' expects padding (one or more ''='' characters) at the end. This Base64Variant might have been incorrectly configured' + RequestEntityTooLargeErrorResponse: + description: This implies the client is sending a request payload that is larger than the maximum message size the server can accept. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + produce_records_expects_json: + description: Thrown by /records API if payload size exceeds the message max size + value: + error_code: 413 + message: The request included a message larger than the maximum message size the server can accept. + UnsupportedMediaTypeErrorResponse: + description: This implies the client is sending the request payload format in an unsupported format. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + produce_records_expects_json: + description: Thrown by /records API if payload format content-type doesn't match expected application/json + value: + error_code: 415 + message: HTTP 415 Unsupported Media Type + UnprocessableEntity_ProduceRecord: + description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + produce_record_empty_request_body: + description: Thrown when the request body is empty. + value: + error_code: 422 + message: Payload error. Request body is empty. Data is required. + ListLinksResponse: + description: A list of link names and properties + content: + application/json: + schema: + $ref: '#/components/schemas/ListLinksResponseDataList' + example: + kind: KafkaLinkDataList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links + next: null + data: + - kind: KafkaLinkData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/CIL-69l7S1CwoVNAhoQLug/links/my-new-link-1 + resource_name: null + source_cluster_id: src-cluster-id + link_name: my-new-link-1 + link_id: 7840644d-f7d8-4844-a577-a10ef3df31df + cluster_link_id: eEBkTffYSESld6EO898x3w + topic_names: + - topic-sb-1 + - topic-sb-2 + link_state: ACTIVE + - kind: KafkaLinkData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/CIL-69l7S1CwoVNAhoQLug/links/my-new-link-2 + resource_name: null + remote_cluster_id: src-cluster-id + link_name: my-new-link-2 + link_id: f749116e-f847-4bd2-b1f6-5c4e518a0678 + cluster_link_id: 90kRbvhHS9Kx9lxOUYoGeA + topic_names: + - topic-db-1 + - topic-db-2 + link_state: UNAVAILABLE + link_error: AUTHENTICATION_ERROR + link_error_message: Please check your api key and secret + - kind: KafkaLinkData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/CIL-69l7S1CwoVNAhoQLug/links/my-new-link-3 + resource_name: null + destination_cluster_id: dest-cluster-id + link_name: my-new-link-3 + link_id: 9cd1711e-a4ef-4390-a35e-dfd758d97a82 + cluster_link_id: nNFxHqTvQ5CjXt_XWNl6gg + topic_names: [] + link_state: ACTIVE + NoContentResponse: + description: Operation succeeded, no content in the response + GetLinkResponse: + description: Single link name and properties + content: + application/json: + schema: + $ref: '#/components/schemas/ListLinksResponseData' + examples: + link_at_destination_cluster: + description: Link at destination cluster + value: + kind: KafkaLinkData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/my-new-link-1 + resource_name: null + source_cluster_id: src-cluster-id + link_name: my-new-link-1 + link_id: 7840644d-f7d8-4844-a577-a10ef3df31df + cluster_link_id: eEBkTffYSESld6EO898x3w + topic_names: + - topic-db-1 + - topic-db-2 + link_at_source_cluster: + description: Link at source cluster + value: + kind: KafkaLinkData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/my-new-link-1 + resource_name: null + destination_cluster_id: dst-cluster-id + link_name: my-new-link-1 + link_id: 7840644d-f7d8-4844-a577-a10ef3df31df + cluster_link_id: eEBkTffYSESld6EO898x3w + topic_names: [] + ListLinkConfigsResponse: + description: Config name and value + content: + application/json: + schema: + $ref: '#/components/schemas/ListLinkConfigsResponseDataList' + example: + kind: KafkaLinkConfigDataList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/v-0Ce-CkTyKQol9v46LaCQ/links/link-nb-1/configs + next: null + data: + - kind: KafkaLinkConfigData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/links/my-new-link-1 + resource_name: null + cluster_id: 1Rh_4htxSuen7RYGvGmgNw + name: consumer.offset.sync.ms + value: '3825940' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_CLUSTER_LINK_CONFIG + synonyms: + - cosm + link_name: link-db-1 + - kind: KafkaLinkConfigData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/links/my-new-link-1 + resource_name: null + cluster_id: 1Rh_4htxSuen7RYGvGmgNw + name: acl.sync.ms + value: '5000' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_CLUSTER_LINK_CONFIG + synonyms: + - asm + link_name: link-db-1 + GetLinkConfigsResponse: + description: Config name and value + content: + application/json: + schema: + $ref: '#/components/schemas/ListLinkConfigsResponseData' + example: + kind: KafkaLinkConfigData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/links/my-new-link-1 + resource_name: null + cluster_id: 1Rh_4htxSuen7RYGvGmgNw + name: consumer.offset.sync.ms + value: '3825940' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_CLUSTER_LINK_CONFIG + synonyms: + - cosm + link_name: link-db-1 + ListMirrorTopicsResponse: + description: Metadata of mirror topics + content: + application/json: + schema: + $ref: '#/components/schemas/ListMirrorTopicsResponseDataList' + example: + kind: KafkaMirrorDataList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/link/link-1/mirrors + resource_name: crn:///kafka=cluster-1 + next: null + data: + - kind: KafkaMirrorData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/link-1/mirrors/topic-1 + resource_name: crn:///kafka=cluster-1 + link_name: link-sb-1 + resource_name: crn:///kafka=cluster-1 + mirror_topic_name: topic-1 + source_topic_name: topic-1 + num_partitions: 3 + mirror_lags: + - partition: 0 + lag: 0 + last_source_fetch_offset: 0 + - partition: 1 + lag: 10000 + last_source_fetch_offset: 1000 + - partition: 2 + lag: 40000 + last_source_fetch_offset: 12030 + mirror_status: ACTIVE + state_time_ms: 1612550939300 + - kind: KafkaMirrorData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/link-1/mirrors/topic-2 + resource_name: crn:///kafka=cluster-1 + link_name: link-sb-2 + resource_name: crn:///kafka=cluster-1 + mirror_topic_name: topic-2 + source_topic_name: topic-2 + num_partitions: 3 + mirror_lags: + - partition: 0 + lag: 0 + last_source_fetch_offset: 0 + - partition: 1 + lag: 10000 + last_source_fetch_offset: 1000 + - partition: 2 + lag: 40000 + last_source_fetch_offset: 12030 + mirror_status: STOPPED + state_time_ms: 1612551353640 + DescribeMirrorTopicResponse: + description: Metadata of the mirror topic + content: + application/json: + schema: + $ref: '#/components/schemas/ListMirrorTopicsResponseData' + example: + kind: KafkaMirrorData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/link/link-1/mirrors/topic-1 + resource_name: crn:///kafka=cluster-1 + link_name: link-sb-1 + mirror_topic_name: topic-1 + source_topic_name: topic-1 + num_partitions: 3 + mirror_lags: + - partition: 0 + lag: 0 + last_source_fetch_offset: 0 + - partition: 1 + lag: 10000 + last_source_fetch_offset: 1000 + - partition: 2 + lag: 40000 + last_source_fetch_offset: 12030 + mirror_status: ACTIVE + state_time_ms: 1612550939300 + AlterMirrorStatusResponse: + description: Mirror status alternation result + content: + application/json: + schema: + $ref: '#/components/schemas/AlterMirrorStatusResponseDataList' + example: + kind: KafkaPromoteMirror + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-1/mirrors + resource_name: crn:///kafka=cluster-1 + data: + - kind: AlterMirrorsData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/my-new-link-1/mirrors/topic-1 + resource: crn:///kafka=cluster-1 + mirror_topic_name: topic-sb + error_code: null + error_message: null + mirror_lags: + - partition: 0 + lag: 0 + last_source_fetch_offset: 0 + - partition: 1 + lag: 10000 + last_source_fetch_offset: 1000 + - partition: 2 + lag: 40000 + last_source_fetch_offset: 12030 + messages_truncated: null + partition_level_truncation_data: + - partition_id: 0 + offset_truncated_to: 10000 + messages_truncated: 10000 + - partition_id: 1 + offset_truncated_to: 40000 + messages_truncated: 12030 + - partition_id: 2 + offset_truncated_to: 20000 + messages_truncated: 20000 + - kind: AlterMirrorsData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/my-new-link-1/mirrors/topic-2 + resource: crn:///kafka=cluster-1 + mirror_topic_name: topic-2 + error_code: 400 + error_message: Topic 'topic-2' has already stopped its mirror from 'my-new-link-1' + mirror_lags: + - partition: 0 + lag: 0 + last_source_fetch_offset: 0 + - partition: 1 + lag: 10000 + last_source_fetch_offset: 1000 + - partition: 2 + lag: 40000 + last_source_fetch_offset: 12030 + messages_truncated: null + partition_level_truncation_data: + - partition_id: 0 + offset_truncated_to: 10000 + messages_truncated: 10000 + - partition_id: 1 + offset_truncated_to: 40000 + messages_truncated: 12030 + - partition_id: 2 + offset_truncated_to: 20000 + messages_truncated: 20000 + ListGroupConfigsResponse: + description: Config name and value for group configurations. + content: + application/json: + schema: + $ref: '#/components/schemas/GroupConfigDataList' + example: + kind: KafkaGroupConfigDataList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs + next: null + data: + - kind: KafkaGroupConfigData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs/share.session.timeout.ms + resource_name: crn:///kafka=cluster-1/group=group-1/config=share.session.timeout.ms + cluster_id: cluster-1 + group_id: group-1 + name: share.session.timeout.ms + value: '45000' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_GROUP_CONFIG + synonyms: + - name: share.session.timeout.ms + value: '45000' + source: DYNAMIC_GROUP_CONFIG + - name: share.session.timeout.ms + value: '30000' + source: DEFAULT_CONFIG + - kind: KafkaGroupConfigData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs/share.heartbeat.interval.ms + resource_name: crn:///kafka=cluster-1/group=group-1/config=share.heartbeat.interval.ms + cluster_id: cluster-1 + group_id: group-1 + name: share.heartbeat.interval.ms + value: null + is_default: true + is_read_only: false + is_sensitive: false + source: DEFAULT_CONFIG + synonyms: + - name: share.heartbeat.interval.ms + value: '3000' + source: DEFAULT_CONFIG + GetGroupConfigResponse: + description: Config name and value for group configuration. + content: + application/json: + schema: + $ref: '#/components/schemas/GroupConfigData' + example: + kind: KafkaGroupConfigData + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs/share.session.timeout.ms + resource_name: crn:///kafka=cluster-1/group=group-1/config=share.session.timeout.ms + cluster_id: cluster-1 + group_id: group-1 + name: share.session.timeout.ms + value: '45000' + is_default: false + is_read_only: false + is_sensitive: false + source: DYNAMIC_GROUP_CONFIG + synonyms: + - name: share.session.timeout.ms + value: '45000' + source: DYNAMIC_GROUP_CONFIG + - name: share.session.timeout.ms + value: '30000' + source: DEFAULT_CONFIG + parameters: + ClusterId: + name: cluster_id + description: The Kafka cluster ID. + in: path + required: true + schema: + type: string + example: cluster-1 + AclResourceType: + name: resource_type + description: The ACL resource type. + in: query + required: false + schema: + $ref: '#/components/schemas/AclResourceType' + AclResourceName: + name: resource_name + description: The ACL resource name. + in: query + required: false + schema: + type: string + AclPatternType: + name: pattern_type + description: The ACL pattern type. + in: query + required: false + schema: + $ref: '#/components/schemas/AclPatternType' + AclPrincipal: + name: principal + description: |- + The ACL principal. This is the Service Account name or user name. + Supports both legacy `User:` format (numeric IDs) and new `UserV2:` + format (sa-xxx format) for service accounts. Use `UserV2:*` to + retrieve service accounts in the new format. + in: query + required: false + schema: + type: string + AclHost: + name: host + description: The ACL host. + in: query + required: false + schema: + type: string + AclOperation: + name: operation + description: The ACL operation. + in: query + required: false + schema: + $ref: '#/components/schemas/AclOperation' + AclPermission: + name: permission + description: The ACL permission. + in: query + required: false + schema: + $ref: '#/components/schemas/AclPermission' + AclResourceTypeRequired: + name: resource_type + description: The ACL resource type. + in: query + required: true + schema: + $ref: '#/components/schemas/AclResourceType' + AclPatternTypeRequired: + name: pattern_type + description: The ACL pattern type. + in: query + required: true + schema: + $ref: '#/components/schemas/AclPatternType' + AclOperationRequired: + name: operation + description: The ACL operation. + in: query + required: true + schema: + $ref: '#/components/schemas/AclOperation' + AclPermissionRequired: + name: permission + description: The ACL permission. + in: query + required: true + schema: + $ref: '#/components/schemas/AclPermission' + ConfigName: + name: name + description: The configuration parameter name. + in: path + required: true + schema: + type: string + example: compression.type + ConsumerGroupId: + name: consumer_group_id + description: The consumer group ID. + in: path + required: true + schema: + type: string + example: consumer-group-1 + TopicName: + name: topic_name + description: The topic name. + in: path + required: true + schema: + type: string + example: topic-1 + PartitionId: + name: partition_id + description: The partition ID. + in: path + required: true + schema: + type: integer + example: 0 + ConsumerId: + name: consumer_id + description: The consumer ID. + in: path + required: true + schema: + type: string + example: consumer-1 + IncludeAuthorizedOperations: + name: include_authorized_operations + description: Specify if authorized operations should be included in the response. + in: query + required: false + schema: + type: boolean + QueryParamLinkName: + name: link_name + description: The link name + in: query + required: true + schema: + type: string + example: link-sb1 + ValidateOnly: + name: validate_only + description: 'To validate the action can be performed successfully or not. Default: false' + in: query + required: false + schema: + type: boolean + example: false + ValidateLink: + name: validate_link + description: 'To synchronously validate that the source cluster ID is expected and the dest cluster has the permission to read topics in the source cluster. Default: true' + in: query + required: false + schema: + type: boolean + example: false + LinkName: + name: link_name + description: The link name + in: path + required: true + schema: + type: string + example: link-sb1 + IncludeTasks: + name: include_tasks + description: 'Whether to include cluster linking tasks in the response. Default: false' + in: query + required: false + schema: + type: boolean + example: false + Force: + name: force + description: 'Force the action. Default: false' + in: query + required: false + schema: + type: boolean + example: false + LinkConfigName: + name: config_name + description: The link config name + in: path + required: true + schema: + type: string + example: consumer.offset.sync.enable + MirrorTopicStatus: + name: mirror_status + description: The status of the mirror topic. If not specified, all mirror topics will be returned. + in: query + required: false + schema: + $ref: '#/components/schemas/MirrorTopicStatus' + example: ACTIVE + MirrorTopicName: + name: mirror_topic_name + description: Cluster Linking mirror topic name + in: path + required: true + schema: + type: string + example: topic-1 + IncludeStateTransitionErrors: + name: include_state_transition_errors + description: 'Whether to include mirror state transition errors in the response. Default: false' + in: query + required: false + schema: + type: boolean + example: false + IncludePartitionLevelTruncationData: + name: include_partition_level_truncation_data + description: 'Whether to include partition level truncation information when truncating and restoring a topic in the response. Default: false' + in: query + required: false + schema: + type: boolean + example: false + GroupId: + name: group_id + description: The group ID. + in: path + required: true + schema: + type: string + example: group-1 + requestBodies: + BatchCreateAclRequest: + description: The batch ACL creation request. + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAclRequestDataList' + example: + data: + - resource_type: CLUSTER + resource_name: kafka-cluster + pattern_type: LITERAL + principal: principalType:principalName + host: '*' + operation: DESCRIBE + permission: DENY + - resource_type: TOPIC + resource_name: kafka-cluster + pattern_type: LITERAL + principal: principalType:principalName + host: '*' + operation: READ + permission: ALLOW + CreateAclRequest: + description: The ACL creation request. + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAclRequestData' + example: + resource_type: CLUSTER + resource_name: kafka-cluster + pattern_type: LITERAL + principal: principalType:principalName + host: '*' + operation: DESCRIBE + permission: DENY + AlterClusterConfigBatchRequest: + description: The alter cluster configuration parameter batch request. + content: + application/json: + schema: + $ref: '#/components/schemas/AlterConfigBatchRequestData' + example: + data: + - name: max.connections + operation: DELETE + - name: compression.type + value: gzip + UpdateClusterConfigRequest: + description: The cluster configuration parameter update request. + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateConfigRequestData' + example: + value: gzip + CreateTopicRequest: + description: The topic creation request. Note that Confluent Cloud allows only specific replication factor values. Because of that the replication factor field should either be omitted or it should use one of the allowed values (see https://docs.confluent.io/cloud/current/client-apps/optimizing/durability.html). + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTopicRequestData' + examples: + uniform_replication: + value: + topic_name: topic-X + partitions_count: 64 + replication_factor: 3 + configs: + - name: cleanup.policy + value: compact + - name: compression.type + value: gzip + dry_run_create_topic: + value: + topic_name: topic-X + partitions_count: 64 + replication_factor: 3 + validate_only: true + AlterTopicConfigBatchRequest: + description: The alter topic configuration parameter batch request. + content: + application/json: + schema: + $ref: '#/components/schemas/AlterConfigBatchRequestData' + examples: + batch_alter_topic_configs: + value: + data: + - name: cleanup.policy + operation: DELETE + - name: compression.type + value: gzip + validate_only_batch_alter_topic_configs: + value: + data: + - name: cleanup.policy + operation: DELETE + - name: compression.type + value: gzip + validate_only: true + UpdateTopicConfigRequest: + description: The topic configuration parameter update request. + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateConfigRequestData' + example: + value: gzip + ProduceRequest: + description: A single record to be produced to Kafka. To produce multiple records in the same request, simply concatenate the records. The delivery reports are concatenated in the same order as the records are sent. + content: + application/json: + schema: + $ref: '#/components/schemas/ProduceRequest' + examples: + binary_and_json: + description: If using type, one of "BINARY", "JSON" or "STRING" is required. + value: + partition_id: 1 + headers: + - name: Header-1 + value: SGVhZGVyLTE= + - name: Header-2 + value: SGVhZGVyLTI= + key: + type: BINARY + data: Zm9vYmFy + value: + type: JSON + data: + foo: bar + timestamp: '2021-02-05T19:14:42Z' + string: + description: If using type, one of "BINARY", "JSON" or "STRING" is required. + value: + value: + type: STRING + data: My message + empty_value: + description: key or value can be omitted entirely. + value: + key: + data: 1000 + CreateLinkRequest: + description: Create a cluster link + content: + application/json: + schema: + $ref: '#/components/schemas/CreateLinkRequestData' + examples: + destination_initiated_link: + description: Create a destination initiated cluster link + value: + source_cluster_id: cluster-1 + configs: + - name: bootstrap.servers + value: cluster-1-bootstrap-server + - name: acl.sync.enable + value: 'false' + - name: consumer.offset.sync.ms + value: '30000' + - name: sasl.mechanism + value: PLAIN + - name: security.protocol + value: SASL_SSL + - name: sasl.jaas.config + value: sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username='' password=''; + source_initiated_link_at_source_cluster: + description: Create a source initiated cluster link at source cluster + value: + destination_cluster_id: cluster-2 + configs: + - name: bootstrap.servers + value: cluster-2-bootstrap-server + - name: link.mode + value: SOURCE + - name: sasl.mechanism + value: PLAIN + - name: security.protocol + value: SASL_SSL + - name: sasl.jaas.config + value: sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username='' password=''; + - name: local.sasl.mechanism + value: PLAIN + - name: local.security.protocol + value: SASL_SSL + - name: local.sasl.jaas.config + value: sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username='' password=''; + source_initiated_link_at_destination_cluster: + description: Create a source initiated cluster link at destination cluster + value: + destination_cluster_id: cluster-1 + configs: + - name: link.mode + value: DESTINATION + - name: connection.mode + value: INBOUND + - name: acl.sync.enable + value: 'false' + bidirectional_link_east: + description: Create a bidirectional cluster link in east + value: + remote_cluster_id: cluster-west + configs: + - name: bootstrap.servers + value: cluster-west-bootstrap-server + - name: link.mode + value: BIDIRECTIONAL + - name: cluster.link.prefix + value: west. + - name: sasl.mechanism + value: PLAIN + - name: security.protocol + value: SASL_SSL + - name: sasl.jaas.config + value: sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username='' password=''; + bidirectional_link_west: + description: Create a bidirectional cluster link in west + value: + remote_cluster_id: cluster-east + cluster_link_id: eEBkTffYSESld6EO898x3w + configs: + - name: bootstrap.servers + value: cluster-east-bootstrap-server + - name: link.mode + value: BIDIRECTIONAL + - name: cluster.link.prefix + value: east. + - name: sasl.mechanism + value: PLAIN + - name: security.protocol + value: SASL_SSL + - name: sasl.jaas.config + value: sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username='' password=''; + UpdateLinkConfigRequest: + content: + application/json: + example: + value: '300000' + schema: + $ref: '#/components/schemas/UpdateLinkConfigRequestData' + description: Link config value to update + AlterLinkConfigBatchRequest: + content: + application/json: + example: + data: + - name: cleanup.policy + operation: DELETE + - name: compression.type + value: gzip + schema: + $ref: '#/components/schemas/AlterConfigBatchRequestData' + CreateMirrorTopicRequest: + description: Name and configs of the topics mirroring from and mirroring to. Note that Confluent Cloud allows only specific replication factor values. Because of that the replication factor field should either be omitted or it should use one of the allowed values (see https://docs.confluent.io/cloud/current/client-apps/optimizing/durability.html). + content: + application/json: + schema: + $ref: '#/components/schemas/CreateMirrorTopicRequestData' + examples: + generic_example: + description: Generic example of creating a mirror topic + value: + source_topic_name: topic-1 + configs: + - name: unclean.leader.election.enable + value: 'true' + replication_factor: 1 + example_with_mirror_topic_name: + description: Example using optional mirror_topic_name flag + value: + source_topic_name: topic-1 + mirror_topic_name: link1_topic-1 + configs: + - name: unclean.leader.election.enable + value: 'true' + replication_factor: 3 + AlterMirrorsRequest: + description: Mirror topics to be altered. + content: + application/json: + schema: + $ref: '#/components/schemas/AlterMirrorsRequestData' + examples: + mirror_topic_names: + description: Example using mirror topic names + value: + mirror_topic_names: + - topic-1 + - topic-2 + mirror_topic_name_pattern: + description: Example using mirror topic name pattern + value: + mirror_topic_name_pattern: .* + UpdateGroupConfigRequest: + content: + application/json: + example: + value: '45000' + schema: + $ref: '#/components/schemas/UpdateGroupConfigRequestData' + description: Group config value to update + AlterGroupConfigBatchRequest: + content: + application/json: + example: + data: + - name: share.session.timeout.ms + operation: DELETE + - name: share.heartbeat.interval.ms + value: '5000' + schema: + $ref: '#/components/schemas/AlterConfigBatchRequestData' +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/ksqldb_clusters.yaml b/provider-dev/source/ksqldb_clusters.yaml new file mode 100644 index 0000000..5340eab --- /dev/null +++ b/provider-dev/source/ksqldb_clusters.yaml @@ -0,0 +1,1736 @@ +openapi: 3.0.0 +info: + title: ksqldb_clusters API + description: confluent ksqldb_clusters API + version: 1.0.0 +paths: + /ksqldbcm/v2/clusters: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listKsqldbcmV2Clusters + summary: List of Clusters + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Clusters (ksqldbcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: |- + `Cluster` represents a ksqlDB runtime that you can issue queries to using its API endpoint. + It executes SQL statements and queries which under the hood get built into corresponding + Kafka Streams topologies. The API allows you to list, create, read, and delete your ksqlDB clusters. + + + Related guide: [ksqlDB in Confluent Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the following quotas: + + | Quota | Description | + | --- | --- | + | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent Cloud Kafka Cluster. | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Cluster` represents a ksqlDB runtime that you can issue queries to using its API endpoint. + It executes SQL statements and queries which under the hood get built into corresponding + Kafka Streams topologies. The API allows you to list, create, read, and delete your ksqlDB clusters. + + + Related guide: [ksqlDB in Confluent Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the following quotas: + + | Quota | Description | + | --- | --- | + | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent Cloud Kafka Cluster. | + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createKsqldbcmV2Cluster + summary: Create a Cluster + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a cluster. + tags: + - Clusters (ksqldbcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Cluster` represents a ksqlDB runtime that you can issue queries to using its API endpoint. + It executes SQL statements and queries which under the hood get built into corresponding + Kafka Streams topologies. The API allows you to list, create, read, and delete your ksqlDB clusters. + + + Related guide: [ksqlDB in Confluent Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the following quotas: + + | Quota | Description | + | --- | --- | + | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent Cloud Kafka Cluster. | + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterStatus' + required: + - spec + responses: + '202': + description: A Cluster is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/ksqldbcm/v2/clusters/{id} + description: Cluster resource uri + content: + application/json: + schema: + type: object + description: |- + `Cluster` represents a ksqlDB runtime that you can issue queries to using its API endpoint. + It executes SQL statements and queries which under the hood get built into corresponding + Kafka Streams topologies. The API allows you to list, create, read, and delete your ksqlDB clusters. + + + Related guide: [ksqlDB in Confluent Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the following quotas: + + | Quota | Description | + | --- | --- | + | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent Cloud Kafka Cluster. | + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /ksqldbcm/v2/clusters/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getKsqldbcmV2Cluster + summary: Read a Cluster + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (ksqldbcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: |- + `Cluster` represents a ksqlDB runtime that you can issue queries to using its API endpoint. + It executes SQL statements and queries which under the hood get built into corresponding + Kafka Streams topologies. The API allows you to list, create, read, and delete your ksqlDB clusters. + + + Related guide: [ksqlDB in Confluent Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the following quotas: + + | Quota | Description | + | --- | --- | + | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent Cloud Kafka Cluster. | + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteKsqldbcmV2Cluster + summary: Delete a Cluster + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (ksqldbcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Cluster is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + ksqldbcm.v2.ClusterList: + type: object + description: |- + `Cluster` represents a ksqlDB runtime that you can issue queries to using its API endpoint. + It executes SQL statements and queries which under the hood get built into corresponding + Kafka Streams topologies. The API allows you to list, create, read, and delete your ksqlDB clusters. + + + Related guide: [ksqlDB in Confluent Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the following quotas: + + | Quota | Description | + | --- | --- | + | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent Cloud Kafka Cluster. | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Cluster` represents a ksqlDB runtime that you can issue queries to using its API endpoint. + It executes SQL statements and queries which under the hood get built into corresponding + Kafka Streams topologies. The API allows you to list, create, read, and delete your ksqlDB clusters. + + + Related guide: [ksqlDB in Confluent Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the following quotas: + + | Quota | Description | + | --- | --- | + | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent Cloud Kafka Cluster. | + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + ksqldbcm.v2.Cluster: + type: object + description: |- + `Cluster` represents a ksqlDB runtime that you can issue queries to using its API endpoint. + It executes SQL statements and queries which under the hood get built into corresponding + Kafka Streams topologies. The API allows you to list, create, read, and delete your ksqlDB clusters. + + + Related guide: [ksqlDB in Confluent Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the following quotas: + + | Quota | Description | + | --- | --- | + | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent Cloud Kafka Cluster. | + properties: + api_version: + type: string + enum: + - ksqldbcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/ksqldbcm.v2.ClusterStatus' + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + ksqldbcm.v2.ClusterSpec: + type: object + description: The desired state of the Cluster + properties: + display_name: + type: string + example: ksqlDB_cluster_0 + description: The name of the ksqlDB cluster. + pattern: ^(?:[0-9A-Za-z\-])[\w-]{0,63}$ + x-immutable: true + use_detailed_processing_log: + type: boolean + default: true + description: | + This flag controls whether you want to include the row data in the processing log topic. Turn it off if you + don't want to emit sensitive information to the processing log + x-immutable: true + csu: + type: integer + format: int32 + example: 4 + x-extensible-enum: + - 1 + - 2 + - 4 + - 8 + - 12 + description: The number of CSUs (Confluent Streaming Units) in a ksqlDB cluster. + x-immutable: false + kafka_cluster: + description: The kafka_cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + credential_identity: + description: The credential_identity to which this belongs. The credential_identity can be one of iam.v2.User, iam.v2.ServiceAccount. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + ksqldbcm.v2.ClusterStatus: + type: object + required: + - phase + - is_paused + - storage + description: The status of the Cluster + properties: + http_endpoint: + type: string + description: The dataplane endpoint of the ksqlDB cluster. + example: https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud + readOnly: true + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PROVISIONED + - FAILED + description: Status of the ksqlDB cluster. + example: PROVISIONING + readOnly: true + is_paused: + type: boolean + description: Tells you if the cluster has been paused + readOnly: true + storage: + type: integer + format: int32 + example: 125 + description: Amount of storage (in GB) provisioned to this cluster + readOnly: true + topic_prefix: + type: string + description: Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use. + example: pksqlc-00000 + readOnly: true + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + EnvScopedObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + TypedGlobalObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + GlobalObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + OverQuotaError: + x-summary: Over Quota + description: The request would exceed one or more quotas. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '402' + code: quota_exceeded + title: Kafka Clusters Per Org Quota Exceeded + detail: 'The request would exceed the quota: kafka_clusters_per_environment' + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/managed_kafka_clusters.yaml b/provider-dev/source/managed_kafka_clusters.yaml new file mode 100644 index 0000000..ba0ae1c --- /dev/null +++ b/provider-dev/source/managed_kafka_clusters.yaml @@ -0,0 +1,2270 @@ +openapi: 3.0.0 +info: + title: managed_kafka_clusters API + description: confluent managed_kafka_clusters API + version: 1.0.0 +paths: + /cmk/v2/clusters: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCmkV2Clusters + summary: List of Clusters + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - n-00000 + - n-00001 + description: Filter the results by exact match for spec.network. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Clusters (cmk/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: |- + `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Kafka clusters. + + + Related guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cmk/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Kafka clusters. + + + Related guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createCmkV2Cluster + summary: Create a Cluster + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a cluster. + tags: + - Clusters (cmk/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Kafka clusters. + + + Related guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + required: + - spec + responses: + '202': + description: A Cluster is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/cmk/v2/clusters/{id} + description: Cluster resource uri + content: + application/json: + schema: + type: object + description: |- + `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Kafka clusters. + + + Related guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cmk/v2/clusters/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCmkV2Cluster + summary: Read a Cluster + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (cmk/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: |- + `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Kafka clusters. + + + Related guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateCmkV2Cluster + summary: Update a Cluster + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a cluster. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (cmk/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Kafka clusters. + + + Related guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + required: + - spec + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: |- + `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Kafka clusters. + + + Related guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteCmkV2Cluster + summary: Delete a Cluster + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (cmk/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Cluster is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + MultipleSearchFilter: + description: Filter a collection by a string search for one or more values + type: array + items: + type: string + cmk.v2.ClusterList: + type: object + description: |- + `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Kafka clusters. + + + Related guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cmk/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Kafka clusters. + + + Related guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + cmk.v2.Cluster: + type: object + description: |- + `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. + + The API allows you to list, create, read, update, and delete your Kafka clusters. + + + Related guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). + + ## The Clusters Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - cmk/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/cmk.v2.ClusterSpec' + status: + $ref: '#/components/schemas/cmk.v2.ClusterStatus' + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cmk.v2.ClusterSpec: + type: object + description: The desired state of the Cluster + properties: + display_name: + type: string + description: The name of the cluster. + example: ProdKafkaCluster + availability: + type: string + description: | + The availability zone configuration of the cluster + x-extensible-enum: + - MULTI_ZONE + - SINGLE_ZONE + - HIGH + - LOW + example: SINGLE_ZONE + cloud: + type: string + description: The cloud service provider in which the cluster is running. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: GCP + x-immutable: true + region: + type: string + description: The cloud service provider region where the cluster is running. + example: us-east4 + x-immutable: true + config: + description: | + The configuration of the Kafka cluster. + + Note: Clusters can be upgraded from Basic to Standard, but cannot be downgraded from Standard to Basic. + default: + kind: Basic + example: + kind: Basic + discriminator: + propertyName: kind + mapping: + Basic: '#/components/schemas/cmk.v2.Basic' + Standard: '#/components/schemas/cmk.v2.Standard' + Dedicated: '#/components/schemas/cmk.v2.Dedicated' + Enterprise: '#/components/schemas/cmk.v2.Enterprise' + Freight: '#/components/schemas/cmk.v2.Freight' + type: object + properties: + kind: + description: | + Basic cluster type. + type: string + enum: + - Basic + max_ecku: + description: | + The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. + For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements). + type: integer + format: int32 + minimum: 1 + example: 2 + cku: + description: | + The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. + MULTI_ZONE dedicated clusters must have at least two CKUs. + type: integer + format: int32 + minimum: 1 + example: 2 + encryption_key: + type: string + description: | + The id of the encryption key that is used to encrypt the data in the Kafka cluster. + (e.g. for Amazon Web Services, the Amazon Resource Name of the key). + example: arn:aws:kms:us-west-2:000000000000:key/0000xxxx-00xx-00xx-00xx-0000000000xx + deprecated: true + x-immutable: true + zones: + type: array + items: + type: string + uniqueItems: true + minItems: 1 + maxItems: 3 + description: | + The list of zones the cluster is in. + + On AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) + (e.g. use1-az3) + + On GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones) + (e.g. us-central1-c). + readOnly: false + example: + - us-central1-a + - us-central1-b + - us-central1-c + x-immutable: true + required: + - kind + - cku + kafka_bootstrap_endpoint: + type: string + description: | + The bootstrap endpoint used by Kafka clients to connect to the cluster. + + DEPRECATED - Please use the `endpoints` attribute instead. + example: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092 + deprecated: true + x-immutable: true + readOnly: true + http_endpoint: + type: string + description: | + The cluster HTTP request URL. + + DEPRECATED - Please use the `endpoints` attribute instead. + format: uri + example: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud + deprecated: true + x-immutable: true + readOnly: true + api_endpoint: + type: string + description: | + The Kafka API cluster endpoint used by Kafka clients to connect to the cluster. + + DEPRECATED - Please use the `endpoints` attribute instead. + example: https://pkac-00000.us-west-2.aws.confluent.cloud + deprecated: true + x-immutable: true + readOnly: true + endpoints: + description: | + A map of endpoints for connecting to the Kafka cluster, + keyed by access_point_id. Access Point ID 'PUBLIC' and 'PRIVATE_LINK' are reserved. + These can be used for different network access methods or regions. + example: + ap1pni123: + kafka_bootstrap_endpoint: lkc-s1232-00000.us-central1.gcp.private.confluent.cloud:9092 + http_endpoint: https://lkc-s1232.us-central1.gcp.private.confluent.cloud:443 + connection_type: PRIVATENETWORKINTERFACE + ap2platt67890: + kafka_bootstrap_endpoint: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092 + http_endpoint: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud + connection_type: PRIVATELINK + readOnly: true + type: object + additionalProperties: + $ref: '#/components/schemas/cmk.v2.Endpoints' + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + description: The network associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + byok: + description: | + Note: For Pre-BYOK v1 clusters, API responses might show both + `encryption_key` and `byok`. + To manage Pre-BYOK v1 keys, refer to: + https://docs.confluent.io/cloud/current/security/encrypt/byok/legacy-byok.html + #manage-pre-byok-api-v1-self-managed-encryption-keys + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + cmk.v2.ClusterStatus: + type: object + required: + - phase + description: The status of the Cluster + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PROVISIONED + - FAILED + description: | + The lifecyle phase of the cluster: + PROVISIONED: cluster is provisioned; + PROVISIONING: cluster provisioning is in progress; + FAILED: provisioning failed + readOnly: true + example: PROVISIONED + cku: + description: | + The number of Confluent Kafka Units (CKUs) the Dedicated cluster currently has. + readOnly: true + type: integer + format: int32 + minimum: 1 + example: 2 + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + cmk.v2.Basic: + type: object + description: | + The basic cluster type. + properties: + kind: + description: | + Basic cluster type. + type: string + enum: + - Basic + max_ecku: + description: | + The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. + For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements). + type: integer + format: int32 + minimum: 1 + example: 2 + required: + - kind + cmk.v2.Standard: + type: object + description: | + The standard cluster type. + properties: + kind: + description: | + Standard cluster type. + type: string + enum: + - Standard + max_ecku: + description: | + The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. + Kafka clusters with `HIGH` availability must have at least two eCKUs. + For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements). + type: integer + format: int32 + minimum: 1 + example: 2 + required: + - kind + cmk.v2.Dedicated: + type: object + description: | + A dedicated cluster with its parameters. + properties: + kind: + type: string + enum: + - Dedicated + description: | + Dedicated cluster type. + cku: + description: | + The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. + MULTI_ZONE dedicated clusters must have at least two CKUs. + type: integer + format: int32 + minimum: 1 + example: 2 + encryption_key: + type: string + description: | + The id of the encryption key that is used to encrypt the data in the Kafka cluster. + (e.g. for Amazon Web Services, the Amazon Resource Name of the key). + example: arn:aws:kms:us-west-2:000000000000:key/0000xxxx-00xx-00xx-00xx-0000000000xx + deprecated: true + x-immutable: true + zones: + type: array + items: + type: string + uniqueItems: true + minItems: 1 + maxItems: 3 + description: | + The list of zones the cluster is in. + + On AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) + (e.g. use1-az3) + + On GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones) + (e.g. us-central1-c). + readOnly: false + example: + - us-central1-a + - us-central1-b + - us-central1-c + x-immutable: true + required: + - kind + - cku + cmk.v2.Enterprise: + type: object + description: | + The enterprise cluster type. + properties: + kind: + description: | + Enterprise cluster type. + type: string + enum: + - Enterprise + max_ecku: + description: | + The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. + Kafka clusters with `HIGH` availability must have at least two eCKUs. + For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements). + type: integer + format: int32 + minimum: 1 + example: 2 + required: + - kind + cmk.v2.Freight: + type: object + description: | + A freight cluster with its parameters. + properties: + kind: + type: string + enum: + - Freight + description: | + Freight cluster type. + max_ecku: + description: | + The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. + Kafka clusters with `HIGH` availability must have at least two eCKUs. + For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements). + type: integer + format: int32 + minimum: 1 + example: 2 + zones: + type: array + items: + type: string + uniqueItems: true + minItems: 1 + maxItems: 3 + description: | + The list of zones the cluster is in. + + On AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) + (e.g. use1-az3) + + On GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones) + (e.g. us-central1-c). + readOnly: true + example: + - us-central1-a + - us-central1-b + - us-central1-c + x-immutable: true + required: + - kind + cmk.v2.EndpointsMap: + type: object + description: | + Map of endpoints for a Kafka cluster, keyed by access point ID. + additionalProperties: + $ref: '#/components/schemas/cmk.v2.Endpoints' + readOnly: true + example: + ap1pni123: + kafka_bootstrap_endpoint: lkc-s1232-00000.us-central1.gcp.private.confluent.cloud:9092 + http_endpoint: https://lkc-s1232.us-central1.gcp.private.confluent.cloud:443 + connection_type: PRIVATE_NETWORK_INTERFACE + ap2platt67890: + kafka_bootstrap_endpoint: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092 + http_endpoint: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud + connection_type: PRIVATE_LINK + EnvScopedObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + GlobalObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cmk.v2.Endpoints: + type: object + description: | + Given a gateway type, endpoints to connect to the Kafka cluster. + properties: + kafka_bootstrap_endpoint: + type: string + description: | + The bootstrap endpoint used by Kafka clients to connect to the cluster. + example: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092 + http_endpoint: + type: string + description: | + The REST endpoint for the Kafka cluster. + format: uri + example: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:443 + connection_type: + type: string + description: | + The type of connection used for the endpoint. + x-extensible-enum: + - PUBLIC + - PRIVATE_LINK + - PRIVATE_NETWORK_INTERFACE + example: PRIVATE_NETWORK_INTERFACE + required: + - kafka_bootstrap_endpoint + - http_endpoint + - connection_type + readOnly: true + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + OverQuotaError: + x-summary: Over Quota + description: The request would exceed one or more quotas. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '402' + code: quota_exceeded + title: Kafka Clusters Per Org Quota Exceeded + detail: 'The request would exceed the quota: kafka_clusters_per_environment' + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/networking.yaml b/provider-dev/source/networking.yaml new file mode 100644 index 0000000..572ff45 --- /dev/null +++ b/provider-dev/source/networking.yaml @@ -0,0 +1,19621 @@ +openapi: 3.0.0 +info: + title: networking API + description: confluent networking API + version: 1.0.0 +paths: + /networking/v1/networks: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1Networks + summary: List of Networks + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all networks. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-gcp-us-central1 + - prod-aws-us-east1 + description: Filter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.cloud + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - GCP + - AWS + description: Filter the results by exact match for spec.cloud. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.region + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - us-central1 + - us-east-1 + description: Filter the results by exact match for spec.region. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.connection_types + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - peering + - privatelink + description: Filter the results by exact match for spec.connection_types. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.cidr + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - 10.200.0.0/16 + description: Filter the results by exact match for spec.cidr. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - PROVISIONING + - READY + description: Filter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Networks (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network. + content: + application/json: + schema: + type: object + description: |- + `Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud + provider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters. + Shared networks can contain any cluster type. + + The API allows you to list, create, read, update, and delete your networks. + + + Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + ## The Networks Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `dedicated_networks_per_environment` | Number of dedicated networks per Confluent Cloud environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud + provider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters. + Shared networks can contain any cluster type. + + The API allows you to list, create, read, update, and delete your networks. + + + Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + ## The Networks Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `dedicated_networks_per_environment` | Number of dedicated networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1Network + summary: Create a Network + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a network. + tags: + - Networks (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud + provider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters. + Shared networks can contain any cluster type. + + The API allows you to list, create, read, update, and delete your networks. + + + Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + ## The Networks Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `dedicated_networks_per_environment` | Number of dedicated networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + required: + - spec + responses: + '202': + description: A Network is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/networks/{id} + description: Network resource uri + content: + application/json: + schema: + type: object + description: |- + `Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud + provider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters. + Shared networks can contain any cluster type. + + The API allows you to list, create, read, update, and delete your networks. + + + Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + ## The Networks Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `dedicated_networks_per_environment` | Number of dedicated networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/networks/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1Network + summary: Read a Network + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a network. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network. + tags: + - Networks (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network. + content: + application/json: + schema: + type: object + description: |- + `Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud + provider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters. + Shared networks can contain any cluster type. + + The API allows you to list, create, read, update, and delete your networks. + + + Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + ## The Networks Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `dedicated_networks_per_environment` | Number of dedicated networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1Network + summary: Update a Network + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a network. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network. + tags: + - Networks (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud + provider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters. + Shared networks can contain any cluster type. + + The API allows you to list, create, read, update, and delete your networks. + + + Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + ## The Networks Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `dedicated_networks_per_environment` | Number of dedicated networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + required: + - spec + responses: + '200': + description: Network. + content: + application/json: + schema: + type: object + description: |- + `Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud + provider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters. + Shared networks can contain any cluster type. + + The API allows you to list, create, read, update, and delete your networks. + + + Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + ## The Networks Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `dedicated_networks_per_environment` | Number of dedicated networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1Network + summary: Delete a Network + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a network. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network. + tags: + - Networks (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Network is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/peerings: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1Peerings + summary: List of Peerings + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all peerings. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-peering-uscentral1 + - prod-peering-use1 + description: Filter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - PROVISIONING + - READY + description: Filter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - n-00000 + - n-00001 + description: Filter the results by exact match for spec.network. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Peerings (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Peering. + content: + application/json: + schema: + type: object + description: |- + Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + * [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + ## The Peerings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `peerings_per_network` | Number of peerings per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PeeringList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + * [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + ## The Peerings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1Peering + summary: Create a Peering + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a peering. + tags: + - Peerings (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + * [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + ## The Peerings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + required: + - spec + responses: + '202': + description: A Peering is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/peerings/{id} + description: Peering resource uri + content: + application/json: + schema: + type: object + description: |- + Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + * [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + ## The Peerings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/peerings/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1Peering + summary: Read a Peering + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a peering. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the peering. + tags: + - Peerings (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Peering. + content: + application/json: + schema: + type: object + description: |- + Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + * [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + ## The Peerings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1Peering + summary: Update a Peering + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a peering. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the peering. + tags: + - Peerings (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + * [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + ## The Peerings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + required: + - spec + responses: + '200': + description: Peering. + content: + application/json: + schema: + type: object + description: |- + Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + * [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + ## The Peerings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1Peering + summary: Delete a Peering + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a peering. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the peering. + tags: + - Peerings (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Peering is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/transit-gateway-attachments: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1TransitGatewayAttachments + summary: List of Transit Gateway Attachments + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all transit gateway attachments. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-tgw-use1 + - prod-tgw-usw2 + description: Filter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - PROVISIONING + - READY + description: Filter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - n-00000 + - n-00001 + description: Filter the results by exact match for spec.network. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Transit Gateway Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Transit Gateway Attachment. + content: + application/json: + schema: + type: object + description: |- + AWS Transit Gateway Attachments + + Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + ## The Transit Gateway Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `tgw_attachments_per_network` | Number of TGW attachments per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachmentList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + AWS Transit Gateway Attachments + + Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + ## The Transit Gateway Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `tgw_attachments_per_network` | Number of TGW attachments per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1TransitGatewayAttachment + summary: Create a Transit Gateway Attachment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a transit gateway attachment. + tags: + - Transit Gateway Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + AWS Transit Gateway Attachments + + Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + ## The Transit Gateway Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `tgw_attachments_per_network` | Number of TGW attachments per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentStatus' + required: + - spec + responses: + '202': + description: A Transit Gateway Attachment is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/transit-gateway-attachments/{id} + description: TransitGatewayAttachment resource uri + content: + application/json: + schema: + type: object + description: |- + AWS Transit Gateway Attachments + + Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + ## The Transit Gateway Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `tgw_attachments_per_network` | Number of TGW attachments per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/transit-gateway-attachments/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1TransitGatewayAttachment + summary: Read a Transit Gateway Attachment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a transit gateway attachment. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the transit gateway attachment. + tags: + - Transit Gateway Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Transit Gateway Attachment. + content: + application/json: + schema: + type: object + description: |- + AWS Transit Gateway Attachments + + Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + ## The Transit Gateway Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `tgw_attachments_per_network` | Number of TGW attachments per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1TransitGatewayAttachment + summary: Update a Transit Gateway Attachment + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a transit gateway attachment. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the transit gateway attachment. + tags: + - Transit Gateway Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + AWS Transit Gateway Attachments + + Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + ## The Transit Gateway Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `tgw_attachments_per_network` | Number of TGW attachments per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentStatus' + required: + - spec + responses: + '200': + description: Transit Gateway Attachment. + content: + application/json: + schema: + type: object + description: |- + AWS Transit Gateway Attachments + + Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + ## The Transit Gateway Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `tgw_attachments_per_network` | Number of TGW attachments per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1TransitGatewayAttachment + summary: Delete a Transit Gateway Attachment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a transit gateway attachment. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the transit gateway attachment. + tags: + - Transit Gateway Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Transit Gateway Attachment is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/private-link-accesses: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1PrivateLinkAccesses + summary: List of Private Link Accesses + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all private link accesses. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-pl-use1 + - prod-pl-usw2 + description: Filter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - PROVISIONING + - READY + description: Filter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - n-00000 + - n-00001 + description: Filter the results by exact match for spec.network. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Private Link Accesses (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Access. + content: + application/json: + schema: + type: object + description: |- + Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID. + + Related guides: + * [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + * [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + * [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + ## The Private Link Accesses Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_accounts_per_network` | Number of AWS accounts per network | + | `private_link_subscriptions_per_network` | Number of Azure subscriptions per network | + | `private_service_connect_projects_per_network` | Number of GCP projects per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccessList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID. + + Related guides: + * [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + * [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + * [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + ## The Private Link Accesses Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_accounts_per_network` | Number of AWS accounts per network | + | `private_link_subscriptions_per_network` | Number of Azure subscriptions per network | + | `private_service_connect_projects_per_network` | Number of GCP projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1PrivateLinkAccess + summary: Create a Private Link Access + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a private link access. + tags: + - Private Link Accesses (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID. + + Related guides: + * [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + * [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + * [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + ## The Private Link Accesses Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_accounts_per_network` | Number of AWS accounts per network | + | `private_link_subscriptions_per_network` | Number of Azure subscriptions per network | + | `private_service_connect_projects_per_network` | Number of GCP projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + required: + - spec + responses: + '202': + description: A Private Link Access is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/private-link-accesses/{id} + description: PrivateLinkAccess resource uri + content: + application/json: + schema: + type: object + description: |- + Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID. + + Related guides: + * [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + * [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + * [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + ## The Private Link Accesses Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_accounts_per_network` | Number of AWS accounts per network | + | `private_link_subscriptions_per_network` | Number of Azure subscriptions per network | + | `private_service_connect_projects_per_network` | Number of GCP projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/private-link-accesses/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1PrivateLinkAccess + summary: Read a Private Link Access + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a private link access. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link access. + tags: + - Private Link Accesses (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Access. + content: + application/json: + schema: + type: object + description: |- + Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID. + + Related guides: + * [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + * [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + * [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + ## The Private Link Accesses Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_accounts_per_network` | Number of AWS accounts per network | + | `private_link_subscriptions_per_network` | Number of Azure subscriptions per network | + | `private_service_connect_projects_per_network` | Number of GCP projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1PrivateLinkAccess + summary: Update a Private Link Access + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a private link access. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link access. + tags: + - Private Link Accesses (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID. + + Related guides: + * [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + * [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + * [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + ## The Private Link Accesses Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_accounts_per_network` | Number of AWS accounts per network | + | `private_link_subscriptions_per_network` | Number of Azure subscriptions per network | + | `private_service_connect_projects_per_network` | Number of GCP projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + required: + - spec + responses: + '200': + description: Private Link Access. + content: + application/json: + schema: + type: object + description: |- + Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID. + + Related guides: + * [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + * [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + * [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + ## The Private Link Accesses Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_accounts_per_network` | Number of AWS accounts per network | + | `private_link_subscriptions_per_network` | Number of Azure subscriptions per network | + | `private_service_connect_projects_per_network` | Number of GCP projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1PrivateLinkAccess + summary: Delete a Private Link Access + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a private link access. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link access. + tags: + - Private Link Accesses (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Private Link Access is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/network-link-services: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1NetworkLinkServices + summary: List of Network Link Services + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all network link services. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-net-1-nls + - dev-net-1-nls + description: Filter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - READY + description: Filter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - n-00000 + - n-00001 + description: Filter the results by exact match for spec.network. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Network Link Services (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Service. + content: + application/json: + schema: + type: object + description: |- + Network Link Service is associated with a Private Link Confluent Cloud Network. + It enables connectivity from other Private Link Confluent Cloud Networks based on + the configured accept policies. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Services Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_service_per_network` | Number of network link services per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + Network Link Service is associated with a Private Link Confluent Cloud Network. + It enables connectivity from other Private Link Confluent Cloud Networks based on + the configured accept policies. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Services Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_service_per_network` | Number of network link services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1NetworkLinkService + summary: Create a Network Link Service + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a network link service. + tags: + - Network Link Services (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + Network Link Service is associated with a Private Link Confluent Cloud Network. + It enables connectivity from other Private Link Confluent Cloud Networks based on + the configured accept policies. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Services Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_service_per_network` | Number of network link services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceStatus' + required: + - spec + responses: + '202': + description: A Network Link Service is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/network-link-services/{id} + description: NetworkLinkService resource uri + content: + application/json: + schema: + type: object + description: |- + Network Link Service is associated with a Private Link Confluent Cloud Network. + It enables connectivity from other Private Link Confluent Cloud Networks based on + the configured accept policies. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Services Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_service_per_network` | Number of network link services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/network-link-services/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1NetworkLinkService + summary: Read a Network Link Service + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a network link service. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link service. + tags: + - Network Link Services (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Service. + content: + application/json: + schema: + type: object + description: |- + Network Link Service is associated with a Private Link Confluent Cloud Network. + It enables connectivity from other Private Link Confluent Cloud Networks based on + the configured accept policies. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Services Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_service_per_network` | Number of network link services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1NetworkLinkService + summary: Update a Network Link Service + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a network link service. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link service. + tags: + - Network Link Services (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + Network Link Service is associated with a Private Link Confluent Cloud Network. + It enables connectivity from other Private Link Confluent Cloud Networks based on + the configured accept policies. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Services Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_service_per_network` | Number of network link services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceStatus' + required: + - spec + responses: + '200': + description: Network Link Service. + content: + application/json: + schema: + type: object + description: |- + Network Link Service is associated with a Private Link Confluent Cloud Network. + It enables connectivity from other Private Link Confluent Cloud Networks based on + the configured accept policies. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Services Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_service_per_network` | Number of network link services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1NetworkLinkService + summary: Delete a Network Link Service + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a network link service. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link service. + tags: + - Network Link Services (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Network Link Service is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/network-link-endpoints: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1NetworkLinkEndpoints + summary: List of Network Link Endpoints + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all network link endpoints. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-net-1-nle + - dev-net-1-nle + description: Filter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - READY + - PENDING_ACCEPT + description: Filter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.network + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - n-00000 + - n-00001 + description: Filter the results by exact match for spec.network. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.network_link_service + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - nls-abcde + - nls-00000 + description: Filter the results by exact match for spec.network_link_service. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Network Link Endpoints (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Endpoint. + content: + application/json: + schema: + type: object + description: |- + A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a + Network Link Service (associated with another Private Link Confluent Cloud Network) at the target. + It enables connectivity between the origin network and the target network. + It can only be associated with a Private Link network. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Endpoints Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_endpoints_per_network` | Number of network link endpoints per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpointList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a + Network Link Service (associated with another Private Link Confluent Cloud Network) at the target. + It enables connectivity between the origin network and the target network. + It can only be associated with a Private Link network. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Endpoints Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_endpoints_per_network` | Number of network link endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1NetworkLinkEndpoint + summary: Create a Network Link Endpoint + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a network link endpoint. + tags: + - Network Link Endpoints (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a + Network Link Service (associated with another Private Link Confluent Cloud Network) at the target. + It enables connectivity between the origin network and the target network. + It can only be associated with a Private Link network. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Endpoints Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_endpoints_per_network` | Number of network link endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointStatus' + required: + - spec + responses: + '202': + description: A Network Link Endpoint is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/network-link-endpoints/{id} + description: NetworkLinkEndpoint resource uri + content: + application/json: + schema: + type: object + description: |- + A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a + Network Link Service (associated with another Private Link Confluent Cloud Network) at the target. + It enables connectivity between the origin network and the target network. + It can only be associated with a Private Link network. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Endpoints Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_endpoints_per_network` | Number of network link endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/network-link-endpoints/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1NetworkLinkEndpoint + summary: Read a Network Link Endpoint + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a network link endpoint. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link endpoint. + tags: + - Network Link Endpoints (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Endpoint. + content: + application/json: + schema: + type: object + description: |- + A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a + Network Link Service (associated with another Private Link Confluent Cloud Network) at the target. + It enables connectivity between the origin network and the target network. + It can only be associated with a Private Link network. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Endpoints Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_endpoints_per_network` | Number of network link endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1NetworkLinkEndpoint + summary: Update a Network Link Endpoint + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a network link endpoint. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link endpoint. + tags: + - Network Link Endpoints (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a + Network Link Service (associated with another Private Link Confluent Cloud Network) at the target. + It enables connectivity between the origin network and the target network. + It can only be associated with a Private Link network. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Endpoints Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_endpoints_per_network` | Number of network link endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointStatus' + required: + - spec + responses: + '200': + description: Network Link Endpoint. + content: + application/json: + schema: + type: object + description: |- + A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a + Network Link Service (associated with another Private Link Confluent Cloud Network) at the target. + It enables connectivity between the origin network and the target network. + It can only be associated with a Private Link network. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Endpoints Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_endpoints_per_network` | Number of network link endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1NetworkLinkEndpoint + summary: Delete a Network Link Endpoint + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a network link endpoint. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link endpoint. + tags: + - Network Link Endpoints (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Network Link Endpoint is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/network-link-service-associations: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1NetworkLinkServiceAssociations + summary: List of Network Link Service Associations + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all network link service associations. + parameters: + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - READY + - PENDING_ACCEPT + description: Filter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.network_link_service + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: nls-abcde + description: Filter the results by exact match for spec.network_link_service. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 1000 + x-max-page-items: 1000 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Network Link Service Associations (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Service Association. + content: + application/json: + schema: + type: object + description: |- + List of incoming Network Link Enpoints associated with the Network Link Service. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Service Associations Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceAssociationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + List of incoming Network Link Enpoints associated with the Network Link Service. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Service Associations Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceAssociation + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceAssociationSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceAssociationStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/network-link-service-associations/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1NetworkLinkServiceAssociation + summary: Read a Network Link Service Association + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a network link service association. + parameters: + - name: spec.network_link_service + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: nls-abcde + description: Scope the operation to the given spec.network_link_service. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the network link service association. + tags: + - Network Link Service Associations (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Network Link Service Association. + content: + application/json: + schema: + type: object + description: |- + List of incoming Network Link Enpoints associated with the Network Link Service. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Service Associations Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceAssociation + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceAssociationSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceAssociationStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/ip-addresses: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1IpAddresses + summary: List of IP Addresses + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Related guide: [Use Public Egress IP addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + Retrieve a sorted, filtered, paginated list of all IP Addresses. + parameters: + - name: cloud + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - GCP + - AWS + description: Filter the results by exact match for cloud. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: region + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - us-central1 + - us-east-1 + description: Filter the results by exact match for region. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: services + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - KAFKA + - CONNECT + description: Filter the results by exact match for services. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: address_type + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - INGRESS + - EGRESS + description: Filter the results by exact match for address_type. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - IP Addresses (networking/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: IP Address. + content: + application/json: + schema: + type: object + description: |- + IP Addresses + + Related guide: [Use Public Egress IP Addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + ## The IP Addresses Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpAddressList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + IP Addresses + + Related guide: [Use Public Egress IP addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + ## The IP Addresses Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpAddress + ip_prefix: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+/\d+$ + description: The IP Address range. + example: 10.200.0.0/28 + cloud: + type: string + description: The cloud service provider in which the address exists. + x-extensible-enum: + - AWS + - GCP + - AZURE + - ANY + example: AWS + region: + type: string + description: The region/location where the IP Address is in use. + example: us-east-1 + services: + type: array + description: The service types that will use the address. + items: + type: string + description: Address service type. + x-extensible-enum: + - KAFKA + - CONNECT + - EXTERNAL_OAUTH + example: CONNECT + uniqueItems: true + minItems: 1 + address_type: + type: string + description: Whether the address is used for egress or ingress. + x-extensible-enum: + - INGRESS + - EGRESS + example: EGRESS + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/private-link-attachments: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1PrivateLinkAttachments + summary: List of Private Link Attachments + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all private link attachments. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-gcp-us-central1 + - prod-aws-useast1 + description: Filter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.cloud + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - GCP + - AWS + description: Filter the results by exact match for spec.cloud. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.region + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - us-central1 + - us-east-1 + description: Filter the results by exact match for spec.region. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - PROVISIONING + - READY + description: Filter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Private Link Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Attachment. + content: + application/json: + schema: + type: object + description: |- + PrivateLink attachment objects represent reservations to establish PrivateLink connections + to a cloud region in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachments. + + + ## The Private Link Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_attachments_per_environment` | Number of PrivateLink Attachments per environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + PrivateLink attachment objects represent reservations to establish PrivateLink connections + to a cloud region in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachments. + + + ## The Private Link Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_attachments_per_environment` | Number of PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1PrivateLinkAttachment + summary: Create a Private Link Attachment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a private link attachment. + tags: + - Private Link Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + PrivateLink attachment objects represent reservations to establish PrivateLink connections + to a cloud region in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachments. + + + ## The Private Link Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_attachments_per_environment` | Number of PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentStatus' + required: + - spec + responses: + '202': + description: A Private Link Attachment is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/private-link-attachments/{id} + description: PrivateLinkAttachment resource uri + content: + application/json: + schema: + type: object + description: |- + PrivateLink attachment objects represent reservations to establish PrivateLink connections + to a cloud region in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachments. + + + ## The Private Link Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_attachments_per_environment` | Number of PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/private-link-attachments/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1PrivateLinkAttachment + summary: Read a Private Link Attachment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a private link attachment. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment. + tags: + - Private Link Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Attachment. + content: + application/json: + schema: + type: object + description: |- + PrivateLink attachment objects represent reservations to establish PrivateLink connections + to a cloud region in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachments. + + + ## The Private Link Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_attachments_per_environment` | Number of PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1PrivateLinkAttachment + summary: Update a Private Link Attachment + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a private link attachment. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment. + tags: + - Private Link Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + PrivateLink attachment objects represent reservations to establish PrivateLink connections + to a cloud region in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachments. + + + ## The Private Link Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_attachments_per_environment` | Number of PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentStatus' + required: + - spec + responses: + '200': + description: Private Link Attachment. + content: + application/json: + schema: + type: object + description: |- + PrivateLink attachment objects represent reservations to establish PrivateLink connections + to a cloud region in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachments. + + + ## The Private Link Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_attachments_per_environment` | Number of PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1PrivateLinkAttachment + summary: Delete a Private Link Attachment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a private link attachment. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment. + tags: + - Private Link Attachments (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Private Link Attachment is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/private-link-attachment-connections: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1PrivateLinkAttachmentConnections + summary: List of Private Link Attachment Connections + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all private link attachment connections. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.private_link_attachment + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: platt-00000 + description: Filter the results by exact match for spec.private_link_attachment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Private Link Attachment Connections (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Attachment Connection. + content: + application/json: + schema: + type: object + description: |- + PrivateLink attachment connection objects represent connections established to a cloud region + in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachment connections. + + + ## The Private Link Attachment Connections Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnectionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + PrivateLink attachment connection objects represent connections established to a cloud region + in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachment connections. + + + ## The Private Link Attachment Connections Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1PrivateLinkAttachmentConnection + summary: Create a Private Link Attachment Connection + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a private link attachment connection. + tags: + - Private Link Attachment Connections (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + PrivateLink attachment connection objects represent connections established to a cloud region + in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachment connections. + + + ## The Private Link Attachment Connections Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus' + required: + - spec + responses: + '202': + description: A Private Link Attachment Connection is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/private-link-attachment-connections/{id} + description: PrivateLinkAttachmentConnection resource uri + content: + application/json: + schema: + type: object + description: |- + PrivateLink attachment connection objects represent connections established to a cloud region + in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachment connections. + + + ## The Private Link Attachment Connections Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/private-link-attachment-connections/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1PrivateLinkAttachmentConnection + summary: Read a Private Link Attachment Connection + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a private link attachment connection. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment connection. + tags: + - Private Link Attachment Connections (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Private Link Attachment Connection. + content: + application/json: + schema: + type: object + description: |- + PrivateLink attachment connection objects represent connections established to a cloud region + in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachment connections. + + + ## The Private Link Attachment Connections Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1PrivateLinkAttachmentConnection + summary: Update a Private Link Attachment Connection + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a private link attachment connection. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment connection. + tags: + - Private Link Attachment Connections (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + PrivateLink attachment connection objects represent connections established to a cloud region + in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachment connections. + + + ## The Private Link Attachment Connections Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus' + required: + - spec + responses: + '200': + description: Private Link Attachment Connection. + content: + application/json: + schema: + type: object + description: |- + PrivateLink attachment connection objects represent connections established to a cloud region + in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachment connections. + + + ## The Private Link Attachment Connections Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1PrivateLinkAttachmentConnection + summary: Delete a Private Link Attachment Connection + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a private link attachment connection. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the private link attachment connection. + tags: + - Private Link Attachment Connections (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Private Link Attachment Connection is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/dns-forwarders: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1DnsForwarders + summary: List of DNS Forwarders + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all DNS forwarders. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - DNS Forwarders (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: DNS Forwarder. + content: + application/json: + schema: + type: object + description: |- + Add, remove, and update DNS forwarder for your gateway. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + ## The DNS Forwarders Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarderList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + Add, remove, and update DNS forwarder for your gateway. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + ## The DNS Forwarders Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1DnsForwarder + summary: Create a DNS Forwarder + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a DNS forwarder. + tags: + - DNS Forwarders (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + Add, remove, and update DNS forwarder for your gateway. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + ## The DNS Forwarders Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + required: + - spec + responses: + '202': + description: A DNS Forwarder is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/dns-forwarders/{id} + description: DnsForwarder resource uri + content: + application/json: + schema: + type: object + description: |- + Add, remove, and update DNS forwarder for your gateway. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + ## The DNS Forwarders Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/dns-forwarders/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1DnsForwarder + summary: Read a DNS Forwarder + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a DNS forwarder. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS forwarder. + tags: + - DNS Forwarders (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: DNS Forwarder. + content: + application/json: + schema: + type: object + description: |- + Add, remove, and update DNS forwarder for your gateway. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + ## The DNS Forwarders Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1DnsForwarder + summary: Update a DNS Forwarder + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a DNS forwarder. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS forwarder. + tags: + - DNS Forwarders (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + Add, remove, and update DNS forwarder for your gateway. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + ## The DNS Forwarders Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + required: + - spec + responses: + '200': + description: DNS Forwarder. + content: + application/json: + schema: + type: object + description: |- + Add, remove, and update DNS forwarder for your gateway. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + ## The DNS Forwarders Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1DnsForwarder + summary: Delete a DNS Forwarder + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a DNS forwarder. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS forwarder. + tags: + - DNS Forwarders (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A DNS Forwarder is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/access-points: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1AccessPoints + summary: List of Access Points + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all access points. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-ap-egress-use1 + - prod-ap-egress-usw2 + description: Filter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.gateway + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - gw-00000 + - gw-00001 + description: Filter the results by exact match for spec.gateway. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: id + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - ap-1 + - ap-2 + description: Filter the results by exact match for id. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Access Points (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Access Point. + content: + application/json: + schema: + type: object + description: |- + AccessPoint objects represent network connections in and out of Gateways. + This API allows you to list, create, read, update, and delete your access points. + + + ## The Access Points Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPointList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + AccessPoint objects represent network connections in and out of Gateways. + This API allows you to list, create, read, update, and delete your access points. + + + ## The Access Points Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1AccessPoint + summary: Create an Access Point + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an access point. + tags: + - Access Points (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + AccessPoint objects represent network connections in and out of Gateways. + This API allows you to list, create, read, update, and delete your access points. + + + ## The Access Points Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + required: + - spec + responses: + '202': + description: An Access Point is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/access-points/{id} + description: AccessPoint resource uri + content: + application/json: + schema: + type: object + description: |- + AccessPoint objects represent network connections in and out of Gateways. + This API allows you to list, create, read, update, and delete your access points. + + + ## The Access Points Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/access-points/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1AccessPoint + summary: Read an Access Point + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an access point. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the access point. + tags: + - Access Points (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Access Point. + content: + application/json: + schema: + type: object + description: |- + AccessPoint objects represent network connections in and out of Gateways. + This API allows you to list, create, read, update, and delete your access points. + + + ## The Access Points Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1AccessPoint + summary: Update an Access Point + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an access point. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the access point. + tags: + - Access Points (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + AccessPoint objects represent network connections in and out of Gateways. + This API allows you to list, create, read, update, and delete your access points. + + + ## The Access Points Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + required: + - spec + responses: + '200': + description: Access Point. + content: + application/json: + schema: + type: object + description: |- + AccessPoint objects represent network connections in and out of Gateways. + This API allows you to list, create, read, update, and delete your access points. + + + ## The Access Points Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1AccessPoint + summary: Delete an Access Point + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an access point. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the access point. + tags: + - Access Points (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Access Point is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/dns-records: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1DnsRecords + summary: List of DNS Records + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all DNS records. + parameters: + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-dnsrec-1 + - prod-dnsrec-2 + description: Filter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.domain + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - example.com + - example2.com + description: Filter the results by exact match for spec.domain. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.gateway + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - gw-00000 + - gw-00001 + description: Filter the results by exact match for spec.gateway. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: resource + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - ap-11111 + - ap-22222 + description: Filter the results by exact match for resource. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - DNS Records (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: DNS Record. + content: + application/json: + schema: + type: object + description: |- + DNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records. + + ## The DNS Records Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecordList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + DNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records. + + ## The DNS Records Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1DnsRecord + summary: Create a DNS Record + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a DNS record. + tags: + - DNS Records (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + DNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records. + + ## The DNS Records Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + required: + - spec + responses: + '202': + description: A DNS Record is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/dns-records/{id} + description: DnsRecord resource uri + content: + application/json: + schema: + type: object + description: |- + DNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records. + + ## The DNS Records Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/dns-records/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1DnsRecord + summary: Read a DNS Record + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a DNS record. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS record. + tags: + - DNS Records (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: DNS Record. + content: + application/json: + schema: + type: object + description: |- + DNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records. + + ## The DNS Records Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1DnsRecord + summary: Update a DNS Record + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a DNS record. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS record. + tags: + - DNS Records (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + DNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records. + + ## The DNS Records Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + required: + - spec + responses: + '200': + description: DNS Record. + content: + application/json: + schema: + type: object + description: |- + DNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records. + + ## The DNS Records Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1DnsRecord + summary: Delete a DNS Record + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a DNS record. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the DNS record. + tags: + - DNS Records (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A DNS Record is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/gateways: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNetworkingV1Gateways + summary: List of Gateways + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all gateways. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: gateway_type + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - AwsEgressPrivateLink + - AzureEgressPrivateLink + description: Filter the results by exact match for gateway_type. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: id + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - gw-1 + - gw-2 + description: Filter the results by exact match for id. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.config.region + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - us-east-1 + - us-west-2 + description: Filter the results by exact match for spec.config.region. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: spec.display_name + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - prod-gateway-ingress-use1 + - prod-gateway-ingress-use2 + description: Filter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: status.phase + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - PROVISIONING + - READY + description: Filter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Gateways (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Gateway. + content: + application/json: + schema: + type: object + description: |- + A Gateway represents a slice of traffic capacity in a region that is reserved for a customer. + + + ## The Gateways Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `gateways_per_region_per_environment` | Number of Gateways per region per environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GatewayList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + A Gateway represents a slice of traffic capacity in a region that is reserved for a customer. + + + ## The Gateways Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `gateways_per_region_per_environment` | Number of Gateways per region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNetworkingV1Gateway + summary: Create a Gateway + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a gateway. + tags: + - Gateways (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + A Gateway represents a slice of traffic capacity in a region that is reserved for a customer. + + + ## The Gateways Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `gateways_per_region_per_environment` | Number of Gateways per region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + required: + - spec + responses: + '202': + description: A Gateway is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/networking/v1/gateways/{id} + description: Gateway resource uri + content: + application/json: + schema: + type: object + description: |- + A Gateway represents a slice of traffic capacity in a region that is reserved for a customer. + + + ## The Gateways Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `gateways_per_region_per_environment` | Number of Gateways per region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /networking/v1/gateways/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNetworkingV1Gateway + summary: Read a Gateway + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a gateway. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the gateway. + tags: + - Gateways (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Gateway. + content: + application/json: + schema: + type: object + description: |- + A Gateway represents a slice of traffic capacity in a region that is reserved for a customer. + + + ## The Gateways Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `gateways_per_region_per_environment` | Number of Gateways per region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNetworkingV1Gateway + summary: Update a Gateway + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a gateway. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the gateway. + tags: + - Gateways (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + A Gateway represents a slice of traffic capacity in a region that is reserved for a customer. + + + ## The Gateways Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `gateways_per_region_per_environment` | Number of Gateways per region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + required: + - spec + responses: + '200': + description: Gateway. + content: + application/json: + schema: + type: object + description: |- + A Gateway represents a slice of traffic capacity in a region that is reserved for a customer. + + + ## The Gateways Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `gateways_per_region_per_environment` | Number of Gateways per region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNetworkingV1Gateway + summary: Delete a Gateway + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a gateway. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the gateway. + tags: + - Gateways (networking/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Gateway is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + MultipleSearchFilter: + description: Filter a collection by a string search for one or more values + type: array + items: + type: string + SearchFilter: + description: Filter a collection by a string search + type: string + networking.v1.NetworkList: + type: object + description: |- + `Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud + provider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters. + Shared networks can contain any cluster type. + + The API allows you to list, create, read, update, and delete your networks. + + + Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + ## The Networks Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `dedicated_networks_per_environment` | Number of dedicated networks per Confluent Cloud environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud + provider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters. + Shared networks can contain any cluster type. + + The API allows you to list, create, read, update, and delete your networks. + + + Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + ## The Networks Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `dedicated_networks_per_environment` | Number of dedicated networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.Network: + type: object + description: |- + `Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud + provider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters. + Shared networks can contain any cluster type. + + The API allows you to list, create, read, update, and delete your networks. + + + Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). + + ## The Networks Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `dedicated_networks_per_environment` | Number of dedicated networks per Confluent Cloud environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkStatus' + networking.v1.PeeringList: + type: object + description: |- + Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + * [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + ## The Peerings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `peerings_per_network` | Number of peerings per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PeeringList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + * [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + ## The Peerings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.Peering: + type: object + description: |- + Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + * [Use VPC peering connections with Confluent Cloud on Google Cloud](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html). + + + ## The Peerings Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `peerings_per_network` | Number of peerings per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Peering + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PeeringSpec' + status: + $ref: '#/components/schemas/networking.v1.PeeringStatus' + networking.v1.TransitGatewayAttachmentList: + type: object + description: |- + AWS Transit Gateway Attachments + + Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + ## The Transit Gateway Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `tgw_attachments_per_network` | Number of TGW attachments per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachmentList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + AWS Transit Gateway Attachments + + Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + ## The Transit Gateway Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `tgw_attachments_per_network` | Number of TGW attachments per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.TransitGatewayAttachment: + type: object + description: |- + AWS Transit Gateway Attachments + + Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). + + ## The Transit Gateway Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `tgw_attachments_per_network` | Number of TGW attachments per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TransitGatewayAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.TransitGatewayAttachmentStatus' + networking.v1.PrivateLinkAccessList: + type: object + description: |- + Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID. + + Related guides: + * [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + * [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + * [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + ## The Private Link Accesses Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_accounts_per_network` | Number of AWS accounts per network | + | `private_link_subscriptions_per_network` | Number of Azure subscriptions per network | + | `private_service_connect_projects_per_network` | Number of GCP projects per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccessList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID. + + Related guides: + * [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + * [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + * [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + ## The Private Link Accesses Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_accounts_per_network` | Number of AWS accounts per network | + | `private_link_subscriptions_per_network` | Number of Azure subscriptions per network | + | `private_service_connect_projects_per_network` | Number of GCP projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.PrivateLinkAccess: + type: object + description: |- + Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID. + + Related guides: + * [Use Google Cloud Private Service Connect with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/gcp-private-service-connect.html). + * [Use Azure Private Link with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html). + * [Use AWS PrivateLink with Confluent Cloud](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html). + + + ## The Private Link Accesses Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_accounts_per_network` | Number of AWS accounts per network | + | `private_link_subscriptions_per_network` | Number of Azure subscriptions per network | + | `private_service_connect_projects_per_network` | Number of GCP projects per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAccess + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAccessStatus' + networking.v1.NetworkLinkServiceList: + type: object + description: |- + Network Link Service is associated with a Private Link Confluent Cloud Network. + It enables connectivity from other Private Link Confluent Cloud Networks based on + the configured accept policies. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Services Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_service_per_network` | Number of network link services per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + Network Link Service is associated with a Private Link Confluent Cloud Network. + It enables connectivity from other Private Link Confluent Cloud Networks based on + the configured accept policies. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Services Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_service_per_network` | Number of network link services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.NetworkLinkService: + type: object + description: |- + Network Link Service is associated with a Private Link Confluent Cloud Network. + It enables connectivity from other Private Link Confluent Cloud Networks based on + the configured accept policies. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Services Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_service_per_network` | Number of network link services per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkService + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceStatus' + networking.v1.NetworkLinkEndpointList: + type: object + description: |- + A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a + Network Link Service (associated with another Private Link Confluent Cloud Network) at the target. + It enables connectivity between the origin network and the target network. + It can only be associated with a Private Link network. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Endpoints Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_endpoints_per_network` | Number of network link endpoints per network | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpointList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a + Network Link Service (associated with another Private Link Confluent Cloud Network) at the target. + It enables connectivity between the origin network and the target network. + It can only be associated with a Private Link network. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Endpoints Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_endpoints_per_network` | Number of network link endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.NetworkLinkEndpoint: + type: object + description: |- + A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a + Network Link Service (associated with another Private Link Confluent Cloud Network) at the target. + It enables connectivity between the origin network and the target network. + It can only be associated with a Private Link network. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Endpoints Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `network_link_endpoints_per_network` | Number of network link endpoints per network | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkEndpoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkEndpointStatus' + networking.v1.NetworkLinkServiceAssociationList: + type: object + description: |- + List of incoming Network Link Enpoints associated with the Network Link Service. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Service Associations Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceAssociationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + List of incoming Network Link Enpoints associated with the Network Link Service. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Service Associations Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceAssociation + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceAssociationSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceAssociationStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.NetworkLinkServiceAssociation: + type: object + description: |- + List of incoming Network Link Enpoints associated with the Network Link Service. + + + Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). + + ## The Network Link Service Associations Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NetworkLinkServiceAssociation + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceAssociationSpec' + status: + $ref: '#/components/schemas/networking.v1.NetworkLinkServiceAssociationStatus' + networking.v1.IpAddressList: + type: object + description: |- + IP Addresses + + Related guide: [Use Public Egress IP Addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + ## The IP Addresses Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpAddressList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + IP Addresses + + Related guide: [Use Public Egress IP addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + ## The IP Addresses Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpAddress + ip_prefix: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+/\d+$ + description: The IP Address range. + example: 10.200.0.0/28 + cloud: + type: string + description: The cloud service provider in which the address exists. + x-extensible-enum: + - AWS + - GCP + - AZURE + - ANY + example: AWS + region: + type: string + description: The region/location where the IP Address is in use. + example: us-east-1 + services: + type: array + description: The service types that will use the address. + items: + type: string + description: Address service type. + x-extensible-enum: + - KAFKA + - CONNECT + - EXTERNAL_OAUTH + example: CONNECT + uniqueItems: true + minItems: 1 + address_type: + type: string + description: Whether the address is used for egress or ingress. + x-extensible-enum: + - INGRESS + - EGRESS + example: EGRESS + uniqueItems: true + networking.v1.PrivateLinkAttachmentList: + type: object + description: |- + PrivateLink attachment objects represent reservations to establish PrivateLink connections + to a cloud region in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachments. + + + ## The Private Link Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_attachments_per_environment` | Number of PrivateLink Attachments per environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + PrivateLink attachment objects represent reservations to establish PrivateLink connections + to a cloud region in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachments. + + + ## The Private Link Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_attachments_per_environment` | Number of PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.PrivateLinkAttachment: + type: object + description: |- + PrivateLink attachment objects represent reservations to establish PrivateLink connections + to a cloud region in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachments. + + + ## The Private Link Attachments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `private_link_attachments_per_environment` | Number of PrivateLink Attachments per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentStatus' + networking.v1.PrivateLinkAttachmentConnectionList: + type: object + description: |- + PrivateLink attachment connection objects represent connections established to a cloud region + in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachment connections. + + + ## The Private Link Attachment Connections Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnectionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + PrivateLink attachment connection objects represent connections established to a cloud region + in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachment connections. + + + ## The Private Link Attachment Connections Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.PrivateLinkAttachmentConnection: + type: object + description: |- + PrivateLink attachment connection objects represent connections established to a cloud region + in order to access resources that belong to a Confluent Cloud Environment. + The API allows you to list, create, read update and delete your PrivateLink attachment connections. + + + ## The Private Link Attachment Connections Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - PrivateLinkAttachmentConnection + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionSpec' + status: + $ref: '#/components/schemas/networking.v1.PrivateLinkAttachmentConnectionStatus' + networking.v1.DnsForwarderList: + type: object + description: |- + Add, remove, and update DNS forwarder for your gateway. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + ## The DNS Forwarders Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarderList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + Add, remove, and update DNS forwarder for your gateway. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + ## The DNS Forwarders Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.DnsForwarder: + type: object + description: |- + Add, remove, and update DNS forwarder for your gateway. + + Related guides: + * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). + * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). + + + ## The DNS Forwarders Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsForwarder + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsForwarderSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsForwarderStatus' + networking.v1.AccessPointList: + type: object + description: |- + AccessPoint objects represent network connections in and out of Gateways. + This API allows you to list, create, read, update, and delete your access points. + + + ## The Access Points Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPointList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + AccessPoint objects represent network connections in and out of Gateways. + This API allows you to list, create, read, update, and delete your access points. + + + ## The Access Points Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.AccessPoint: + type: object + description: |- + AccessPoint objects represent network connections in and out of Gateways. + This API allows you to list, create, read, update, and delete your access points. + + + ## The Access Points Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AccessPoint + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.AccessPointSpec' + status: + $ref: '#/components/schemas/networking.v1.AccessPointStatus' + networking.v1.DnsRecordList: + type: object + description: |- + DNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records. + + ## The DNS Records Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecordList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + DNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records. + + ## The DNS Records Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.DnsRecord: + type: object + description: |- + DNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records. + + ## The DNS Records Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - DnsRecord + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.DnsRecordSpec' + status: + $ref: '#/components/schemas/networking.v1.DnsRecordStatus' + networking.v1.GatewayList: + type: object + description: |- + A Gateway represents a slice of traffic capacity in a region that is reserved for a customer. + + + ## The Gateways Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `gateways_per_region_per_environment` | Number of Gateways per region per environment | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - GatewayList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + A Gateway represents a slice of traffic capacity in a region that is reserved for a customer. + + + ## The Gateways Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `gateways_per_region_per_environment` | Number of Gateways per region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + networking.v1.Gateway: + type: object + description: |- + A Gateway represents a slice of traffic capacity in a region that is reserved for a customer. + + + ## The Gateways Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `gateways_per_region_per_environment` | Number of Gateways per region per environment | + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Gateway + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/networking.v1.GatewaySpec' + status: + $ref: '#/components/schemas/networking.v1.GatewayStatus' + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + networking.v1.NetworkSpec: + type: object + description: The desired state of the Network + properties: + display_name: + type: string + description: The name of the network + example: prod-aws-us-east1 + cloud: + type: string + description: The cloud service provider in which the network exists. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: The cloud service provider region in which the network exists. + example: us-east-1 + x-immutable: true + connection_types: + type: array + description: The connection types requested for use with the network. + items: + $ref: '#/components/schemas/networking.v1.ConnectionType' + uniqueItems: true + minItems: 1 + x-immutable: true + cidr: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+/\d+$ + description: | + The IPv4 [CIDR block](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) to used for this network. + Must be `/16`. Required for VPC peering and AWS TransitGateway. + example: 10.200.0.0/16 + x-immutable: true + zones: + type: array + items: + type: string + uniqueItems: true + minItems: 3 + maxItems: 3 + description: | + The 3 availability zones for this network. They can optionally be specified for AWS networks + used with PrivateLink, for GCP networks used with Private Service Connect, and for AWS and GCP + networks used with Peering. + Otherwise, they are automatically chosen by Confluent Cloud. + + On AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) + (e.g. use1-az3) + + On GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones) + (e.g. us-central1-c). + + On Azure, zones are Confluent-chosen names (e.g. 1, 2, 3) since Azure does not + have universal zone identifiers. + example: + - use1-az1 + - use1-az2 + - use1-az3 + x-immutable: true + zones_info: + type: array + minItems: 3 + maxItems: 3 + uniqueItems: true + items: + $ref: '#/components/schemas/networking.v1.ZoneInfo' + description: | + Each item represents information related to a single zone. + + Note - The attribute is in a [Limited Availability lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + x-immutable: true + dns_config: + description: | + DNS config only applies to PrivateLink network connection type. + + When resolution is CHASED_PRIVATE, clusters in this network require both public and private DNS + to resolve cluster endpoints. + + When resolution is PRIVATE, clusters in this network only require private DNS + to resolve cluster endpoints. + x-immutable: true + type: object + required: + - resolution + properties: + resolution: + type: string + description: Network DNS resolution type. + x-extensible-enum: + - CHASED_PRIVATE + - PRIVATE + reserved_cidr: + type: string + description: | + The reserved CIDR config is used only by AWS networks with connection_types = Vpc_Peering or Transit_Gateway + + An IPv4 [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + reserved for Confluent Cloud Network. Must be \24. + If not specified, Confluent Cloud Network uses 172.20.255.0/24 + + Note - The attribute is in a [Limited Availability lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + example: 172.20.255.0/24 + x-immutable: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + gateway: + nullable: true + description: The gateway associated with this object. The gateway can be one of networking.v1.Gateway. May be `null` or omitted if not associated with a gateway. + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.NetworkStatus: + type: object + required: + - phase + - supported_connection_types + - active_connection_types + description: The status of the Network + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - READY + - FAILED + - DEPROVISIONING + description: | + The lifecyle phase of the network: + + PROVISIONING: network provisioning is in progress; + + READY: network is ready; + + FAILED: provisioning failed; + + DEPROVISIONING: network deprovisioning is in progress; + readOnly: true + example: READY + supported_connection_types: + type: array + description: The connection types this network supports. + items: + $ref: '#/components/schemas/networking.v1.ConnectionType' + uniqueItems: true + minItems: 1 + readOnly: true + active_connection_types: + type: array + description: The connection types requested for use with the network. + items: + $ref: '#/components/schemas/networking.v1.ConnectionType' + uniqueItems: true + minItems: 1 + readOnly: true + error_code: + type: string + description: Error code if network is in a failed state. May be used for programmatic error checking. + readOnly: true + example: insufficient_capacity + error_message: + type: string + description: Displayable error message if network is in a failed state + readOnly: true + example: Could not provision cloud resources + dns_domain: + type: string + description: The root DNS domain for the network if applicable. Present on networks that support PrivateLink. + example: 00000.us-east-1.aws.glb.confluent.cloud + readOnly: true + endpoint_suffix: + type: string + description: | + The endpoint suffix for the network, if applicable. Full service endpoints can be constructed by appending + the service identifier to the beginning of the endpoint suffix. For example, the Flink REST endpoint can be + constructed by adding "flink" - 'https://flink' + 'endpoint_suffix'. + example: .00000.us-east-1.aws.glb.confluent.cloud + readOnly: true + zonal_subdomains: + type: object + additionalProperties: + type: string + description: | + The DNS subdomain for each zone. Present on networks that support PrivateLink. Keys are zones and + values are DNS domains. + example: + use1-az1: use1-az1.00000.us-east-1.aws.confluent.cloud + use1-az4: use1-az4.00000.us-east-1.aws.confluent.cloud + use1-az5: use1-az5.00000.us-east-1.aws.confluent.cloud + readOnly: true + cloud: + type: object + description: The cloud-specific network details. These will be populated when the network reaches the READY state. + discriminator: + propertyName: kind + mapping: + AwsNetwork: '#/components/schemas/networking.v1.AwsNetwork' + GcpNetwork: '#/components/schemas/networking.v1.GcpNetwork' + AzureNetwork: '#/components/schemas/networking.v1.AzureNetwork' + readOnly: true + required: + - kind + - vpc + - account + - project + - vpc_network + - vnet + - subscription + properties: + kind: + description: Network kind type. + type: string + enum: + - AwsNetwork + vpc: + type: string + description: The Confluent Cloud VPC ID. + example: vpc-00000000000000000 + readOnly: true + account: + type: string + description: The AWS account ID associated with the Confluent Cloud VPC. + example: '000000000000' + readOnly: true + private_link_endpoint_service: + type: string + description: The endpoint service of the Confluent Cloud VPC. (used for PrivateLink) if available. + example: com.amazonaws.vpce.eu-west-3.vpce-00000000000000000 + readOnly: true + project: + type: string + description: The GCP Project ID associated with the Confluent Cloud VPC. + example: cc-prod-3 + readOnly: true + vpc_network: + type: string + description: The network name of the Confluent Cloud VPC. + example: prod-network + readOnly: true + private_service_connect_service_attachments: + type: object + description: | + The mapping of zones to Private Service Connect Service + Attachments if available. Keys are zones and values are + [GCP Private Service Connect Service + Attachment](https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#api_7) + additionalProperties: + type: string + example: + us-central1-a: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-a + us-central1-b: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-b + us-central1-c: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-c + readOnly: true + vnet: + type: string + description: The resource ID of the Confluent Cloud VNet. + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/prod-group/providers/Microsoft.Network/virtualNetworks/prod-network + readOnly: true + subscription: + type: string + description: The Azure Subscription ID associated with the Confluent Cloud VPC. + example: 00000000-0000-0000-0000-000000000000 + readOnly: true + private_link_service_aliases: + type: object + description: | + The mapping of zones to Private Link Service Aliases if available. Keys are zones + and values are [Azure Private Link Service + Aliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service). + additionalProperties: + type: string + example: + '1': 0-00000-privatelink-1.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '2': 0-00000-privatelink-2.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '3': 0-00000-privatelink-3.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + readOnly: true + private_link_service_resource_ids: + type: object + description: | + The mapping of zones to Private Link Service Resource IDs if available. Keys are zones + and values are [Azure Private Link Service Resource + IDs](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service). + additionalProperties: + type: string + example: + '1': /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-1 + '2': /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-2 + '3': /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-3 + readOnly: true + idle_since: + type: string + format: date-time + example: '2024-01-01T00:00:00.000Z' + description: The date and time when the network becomes idle + readOnly: true + readOnly: true + networking.v1.PeeringSpec: + type: object + description: The desired state of the Peering + properties: + display_name: + type: string + description: The name of the peering + example: prod-peering-use1 + cloud: + type: object + discriminator: + propertyName: kind + mapping: + AwsPeering: '#/components/schemas/networking.v1.AwsPeering' + GcpPeering: '#/components/schemas/networking.v1.GcpPeering' + AzurePeering: '#/components/schemas/networking.v1.AzurePeering' + description: The cloud-specific peering details. + x-immutable: true + title: AWS + required: + - kind + - account + - vpc + - routes + - customer_region + - project + - vpc_network + - tenant + - vnet + properties: + kind: + description: Peering kind type. + type: string + enum: + - AwsPeering + account: + type: string + pattern: ^\d{12}$ + example: '000000000000' + description: The AWS account ID associated with the VPC you are peering with Confluent Cloud network. + vpc: + type: string + minLength: 1 + description: The VPC ID you are peering with Confluent Cloud network. + example: vpc-00000000000000000 + routes: + type: array + items: + $ref: '#/components/schemas/networking.v1.Cidr' + description: | + The [CIDR blocks](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) of the VPC you are peering + with Confluent Cloud network. This is used by Confluent Cloud network to route traffic back to your network. + The CIDR block must be a private range and cannot overlap with the Confluent Cloud CIDR block. + example: + - 10.108.16.0/21 + customer_region: + type: string + description: The region of the VPC you are peering with Confluent Cloud network. + example: us-east-1 + project: + type: string + minLength: 1 + description: | + The Google Cloud project ID associated with the VPC that you are peering with Confluent Cloud network. + example: my-gcp-project + vpc_network: + type: string + minLength: 1 + description: The name of the VPC that you are peering with Confluent Cloud network. + example: my-gcp-network + import_custom_routes: + type: boolean + description: | + Enable customer route import. For more information, see + [Importing custom routes](https://cloud.google.com/vpc/docs/vpc-peering#importing-exporting-routes). + example: true + default: false + tenant: + type: string + minLength: 1 + description: | + The Azure Tenant ID in which your Azure Subscription exists. + Represents an organization in Azure Active Directory. You can find your Azure Tenant ID in the Azure Portal + under + [Azure Active Directory](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview). + Must be a valid **32 character UUID string**. + vnet: + type: string + minLength: 1 + description: The resource ID of the VNet that you are peering with Confluent Cloud. You can find the name of your Azure VNet in the [Azure Portal on the Overview tab of your Azure Virtual Network](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Network%2FvirtualNetworks). + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + network: + description: The network to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.PeeringStatus: + type: object + required: + - phase + description: The status of the Peering + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PENDING_ACCEPT + - READY + - FAILED + - DEPROVISIONING + - DISCONNECTED + description: | + The lifecycle phase of the peering: + + PROVISIONING: peering provisioning is in progress; + + PENDING_ACCEPT: peering connection request is pending acceptance by the customer; + + READY: peering is ready; + + FAILED: peering is in a failed state; + + DEPROVISIONING: peering deprovisioning is in progress; + + DISCONNECTED: peering has been disconnected in the cloud provider by the customer; + readOnly: true + example: READY + error_code: + type: string + description: Error code if peering is in a failed state. May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if peering is in a failed state + readOnly: true + readOnly: true + networking.v1.TransitGatewayAttachmentSpec: + type: object + description: The desired state of the Transit Gateway Attachment + properties: + display_name: + type: string + description: The name of the TGW attachment + example: prod-tgw-use1 + cloud: + type: object + discriminator: + propertyName: kind + mapping: + AwsTransitGatewayAttachment: '#/components/schemas/networking.v1.AwsTransitGatewayAttachment' + description: The cloud-specific Transit Gateway details. + x-immutable: true + title: AWS + required: + - kind + - ram_share_arn + - transit_gateway_id + - routes + properties: + kind: + description: AWS Transit Gateway Attachment kind type. + type: string + enum: + - AwsTransitGatewayAttachment + ram_share_arn: + description: The full AWS Resource Name (ARN) for the AWS Resource Access Manager (RAM) Share of the Transit Gateways that you want Confluent Cloud to be attached to. + type: string + example: arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx + transit_gateway_id: + description: The ID of the AWS Transit Gateway that you want Confluent CLoud to be attached to. + type: string + example: tgw-xxxxxxxxxxxxxxxxx + routes: + type: array + items: + $ref: '#/components/schemas/networking.v1.Cidr' + description: List of destination routes. + example: + - 100.64.0.0/10 + - 10.0.0.0/8 + - 192.168.0.0/16 + - 172.16.0.0/12 + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + network: + description: The network to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.TransitGatewayAttachmentStatus: + type: object + required: + - phase + description: The status of the Transit Gateway Attachment + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - READY + - PENDING_ACCEPT + - FAILED + - DEPROVISIONING + - DISCONNECTED + - ERROR + description: | + The lifecycle phase of the TGW attachment: + + PROVISIONING: attachment provisioning is in progress; + + PENDING_ACCEPT: attachment request is pending acceptance by the customer; + + READY: attachment is ready; + + FAILED: attachment is in a failed state; + + DEPROVISIONING: attachment deprovisioning is in progress; + + DISCONNECTED: attachment was manually deleted directly in the cloud provider by the customer; + + ERROR: invalid customer input during attachment creation. + readOnly: true + example: READY + error_code: + type: string + description: Error code if TGW attachment is in a failed state. May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if TGW attachment is in a failed state + readOnly: true + cloud: + type: object + description: The cloud-specific TGW attachment details. + discriminator: + propertyName: kind + mapping: + AwsTransitGatewayAttachmentStatus: '#/components/schemas/networking.v1.AwsTransitGatewayAttachmentStatus' + readOnly: true + title: AWS + required: + - transit_gateway_attachment_id + properties: + kind: + description: AWS Transit Gateway Attachment Status kind type. + type: string + enum: + - AwsTransitGatewayAttachmentStatus + transit_gateway_attachment_id: + description: The ID of the AWS Transit Gateway VPC Attachment that attaches Confluent VPC to Transit Gateway. + type: string + example: tgw-attach-xxxxx + readOnly: true + readOnly: true + networking.v1.PrivateLinkAccessSpec: + type: object + description: The desired state of the Private Link Access + properties: + display_name: + type: string + description: The name of the PrivateLink access + example: prod-pl-use1 + cloud: + type: object + discriminator: + propertyName: kind + mapping: + AwsPrivateLinkAccess: '#/components/schemas/networking.v1.AwsPrivateLinkAccess' + AzurePrivateLinkAccess: '#/components/schemas/networking.v1.AzurePrivateLinkAccess' + GcpPrivateServiceConnectAccess: '#/components/schemas/networking.v1.GcpPrivateServiceConnectAccess' + description: The cloud-specific PrivateLink details. + x-immutable: true + title: AWS + required: + - kind + - account + - subscription + - project + properties: + kind: + description: PrivateLink kind type. + type: string + enum: + - AwsPrivateLinkAccess + account: + type: string + pattern: ^\d{12}$ + example: '000000000000' + description: | + The AWS account ID for the account containing the VPCs you want to connect from using AWS PrivateLink. + You can find your AWS account ID [here](https://console.aws.amazon.com/billing/home?#/account) + under **My Account** in your AWS Management Console. Must be a **12 character string**. + subscription: + type: string + minLength: 1 + description: | + The Azure subscription ID for the account containing the VNets you want to connect from using + Azure Private Link. You can find your Azure subscription ID in the subscription section of your + [Microsoft Azure Portal](https://portal.azure.com/#blade/Microsoft_Azure_Billing/SubscriptionsBlade). + Must be a valid **32 character UUID string**. + project: + type: string + minLength: 1 + description: | + The GCP project ID for the account containing the VPCs that you want to connect from + using Private Service Connect. You can find your Google Cloud Project ID under **Project ID** section of + your [Google Cloud Console dashboard](https://console.cloud.google.com/home/dashboard). + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + network: + description: The network to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.PrivateLinkAccessStatus: + type: object + required: + - phase + description: The status of the Private Link Access + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - READY + - FAILED + - DEPROVISIONING + description: | + The lifecycle phase of the PrivateLink access configuration: + + PROVISIONING: PrivateLink access provisioning is in progress; + + READY: PrivateLink access is ready; + + FAILED: PrivateLink access is in a failed state; + + DEPROVISIONING: PrivateLink access deprovisioning is in progress; + readOnly: true + example: READY + error_code: + type: string + description: Error code if PrivateLink access is in a failed state. May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if PrivateLink access is in a failed state + readOnly: true + readOnly: true + networking.v1.NetworkLinkServiceSpec: + type: object + description: The desired state of the Network Link Service + properties: + display_name: + type: string + description: The name of the network link service + example: prod-net-1-nls + description: + type: string + description: The description of the network link service + example: Allow connections from analytics hub + accept: + description: Network Link Service Accept policy + type: object + title: Network Link Service + properties: + environments: + description: | + List of environments from which connections can be accepted. + All networks win the list of environment will be allowed. + type: array + items: + type: string + uniqueItems: true + networks: + description: | + List of networks from which connections can be accepted. + type: array + items: + type: string + uniqueItems: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + description: The network to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.NetworkLinkServiceStatus: + type: object + required: + - phase + description: The status of the Network Link Service + properties: + phase: + type: string + x-extensible-enum: + - READY + description: | + The lifecycle phase of the network link service: + + READY: network link service is ready; + readOnly: true + example: READY + error_code: + type: string + description: | + Error code if network link service is in a failed state. + May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if network link service is in a failed state + readOnly: true + readOnly: true + networking.v1.NetworkLinkEndpointSpec: + type: object + description: The desired state of the Network Link Endpoint + properties: + display_name: + type: string + description: The name of the network link endpoint + example: prod-net-1-nle + description: + type: string + description: The description of the network link endpoint + example: Connect to Network - analytics hub + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + description: The network to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network_link_service: + description: The network_link_service to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.NetworkLinkEndpointStatus: + type: object + required: + - phase + description: The status of the Network Link Endpoint + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PENDING_ACCEPT + - READY + - FAILED + - DEPROVISIONING + - EXPIRED + - DISCONNECTED + - DISCONNECTING + - INACTIVE + description: | + The lifecycle phase of the network link endpoint: + + PROVISIONING: network link endpoint provisioning is in progress; + + PENDING_ACCEPT: network link endpoint request is pending acceptance by the the owner of the target; + + READY: network link endpoint is ready; + + FAILED: network link endpoint is in a failed state; + + DEPROVISIONING: network link endpoint deprovisioning is in progress; + + EXPIRED: network link endpoint request is expired, can only be deleted; + + DISCONNECTED: network link endpoint is in a disconnected state, target owner has removed the permissions; + + DISCONNECTING: network link endpoint disconnection is in progress; + + INACTIVE: network link endpoint is created, but not active since there are no clusters in the network; + readOnly: true + example: READY + error_code: + type: string + description: Error code if network link is in a failed state. May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if network link is in a failed state + readOnly: true + expires_at: + type: string + format: date-time + example: '2024-01-01T00:00:00.000Z' + description: The date and time when the request expires if it is not accepted by the target network admin. + readOnly: true + readOnly: true + networking.v1.NetworkLinkServiceAssociationSpec: + type: object + description: The desired state of the Network Link Service Association + properties: + display_name: + type: string + description: The name of the network link endpoint + readOnly: true + example: prod-net-1-nle + description: + type: string + description: The description of the network link endpoint + readOnly: true + example: Connect to Network - analytics hub + network_link_endpoint: + type: string + description: ID of the Network link endpoint. + readOnly: true + example: prod-net-1-nle + network_link_service: + description: The network_link_service to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.NetworkLinkServiceAssociationStatus: + type: object + required: + - phase + description: The status of the Network Link Service Association + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PENDING_ACCEPT + - READY + - FAILED + - DEPROVISIONING + - EXPIRED + - DISCONNECTED + - DISCONNECTING + - INACTIVE + description: | + The lifecycle phase of the network link endpoint: + + PROVISIONING: network link endpoint provisioning is in progress; + + PENDING_ACCEPT: network link endpoint request is pending acceptance by the the owner of the target; + + READY: network link endpoint is ready; + + FAILED: network link endpoint is in a failed state; + + DEPROVISIONING: network link endpoint deprovisioning is in progress; + + EXPIRED: network link endpoint request is expired, can only be deleted; + + DISCONNECTED: network link endpoint is in a disconnected state, target owner has removed the permissions; + + DISCONNECTING: network link endpoint disconnection is in progress; + + INACTIVE: network link endpoint is created, but not active since there are no clusters in the network; + example: READY + readOnly: true + error_code: + type: string + description: Error code if network link is in a failed state. May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if network link is in a failed state + readOnly: true + expires_at: + type: string + format: date-time + example: '2024-01-01T00:00:00.000Z' + description: The date and time when the request expires if it is not accepted by the target network admin. + readOnly: true + readOnly: true + networking.v1.IpAddress: + type: object + description: |- + IP Addresses + + Related guide: [Use Public Egress IP addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) + + ## The IP Addresses Model + + properties: + api_version: + type: string + enum: + - networking/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IpAddress + ip_prefix: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+/\d+$ + description: The IP Address range. + example: 10.200.0.0/28 + cloud: + type: string + description: The cloud service provider in which the address exists. + x-extensible-enum: + - AWS + - GCP + - AZURE + - ANY + example: AWS + region: + type: string + description: The region/location where the IP Address is in use. + example: us-east-1 + services: + type: array + description: The service types that will use the address. + items: + type: string + description: Address service type. + x-extensible-enum: + - KAFKA + - CONNECT + - EXTERNAL_OAUTH + example: CONNECT + uniqueItems: true + minItems: 1 + address_type: + type: string + description: Whether the address is used for egress or ingress. + x-extensible-enum: + - INGRESS + - EGRESS + example: EGRESS + networking.v1.PrivateLinkAttachmentSpec: + type: object + description: The desired state of the Private Link Attachment + properties: + display_name: + type: string + description: The name of the PrivateLink attachment. + example: prod-aws-us-east1 + cloud: + type: string + description: | + The cloud service provider that hosts the resources to access with the PrivateLink attachment. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: | + The cloud service provider region where the resources to be accessed + using the PrivateLink attachment are located. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.PrivateLinkAttachmentStatus: + type: object + required: + - phase + description: The status of the Private Link Attachment + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - WAITING_FOR_CONNECTIONS + - READY + - FAILED + - EXPIRED + - DEPROVISIONING + description: | + The lifecycle phase of the PrivateLink attachment: + + PROVISIONING: PrivateLink attachment provisioning is in progress; + + WAITING_FOR_CONNECTIONS: PrivateLink attachment is waiting for connections; + + READY: PrivateLink attachment is ready; + + FAILED: PrivateLink attachment is in a failed state; + + EXPIRED: PrivateLink attachment has timed out waiting for connections, can only be deleted; + + DEPROVISIONING: PrivateLink attachment deprovisioning is in progress; + readOnly: true + example: READY + error_code: + type: string + description: Error code if PrivateLink attachment is in a failed state. May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if PrivateLink attachment is in a failed state. + readOnly: true + dns_domain: + type: string + description: The root DNS domain for the PrivateLink attachment. + example: us-east-1.aws.private.confluent.cloud + readOnly: true + cloud: + type: object + description: The cloud specific status of the PrivateLink attachment. These will be populated when the PrivateLink attachment reaches the WAITING_FOR_CONNECTIONS state. + discriminator: + propertyName: kind + mapping: + AwsPrivateLinkAttachmentStatus: '#/components/schemas/networking.v1.AwsPrivateLinkAttachmentStatus' + AzurePrivateLinkAttachmentStatus: '#/components/schemas/networking.v1.AzurePrivateLinkAttachmentStatus' + GcpPrivateLinkAttachmentStatus: '#/components/schemas/networking.v1.GcpPrivateLinkAttachmentStatus' + readOnly: true + required: + - kind + - vpc_endpoint_service + - private_link_service + - service_attachment + properties: + kind: + type: string + description: PrivateLinkAttachmentStatus kind. + enum: + - AwsPrivateLinkAttachmentStatus + readOnly: true + vpc_endpoint_service: + description: | + AWS VPC Endpoint Service that can be used to establish connections for all zones. + type: object + readOnly: true + required: + - vpc_endpoint_service_name + properties: + vpc_endpoint_service_name: + type: string + description: Id of the VPC Endpoint service. + readOnly: true + private_link_service: + description: | + Azure PrivateLink service that can be used to connect to a PrivateEndpoint. + type: object + readOnly: true + required: + - private_link_service_alias + - private_link_service_resource_id + properties: + private_link_service_alias: + description: Azure PrivateLink service alias. + type: string + minLength: 1 + readOnly: true + example: pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Azure PrivateLink service resource id. + type: string + minLength: 1 + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef + service_attachment: + description: | + GCP PSC Service attachment that can be used to connect + to a PSC Endpoint. + type: object + readOnly: true + required: + - private_service_connect_service_attachment + properties: + private_service_connect_service_attachment: + description: Id of a Private Service Connect Service Attachment in Confluent Cloud. + type: string + minLength: 1 + readOnly: true + example: projects/example-project/regions/us-central1/serviceAttachments/plt-abcdef-service-attachment-us-central1 + readOnly: true + networking.v1.PrivateLinkAttachmentConnectionSpec: + type: object + description: The desired state of the Private Link Attachment Connection + properties: + display_name: + type: string + description: The name of the PrivateLink attachment connection. + example: prod-gcp-us-central1-a + cloud: + type: object + description: The cloud-specific PrivateLink attachment connection details. + discriminator: + propertyName: kind + mapping: + AwsPrivateLinkAttachmentConnection: '#/components/schemas/networking.v1.AwsPrivateLinkAttachmentConnection' + AzurePrivateLinkAttachmentConnection: '#/components/schemas/networking.v1.AzurePrivateLinkAttachmentConnection' + GcpPrivateLinkAttachmentConnection: '#/components/schemas/networking.v1.GcpPrivateLinkAttachmentConnection' + x-immutable: true + required: + - kind + - vpc_endpoint_id + - private_endpoint_resource_id + - private_service_connect_connection_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnection kind. + enum: + - AwsPrivateLinkAttachmentConnection + vpc_endpoint_id: + description: Id of a VPC Endpoint that is connected to the VPC Endpoint service. + type: string + minLength: 1 + example: vpce-00000000000000000 + private_endpoint_resource_id: + description: | + Resource Id of the PrivateEndpoint that is connected to the PrivateLink service. + type: string + minLength: 1 + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3 + private_service_connect_connection_id: + description: Id of the Private Service connection. + type: string + minLength: 1 + example: '00000000000000000' + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + private_link_attachment: + description: The private_link_attachment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.PrivateLinkAttachmentConnectionStatus: + type: object + required: + - phase + description: The status of the Private Link Attachment Connection + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - READY + - FAILED + - DEPROVISIONING + - DISCONNECTED + description: | + The lifecycle phase of the PrivateLink attachment: + + PROVISIONING: PrivateLink attachment connection provisioning is in progress; + + READY: PrivateLink attachment connection is ready; + + FAILED: PrivateLink attachment connection is in a failed state; + + DEPROVISIONING: PrivateLink attachment connection deprovisioning is in progress; + + DISCONNECTED:| + PrivateLink attachment connection is in a disconnected state. This means the + private endpoint associated with this PrivateLink attachment connection has been deleted; + readOnly: true + example: READY + error_code: + type: string + description: Error code if PrivateLink attachment connection is in a failed state. May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if PrivateLink attachment connection is in a failed state. + readOnly: true + cloud: + type: object + description: The cloud specific status of the PrivateLink attachment connection. + discriminator: + propertyName: kind + mapping: + AwsPrivateLinkAttachmentConnectionStatus: '#/components/schemas/networking.v1.AwsPrivateLinkAttachmentConnectionStatus' + AzurePrivateLinkAttachmentConnectionStatus: '#/components/schemas/networking.v1.AzurePrivateLinkAttachmentConnectionStatus' + GcpPrivateLinkAttachmentConnectionStatus: '#/components/schemas/networking.v1.GcpPrivateLinkAttachmentConnectionStatus' + readOnly: true + required: + - kind + - vpc_endpoint_service_name + - vpc_endpoint_id + - private_link_service_alias + - private_link_service_resource_id + - private_endpoint_resource_id + - private_service_connect_service_attachment + - private_service_connect_connection_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnectionStatus kind. + enum: + - AwsPrivateLinkAttachmentConnectionStatus + vpc_endpoint_service_name: + description: Id of the VPC Endpoint service used for PrivateLink. + type: string + minLength: 1 + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + readOnly: true + vpc_endpoint_id: + description: Id of the VPC Endpoint (if any) that is connected to the VPC Endpoint service. + type: string + minLength: 1 + readOnly: true + example: vpce-00000000000000000 + private_link_service_alias: + description: Azure PrivateLink service alias. + type: string + minLength: 1 + readOnly: true + example: pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Azure PrivateLink service resource id. + type: string + minLength: 1 + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3 + private_endpoint_resource_id: + description: | + Resource Id of the PrivateEndpoint (if any) that is connected to + the PrivateLink service. + type: string + minLength: 1 + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3 + private_service_connect_service_attachment: + description: GCP Private Service Connect ServiceAttachment. + type: string + minLength: 1 + readOnly: true + example: projects/example-project/regions/us-central1/serviceAttachments/plt-abcdef-service-attachment-us-central1-a + private_service_connect_connection_id: + description: Id of the Private Service connection. + type: string + minLength: 1 + readOnly: true + example: '00000000000000000' + readOnly: true + networking.v1.DnsForwarderSpec: + type: object + description: The desired state of the Dns Forwarder + properties: + display_name: + type: string + description: The name of the DNS forwarder + example: prod-dnsf-1 + domains: + type: array + items: + type: string + uniqueItems: true + minItems: 0 + maxItems: 10 + description: List of domains for the DNS forwarder to use + example: + - example.com + - domainname.com + config: + type: object + discriminator: + propertyName: kind + mapping: + ForwardViaIp: '#/components/schemas/networking.v1.ForwardViaIp' + description: The specific details of different kinds of configuration for DNS Forwarder. + title: ForwardViaIp + required: + - kind + - dns_server_ips + properties: + kind: + description: DNS Forwarder Configured via DNS Server IPs kind type. + type: string + enum: + - ForwardViaIp + dns_server_ips: + type: array + items: + $ref: '#/components/schemas/networking.v1.Ip' + uniqueItems: true + minItems: 1 + maxItems: 3 + description: List of IP addresses of the DNS server + example: + - 10.200.0.0 + - 10.200.0.1 + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + gateway: + description: The gateway to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.DnsForwarderStatus: + type: object + required: + - phase + description: The status of the Dns Forwarder + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - CREATED + - READY + - DEGRADED + - FAILED + - DEPROVISIONING + description: | + The lifecycle phase of the DNS forwarder: + + PROVISIONING: DNS forwarder provisioning is in progress; + + CREATED: DNS forwarder is created. It will automatically become ready once a Kafka cluster is provisioned; + + READY: DNS forwarder is ready; + + FAILED: DNS forwarder is in a failed state; + + DEGRADED: DNS forwarder is in a degraded state, transitioning from 'READY' due to unreachable DNS resolvers; + + DEPROVISIONING: DNS forwarder deprovisioning is in progress; + readOnly: true + example: READY + error_code: + type: string + description: Error code if dns forwarder is in a failed state. May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if dns forwarder is in a failed state + readOnly: true + readOnly: true + networking.v1.AccessPointSpec: + type: object + description: The desired state of the Access Point + properties: + display_name: + type: string + description: The name of the access point. + example: prod-ap-egress-usw2 + config: + type: object + discriminator: + propertyName: kind + mapping: + AwsEgressPrivateLinkEndpoint: '#/components/schemas/networking.v1.AwsEgressPrivateLinkEndpoint' + AwsIngressPrivateLinkEndpoint: '#/components/schemas/networking.v1.AwsIngressPrivateLinkEndpoint' + AzureEgressPrivateLinkEndpoint: '#/components/schemas/networking.v1.AzureEgressPrivateLinkEndpoint' + AzureIngressPrivateLinkEndpoint: '#/components/schemas/networking.v1.AzureIngressPrivateLinkEndpoint' + AwsPrivateNetworkInterface: '#/components/schemas/networking.v1.AwsPrivateNetworkInterface' + GcpEgressPrivateServiceConnectEndpoint: '#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectEndpoint' + GcpIngressPrivateServiceConnectEndpoint: '#/components/schemas/networking.v1.GcpIngressPrivateServiceConnectEndpoint' + description: The specific details of the different access point configurations. + required: + - kind + - vpc_endpoint_service_name + - vpc_endpoint_id + - private_link_service_resource_id + - private_endpoint_resource_id + - private_service_connect_endpoint_target + - private_service_connect_connection_id + properties: + kind: + type: string + description: AwsEgressPrivateLinkEndpoint kind. + enum: + - AwsEgressPrivateLinkEndpoint + vpc_endpoint_service_name: + description: ID of the VPC Endpoint service used for PrivateLink. + type: string + minLength: 1 + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + enable_high_availability: + type: boolean + description: Whether a resource should be provisioned with high availability. Endpoints deployed with high availability have network interfaces deployed in multiple AZs. + example: false + x-immutable: true + target_system: + type: string + description: '[Used by the Confluent Cloud Console] The target system or service that the PrivateLink Endpoint connects to (e.g. "MONGODB" or "SNOWFLAKE").' + example: S3 + vpc_endpoint_id: + description: ID of a VPC Endpoint that will be connected to the VPC Endpoint service. + type: string + minLength: 1 + example: vpce-00000000000000000 + x-immutable: true + private_link_service_resource_id: + description: Resource ID of the Azure Private Link service. + type: string + minLength: 1 + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3 + private_link_subresource_name: + type: string + description: Name of the subresource for the Private Endpoint to connect to. + example: sqlServer + private_endpoint_resource_id: + description: Resource ID of a Private Endpoint that will be connected to the Private Link service. + type: string + minLength: 1 + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-centralus-rg/providers/Microsoft.Network/privateEndpoints/private-endpoint-azure-centralus + x-immutable: true + network_interfaces: + description: List of the IDs of the Elastic Network Interfaces. + type: array + items: + type: string + uniqueItems: true + minItems: 51 + example: + - eni-00000000000000000 + - eni-00000000000000001 + - eni-00000000000000002 + - eni-00000000000000003 + - eni-00000000000000004 + - eni-00000000000000005 + - eni-00000000000000006 + - eni-00000000000000007 + - eni-00000000000000008 + - eni-00000000000000009 + - eni-00000000000000010 + - eni-00000000000000011 + - eni-00000000000000012 + - eni-00000000000000013 + - eni-00000000000000014 + - eni-00000000000000015 + - eni-00000000000000016 + - eni-00000000000000017 + - eni-00000000000000018 + - eni-00000000000000019 + - eni-00000000000000020 + - eni-00000000000000021 + - eni-00000000000000022 + - eni-00000000000000023 + - eni-00000000000000024 + - eni-00000000000000025 + - eni-00000000000000026 + - eni-00000000000000027 + - eni-00000000000000028 + - eni-00000000000000029 + - eni-00000000000000030 + - eni-00000000000000031 + - eni-00000000000000032 + - eni-00000000000000033 + - eni-00000000000000034 + - eni-00000000000000035 + - eni-00000000000000036 + - eni-00000000000000037 + - eni-00000000000000038 + - eni-00000000000000039 + - eni-00000000000000040 + - eni-00000000000000041 + - eni-00000000000000042 + - eni-00000000000000043 + - eni-00000000000000044 + - eni-00000000000000045 + - eni-00000000000000046 + - eni-00000000000000047 + - eni-00000000000000048 + - eni-00000000000000049 + - eni-00000000000000050 + account: + type: string + pattern: ^\d{12}$ + example: '000000000000' + description: The AWS account ID associated with the ENIs you are using for the Confluent Private Network Interface. + x-immutable: true + egress_routes: + type: array + description: List of egress CIDRs (IPv4) for egress PNI. + items: + type: string + uniqueItems: true + example: + - 10.0.0.0/16 + - 10.1.0.0/16 + - 10.2.0.0/16 + - 172.16.0.0/16 + private_service_connect_endpoint_target: + description: URI of the service attachment for the published service that the Private Service Connect Endpoint connects to or "ALL_GOOGLE_APIS" for global Google APIs. + type: string + minLength: 1 + example: projects/project-name/regions/us-central1/serviceAttachments/service-attachment-name + private_service_connect_connection_id: + description: The ID of the Private Service Connect connection. + type: string + minLength: 1 + example: '00000000000000000' + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + gateway: + description: The gateway to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.AccessPointStatus: + type: object + required: + - phase + description: The status of the Access Point + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PENDING_ACCEPT + - READY + - FAILED + - DEPROVISIONING + - DISCONNECTED + - DEGRADED + - ERROR + description: | + The lifecycle phase of the access point: + + PROVISIONING: Access point provisioning is in progress; + + PENDING_ACCEPT: Access point connection request is pending acceptance by the customer; + + READY: Access point is ready; + + FAILED: Access point is in a failed state; + + DEPROVISIONING: Access point deprovisioning is in progress; + + DISCONNECTED: Access Point has been disconnected in the cloud provider by the customer; + + DEGRADED: Access Point is experiencing reduced performance or partial failure; + + ERROR: Invalid customer input during Access Point creation; + readOnly: true + example: READY + error_code: + type: string + description: Error code if access point is in a failed state. May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if access point is in a failed state. + readOnly: true + config: + type: object + description: Cloud specific status of the access point. + discriminator: + propertyName: kind + mapping: + AwsEgressPrivateLinkEndpointStatus: '#/components/schemas/networking.v1.AwsEgressPrivateLinkEndpointStatus' + AwsIngressPrivateLinkEndpointStatus: '#/components/schemas/networking.v1.AwsIngressPrivateLinkEndpointStatus' + AzureEgressPrivateLinkEndpointStatus: '#/components/schemas/networking.v1.AzureEgressPrivateLinkEndpointStatus' + AzureIngressPrivateLinkEndpointStatus: '#/components/schemas/networking.v1.AzureIngressPrivateLinkEndpointStatus' + GcpEgressPrivateServiceConnectEndpointStatus: '#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectEndpointStatus' + GcpIngressPrivateServiceConnectEndpointStatus: '#/components/schemas/networking.v1.GcpIngressPrivateServiceConnectEndpointStatus' + readOnly: true + title: AWS + required: + - kind + - vpc_endpoint_id + - vpc_endpoint_dns_name + - vpc_endpoint_service_name + - private_endpoint_resource_id + - private_endpoint_ip_address + - private_link_service_alias + - private_link_service_resource_id + - private_service_connect_endpoint_connection_id + - private_service_connect_endpoint_name + - private_service_connect_endpoint_ip_address + - private_service_connect_service_attachment + - private_service_connect_connection_id + properties: + kind: + description: AwsEgressPrivateLinkEndpointStatus kind. + type: string + enum: + - AwsEgressPrivateLinkEndpointStatus + vpc_endpoint_id: + description: ID of a VPC Endpoint (if any) that is connected to the VPC Endpoint service. + type: string + example: vpce-00000000000000000 + readOnly: true + vpc_endpoint_dns_name: + description: DNS name of a VPC Endpoint (if any) that is connected to the VPC Endpoint service. + type: string + example: vpce-00000000000000000-00000000.vpce-svc-00000000000000000.us-west-2.vpce.amazonaws.com + readOnly: true + vpc_endpoint_service_name: + description: ID of the Confluent Cloud VPC Endpoint service used for PrivateLink. + type: string + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + readOnly: true + dns_domain: + description: DNS domain name used to configure the Private Hosted Zone for the Access Point. + type: string + example: ap123abc.us-west-2.aws.accesspoint.confluent.cloud + readOnly: true + private_endpoint_resource_id: + description: Resource ID of the Private Endpoint (if any) that is connected to the Private Link service. + type: string + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3 + private_endpoint_domain: + description: Domain of the Private Endpoint (if any) that is connected to the Private Link service. + type: string + readOnly: true + example: dbname.database.windows.net + private_endpoint_ip_address: + description: IP address of the Private Endpoint (if any) that is connected to the Private Link service. + type: string + readOnly: true + example: 10.2.0.68 + private_endpoint_custom_dns_config_domains: + description: Domains of the Private Endpoint (if any) based off FQDNs in Azure custom DNS configs, which are required in your private DNS setup. + type: array + items: + type: string + readOnly: true + example: + - dbname.database.windows.net + - dbname-region.database.windows.net + private_link_service_alias: + description: Alias of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: plattg-123abc-privatelink.00000000-0000-0000-0000-000000000000.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Resource ID of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/plattg-123abc/providers/Microsoft.Network/privateLinkServices/plattg-123abc-privatelink + private_service_connect_endpoint_connection_id: + description: Connection ID of the Private Service Connect Endpoint (if any) that is connected to the endpoint target. + type: string + readOnly: true + example: '' + private_service_connect_endpoint_name: + description: Name of the Private Service Connect Endpoint (if any) that is connected to the endpoint target. + type: string + readOnly: true + example: plap-123456 + private_service_connect_endpoint_ip_address: + description: IP address of the Private Service Connect Endpoint (if any) that is connected to the endpoint target. + type: string + readOnly: true + example: 10.2.0.68 + private_service_connect_service_attachment: + description: URI of the Private Service Connect Service Attachment in Confluent Cloud. + type: string + readOnly: true + example: projects/traffic-prod/regions/us-central1/serviceAttachments/plattg-abc123-service-attachment + private_service_connect_connection_id: + description: The ID of the Private Service Connect connection. + type: string + readOnly: true + example: '00000000000000000' + readOnly: true + networking.v1.DnsRecordSpec: + type: object + description: The desired state of the Dns Record + properties: + display_name: + type: string + description: The name of the DNS record. + example: prod-dnsrec-1 + domain: + type: string + description: The fully qualified domain name of the DNS record. + example: example.com + x-immutable: true + config: + type: object + description: The config of the DNS record. + discriminator: + propertyName: kind + mapping: + PrivateLinkAccessPoint: '#/components/schemas/networking.v1.PrivateLinkAccessPoint' + required: + - kind + - resource_id + properties: + kind: + description: PrivateLinkAccessPoint kind. + type: string + enum: + - PrivateLinkAccessPoint + resource_id: + description: ID of the target resource. + type: string + minLength: 1 + example: ap-12345 + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + gateway: + description: The gateway to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.DnsRecordStatus: + type: object + required: + - phase + description: The status of the Dns Record + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - CREATED + - READY + - FAILED + - DEPROVISIONING + description: | + The lifecycle phase of the DNS record: + + PROVISIONING: DNS record provisioning is in progress; + + CREATED: DNS record is created. It will automatically become ready once a Kafka cluster is provisioned; + + READY: DNS record is ready; + + FAILED: DNS record is in a failed state; + + DEPROVISIONING: DNS record deprovisioning is in progress; + readOnly: true + example: READY + error_code: + type: string + description: Error code if the DNS record is in a failed state. May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if the DNS record is in a failed state. + readOnly: true + readOnly: true + networking.v1.GatewaySpec: + type: object + description: The desired state of the Gateway + properties: + display_name: + type: string + description: The name of the gateway. + example: prod-gateway + config: + type: object + description: Gateway type specific configuration. Please note that Peering configs are not supported in Create requests. + discriminator: + propertyName: kind + mapping: + AwsPrivateNetworkInterfaceGatewaySpec: '#/components/schemas/networking.v1.AwsPrivateNetworkInterfaceGatewaySpec' + AwsPeeringGatewaySpec: '#/components/schemas/networking.v1.AwsPeeringGatewaySpec' + AwsEgressPrivateLinkGatewaySpec: '#/components/schemas/networking.v1.AwsEgressPrivateLinkGatewaySpec' + AwsIngressPrivateLinkGatewaySpec: '#/components/schemas/networking.v1.AwsIngressPrivateLinkGatewaySpec' + AzurePeeringGatewaySpec: '#/components/schemas/networking.v1.AzurePeeringGatewaySpec' + AzureEgressPrivateLinkGatewaySpec: '#/components/schemas/networking.v1.AzureEgressPrivateLinkGatewaySpec' + AzureIngressPrivateLinkGatewaySpec: '#/components/schemas/networking.v1.AzureIngressPrivateLinkGatewaySpec' + GcpPeeringGatewaySpec: '#/components/schemas/networking.v1.GcpPeeringGatewaySpec' + GcpEgressPrivateServiceConnectGatewaySpec: '#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectGatewaySpec' + GcpIngressPrivateServiceConnectGatewaySpec: '#/components/schemas/networking.v1.GcpIngressPrivateServiceConnectGatewaySpec' + x-immutable: true + required: + - kind + - region + - zones + properties: + kind: + description: AWS Egress Private Link Gateway Spec kind type. + type: string + enum: + - AwsEgressPrivateLinkGatewaySpec + region: + type: string + description: AWS region of the Egress Private Link Gateway. + zones: + type: array + items: + type: string + description: AWS availability zone ids of the Private Network Interface Gateway. + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + networking.v1.GatewayStatus: + type: object + required: + - phase + description: The status of the Gateway + properties: + phase: + type: string + x-extensible-enum: + - CREATED + - PROVISIONING + - READY + - FAILED + - DEPROVISIONING + - EXPIRED + description: | + The lifecycle phase of the gateway: + + CREATED: gateway exists without an Access Point. + + PROVISIONING: gateway provisioning is in progress; + + READY: gateway is ready; + + FAILED: gateway is in a failed state; + + DEPROVISIONING: gateway deprovisioning is in progress; + + EXPIRED: gateway has timed out waiting for connections, can only be deleted; + readOnly: true + example: READY + error_code: + type: string + description: Error code if gateway is in a failed state. May be used for programmatic error checking. + readOnly: true + error_message: + type: string + description: Displayable error message if gateway is in a failed state + readOnly: true + cloud_gateway: + type: object + description: Gateway type specific status. + readOnly: true + discriminator: + propertyName: kind + mapping: + AwsPrivateNetworkInterfaceGatewayStatus: '#/components/schemas/networking.v1.AwsPrivateNetworkInterfaceGatewayStatus' + AwsEgressPrivateLinkGatewayStatus: '#/components/schemas/networking.v1.AwsEgressPrivateLinkGatewayStatus' + AwsIngressPrivateLinkGatewayStatus: '#/components/schemas/networking.v1.AwsIngressPrivateLinkGatewayStatus' + AzureEgressPrivateLinkGatewayStatus: '#/components/schemas/networking.v1.AzureEgressPrivateLinkGatewayStatus' + AzureIngressPrivateLinkGatewayStatus: '#/components/schemas/networking.v1.AzureIngressPrivateLinkGatewayStatus' + GcpPeeringGatewayStatus: '#/components/schemas/networking.v1.GcpPeeringGatewayStatus' + GcpEgressPrivateServiceConnectGatewayStatus: '#/components/schemas/networking.v1.GcpEgressPrivateServiceConnectGatewayStatus' + GcpIngressPrivateServiceConnectGatewayStatus: '#/components/schemas/networking.v1.GcpIngressPrivateServiceConnectGatewayStatus' + required: + - kind + properties: + kind: + description: AWS Egress Private Link Gateway Status kind type. + type: string + enum: + - AwsEgressPrivateLinkGatewayStatus + principal_arn: + description: The principal ARN used by the AWS Egress Private Link Gateway. + type: string + example: arn:aws:iam::123456789012:cc-tenant-1-role + readOnly: true + vpc_endpoint_service_name: + description: The ID of the AWS VPC Endpoint Service that can be used to establish connections for all zones. + type: string + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + readOnly: true + account: + description: The AWS account ID associated with the Private Network Interface Gateway. + type: string + example: '000000000000' + readOnly: true + subscription: + type: string + description: The Azure Subscription ID associated with the Confluent Cloud VPC. + example: 00000000-0000-0000-0000-000000000000 + readOnly: true + private_link_service_alias: + description: Alias of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: plattg-123abc-privatelink.00000000-0000-0000-0000-000000000000.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Resource ID of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/plattg-123abc/providers/Microsoft.Network/privateLinkServices/plattg-123abc-privatelink + iam_principal: + description: The IAM principal email used by the GCP Peering Gateway. + type: string + example: my-service-account@my-project.iam.gserviceaccount.com + readOnly: true + project: + type: string + description: The GCP project used by the GCP Private Service Connect Gateway. + example: proj-tenant-1 + readOnly: true + private_service_connect_service_attachment: + description: URI of the Private Service Connect Service Attachment in Confluent Cloud. + type: string + readOnly: true + example: projects/traffic-prod/regions/us-central1/serviceAttachments/plattg-abc123-service-attachment + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + networking.v1.ConnectionType: + type: string + description: Network connection type. + x-extensible-enum: + - PEERING + - TRANSITGATEWAY + - PRIVATELINK + example: PRIVATELINK + networking.v1.ZoneInfo: + type: object + description: Cloud provider zone metadata. + properties: + zone_id: + description: Cloud provider zone id + type: string + example: use1-az3 + cidr: + description: | + The IPv4 [CIDR block](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) to used for this network. + Must be a `/27`. Required for VPC peering and AWS TransitGateway. + type: string + example: 10.20.0.0/27 + networking.v1.DnsConfig: + type: object + description: The network DNS config + required: + - resolution + properties: + resolution: + type: string + description: Network DNS resolution type. + x-extensible-enum: + - CHASED_PRIVATE + - PRIVATE + ObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + TypedEnvScopedObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + networking.v1.AwsNetwork: + type: object + description: The AWS network details. + required: + - kind + - vpc + - account + properties: + kind: + description: Network kind type. + type: string + enum: + - AwsNetwork + vpc: + type: string + description: The Confluent Cloud VPC ID. + example: vpc-00000000000000000 + readOnly: true + account: + type: string + description: The AWS account ID associated with the Confluent Cloud VPC. + example: '000000000000' + readOnly: true + private_link_endpoint_service: + type: string + description: The endpoint service of the Confluent Cloud VPC. (used for PrivateLink) if available. + example: com.amazonaws.vpce.eu-west-3.vpce-00000000000000000 + readOnly: true + networking.v1.GcpNetwork: + type: object + description: The GCP network details. + required: + - kind + - project + - vpc_network + properties: + kind: + description: Network kind type. + type: string + enum: + - GcpNetwork + project: + type: string + description: The GCP Project ID associated with the Confluent Cloud VPC. + example: cc-prod-3 + readOnly: true + vpc_network: + type: string + description: The network name of the Confluent Cloud VPC. + example: prod-network + readOnly: true + private_service_connect_service_attachments: + type: object + description: | + The mapping of zones to Private Service Connect Service + Attachments if available. Keys are zones and values are + [GCP Private Service Connect Service + Attachment](https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#api_7) + additionalProperties: + type: string + example: + us-central1-a: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-a + us-central1-b: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-b + us-central1-c: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-c + readOnly: true + networking.v1.AzureNetwork: + type: object + description: The Azure network details. + required: + - kind + - vnet + - subscription + properties: + kind: + description: Network kind type. + type: string + enum: + - AzureNetwork + vnet: + type: string + description: The resource ID of the Confluent Cloud VNet. + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/prod-group/providers/Microsoft.Network/virtualNetworks/prod-network + readOnly: true + subscription: + type: string + description: The Azure Subscription ID associated with the Confluent Cloud VPC. + example: 00000000-0000-0000-0000-000000000000 + readOnly: true + private_link_service_aliases: + type: object + description: | + The mapping of zones to Private Link Service Aliases if available. Keys are zones + and values are [Azure Private Link Service + Aliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service). + additionalProperties: + type: string + example: + '1': 0-00000-privatelink-1.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '2': 0-00000-privatelink-2.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '3': 0-00000-privatelink-3.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + readOnly: true + private_link_service_resource_ids: + type: object + description: | + The mapping of zones to Private Link Service Resource IDs if available. Keys are zones + and values are [Azure Private Link Service Resource + IDs](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service). + additionalProperties: + type: string + example: + '1': /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-1 + '2': /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-2 + '3': /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/0-00000/providers/Microsoft.Network/privateLinkServices/0-00000-privatelink-3 + readOnly: true + networking.v1.AwsPeering: + type: object + title: AWS + description: AWS VPC Peering. + required: + - kind + - account + - vpc + - routes + - customer_region + properties: + kind: + description: Peering kind type. + type: string + enum: + - AwsPeering + account: + type: string + pattern: ^\d{12}$ + example: '000000000000' + description: The AWS account ID associated with the VPC you are peering with Confluent Cloud network. + vpc: + type: string + minLength: 1 + description: The VPC ID you are peering with Confluent Cloud network. + example: vpc-00000000000000000 + routes: + type: array + items: + $ref: '#/components/schemas/networking.v1.Cidr' + description: | + The [CIDR blocks](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) of the VPC you are peering + with Confluent Cloud network. This is used by Confluent Cloud network to route traffic back to your network. + The CIDR block must be a private range and cannot overlap with the Confluent Cloud CIDR block. + example: + - 10.108.16.0/21 + customer_region: + type: string + description: The region of the VPC you are peering with Confluent Cloud network. + example: us-east-1 + networking.v1.GcpPeering: + type: object + title: GCP + description: GCP VPC Peering. + required: + - kind + - project + - vpc_network + properties: + kind: + description: Peering kind type. + type: string + enum: + - GcpPeering + example: GcpPeering + project: + type: string + minLength: 1 + description: | + The Google Cloud project ID associated with the VPC that you are peering with Confluent Cloud network. + example: my-gcp-project + vpc_network: + type: string + minLength: 1 + description: The name of the VPC that you are peering with Confluent Cloud network. + example: my-gcp-network + import_custom_routes: + type: boolean + description: | + Enable customer route import. For more information, see + [Importing custom routes](https://cloud.google.com/vpc/docs/vpc-peering#importing-exporting-routes). + example: true + default: false + networking.v1.AzurePeering: + type: object + title: AZURE + description: Azure VNet Peering. + required: + - kind + - tenant + - vnet + - customer_region + properties: + kind: + description: Peering kind type. + type: string + enum: + - AzurePeering + tenant: + type: string + minLength: 1 + description: | + The Azure Tenant ID in which your Azure Subscription exists. + Represents an organization in Azure Active Directory. You can find your Azure Tenant ID in the Azure Portal + under + [Azure Active Directory](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview). + Must be a valid **32 character UUID string**. + vnet: + type: string + minLength: 1 + description: The resource ID of the VNet that you are peering with Confluent Cloud. You can find the name of your Azure VNet in the [Azure Portal on the Overview tab of your Azure Virtual Network](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Network%2FvirtualNetworks). + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet + customer_region: + type: string + description: The region of the VNet you are peering with Confluent Cloud network. + example: eastus2 + networking.v1.AwsTransitGatewayAttachment: + type: object + title: AWS + description: AWS Transit Gateway Attachment. + required: + - kind + - ram_share_arn + - transit_gateway_id + - routes + properties: + kind: + description: AWS Transit Gateway Attachment kind type. + type: string + enum: + - AwsTransitGatewayAttachment + ram_share_arn: + description: The full AWS Resource Name (ARN) for the AWS Resource Access Manager (RAM) Share of the Transit Gateways that you want Confluent Cloud to be attached to. + type: string + example: arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx + transit_gateway_id: + description: The ID of the AWS Transit Gateway that you want Confluent CLoud to be attached to. + type: string + example: tgw-xxxxxxxxxxxxxxxxx + routes: + type: array + items: + $ref: '#/components/schemas/networking.v1.Cidr' + description: List of destination routes. + example: + - 100.64.0.0/10 + - 10.0.0.0/8 + - 192.168.0.0/16 + - 172.16.0.0/12 + networking.v1.AwsTransitGatewayAttachmentStatus: + type: object + title: AWS + description: AWS Transit Gateway Attachment details generated by AWS. + required: + - transit_gateway_attachment_id + properties: + kind: + description: AWS Transit Gateway Attachment Status kind type. + type: string + enum: + - AwsTransitGatewayAttachmentStatus + transit_gateway_attachment_id: + description: The ID of the AWS Transit Gateway VPC Attachment that attaches Confluent VPC to Transit Gateway. + type: string + example: tgw-attach-xxxxx + readOnly: true + networking.v1.AwsPrivateLinkAccess: + type: object + title: AWS + description: AWS PrivateLink access configuration. + required: + - kind + - account + properties: + kind: + description: PrivateLink kind type. + type: string + enum: + - AwsPrivateLinkAccess + account: + type: string + pattern: ^\d{12}$ + example: '000000000000' + description: | + The AWS account ID for the account containing the VPCs you want to connect from using AWS PrivateLink. + You can find your AWS account ID [here](https://console.aws.amazon.com/billing/home?#/account) + under **My Account** in your AWS Management Console. Must be a **12 character string**. + networking.v1.AzurePrivateLinkAccess: + type: object + title: AZURE + description: Azure PrivateLink access configuration. + required: + - kind + - subscription + properties: + kind: + description: PrivateLink kind type. + type: string + enum: + - AzurePrivateLinkAccess + subscription: + type: string + minLength: 1 + description: | + The Azure subscription ID for the account containing the VNets you want to connect from using + Azure Private Link. You can find your Azure subscription ID in the subscription section of your + [Microsoft Azure Portal](https://portal.azure.com/#blade/Microsoft_Azure_Billing/SubscriptionsBlade). + Must be a valid **32 character UUID string**. + networking.v1.GcpPrivateServiceConnectAccess: + type: object + title: GCP + description: GCP Private Service Connect access configuration. + required: + - kind + - project + properties: + kind: + description: PrivateLink kind type. + type: string + enum: + - GcpPrivateServiceConnectAccess + project: + type: string + minLength: 1 + description: | + The GCP project ID for the account containing the VPCs that you want to connect from + using Private Service Connect. You can find your Google Cloud Project ID under **Project ID** section of + your [Google Cloud Console dashboard](https://console.cloud.google.com/home/dashboard). + networking.v1.NetworkLinkServiceAcceptPolicy: + type: object + title: Network Link Service + description: | + List of environments/networks from which connections can be accepted on this network link service. + properties: + environments: + description: | + List of environments from which connections can be accepted. + All networks win the list of environment will be allowed. + type: array + items: + type: string + uniqueItems: true + networks: + description: | + List of networks from which connections can be accepted. + type: array + items: + type: string + uniqueItems: true + GlobalObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + EnvScopedObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + networking.v1.AwsPrivateLinkAttachmentStatus: + description: | + AWS PrivateLink attachment represents reserved capacity in an + AWS VPC Endpoint Service that can be used to establish PrivateLink + connections. + type: object + required: + - kind + - vpc_endpoint_service + properties: + kind: + type: string + description: PrivateLinkAttachmentStatus kind. + enum: + - AwsPrivateLinkAttachmentStatus + readOnly: true + vpc_endpoint_service: + description: | + AWS VPC Endpoint Service that can be used to establish connections for all zones. + type: object + readOnly: true + required: + - vpc_endpoint_service_name + properties: + vpc_endpoint_service_name: + type: string + description: Id of the VPC Endpoint service. + readOnly: true + networking.v1.AzurePrivateLinkAttachmentStatus: + type: object + description: | + Azure PrivateLink attachment represents reserved capacity in a + PrivateLink service that can be used to establish PrivateLink + required: + - kind + - private_link_service + properties: + kind: + type: string + description: PrivateLinkAttachmentStatus kind. + enum: + - AzurePrivateLinkAttachmentStatus + readOnly: true + private_link_service: + description: | + Azure PrivateLink service that can be used to connect to a PrivateEndpoint. + type: object + readOnly: true + required: + - private_link_service_alias + - private_link_service_resource_id + properties: + private_link_service_alias: + description: Azure PrivateLink service alias. + type: string + minLength: 1 + readOnly: true + example: pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Azure PrivateLink service resource id. + type: string + minLength: 1 + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef + networking.v1.GcpPrivateLinkAttachmentStatus: + type: object + description: | + GCP PrivateLink attachment represents reserved capacity in a + GCP PSC Service attachment. A PSC Endpoint can be connected to + the Service attachment. + required: + - kind + - service_attachment + properties: + kind: + type: string + description: PrivateLinkAttachmentStatus kind. + enum: + - GcpPrivateLinkAttachmentStatus + readOnly: true + service_attachment: + description: | + GCP PSC Service attachment that can be used to connect + to a PSC Endpoint. + type: object + readOnly: true + required: + - private_service_connect_service_attachment + properties: + private_service_connect_service_attachment: + description: Id of a Private Service Connect Service Attachment in Confluent Cloud. + type: string + minLength: 1 + readOnly: true + example: projects/example-project/regions/us-central1/serviceAttachments/plt-abcdef-service-attachment-us-central1 + networking.v1.AwsPrivateLinkAttachmentConnection: + description: Represents a connection between an AWS VPC Endpoint and an Endpoint service. + type: object + required: + - kind + - vpc_endpoint_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnection kind. + enum: + - AwsPrivateLinkAttachmentConnection + vpc_endpoint_id: + description: Id of a VPC Endpoint that is connected to the VPC Endpoint service. + type: string + minLength: 1 + example: vpce-00000000000000000 + networking.v1.AzurePrivateLinkAttachmentConnection: + description: Represents a connection between an Azure PrivateLink service and a PrivateEndpoint. + type: object + required: + - kind + - private_endpoint_resource_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnection kind. + enum: + - AzurePrivateLinkAttachmentConnection + private_endpoint_resource_id: + description: | + Resource Id of the PrivateEndpoint that is connected to the PrivateLink service. + type: string + minLength: 1 + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3 + networking.v1.GcpPrivateLinkAttachmentConnection: + type: object + description: Represents a connection between a GCP PSC Service Attachment and a PSC Endpoint. + required: + - kind + - private_service_connect_connection_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnection kind. + enum: + - GcpPrivateLinkAttachmentConnection + private_service_connect_connection_id: + description: Id of the Private Service connection. + type: string + minLength: 1 + example: '00000000000000000' + networking.v1.AwsPrivateLinkAttachmentConnectionStatus: + description: Status of a connection to an AWS PrivateLink attachment. + type: object + required: + - kind + - vpc_endpoint_service_name + - vpc_endpoint_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnectionStatus kind. + enum: + - AwsPrivateLinkAttachmentConnectionStatus + vpc_endpoint_service_name: + description: Id of the VPC Endpoint service used for PrivateLink. + type: string + minLength: 1 + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + readOnly: true + vpc_endpoint_id: + description: Id of the VPC Endpoint (if any) that is connected to the VPC Endpoint service. + type: string + minLength: 1 + readOnly: true + example: vpce-00000000000000000 + networking.v1.AzurePrivateLinkAttachmentConnectionStatus: + description: Status of a Azure PrivateLink attachment connection. + type: object + required: + - kind + - private_link_service_alias + - private_link_service_resource_id + - private_endpoint_resource_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnectionStatus kind. + enum: + - AzurePrivateLinkAttachmentConnectionStatus + private_link_service_alias: + description: Azure PrivateLink service alias. + type: string + minLength: 1 + readOnly: true + example: pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Azure PrivateLink service resource id. + type: string + minLength: 1 + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3 + private_endpoint_resource_id: + description: | + Resource Id of the PrivateEndpoint (if any) that is connected to + the PrivateLink service. + type: string + minLength: 1 + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3 + networking.v1.GcpPrivateLinkAttachmentConnectionStatus: + description: Status of GCP PrivateLink attachment connection. + type: object + required: + - kind + - private_service_connect_service_attachment + - private_service_connect_connection_id + properties: + kind: + type: string + description: PrivateLinkAttachmentConnectionStatus kind. + enum: + - GcpPrivateLinkAttachmentConnectionStatus + private_service_connect_service_attachment: + description: GCP Private Service Connect ServiceAttachment. + type: string + minLength: 1 + readOnly: true + example: projects/example-project/regions/us-central1/serviceAttachments/plt-abcdef-service-attachment-us-central1-a + private_service_connect_connection_id: + description: Id of the Private Service connection. + type: string + minLength: 1 + readOnly: true + example: '00000000000000000' + networking.v1.ForwardViaIp: + type: object + title: ForwardViaIp + description: DNS Forwarder Configured via DNS Server IPs. + required: + - kind + - dns_server_ips + properties: + kind: + description: DNS Forwarder Configured via DNS Server IPs kind type. + type: string + enum: + - ForwardViaIp + dns_server_ips: + type: array + items: + $ref: '#/components/schemas/networking.v1.Ip' + uniqueItems: true + minItems: 1 + maxItems: 3 + description: List of IP addresses of the DNS server + example: + - 10.200.0.0 + - 10.200.0.1 + networking.v1.AwsEgressPrivateLinkEndpoint: + type: object + description: AWS VPC Endpoint. + required: + - kind + - vpc_endpoint_service_name + properties: + kind: + type: string + description: AwsEgressPrivateLinkEndpoint kind. + enum: + - AwsEgressPrivateLinkEndpoint + vpc_endpoint_service_name: + description: ID of the VPC Endpoint service used for PrivateLink. + type: string + minLength: 1 + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + enable_high_availability: + type: boolean + description: Whether a resource should be provisioned with high availability. Endpoints deployed with high availability have network interfaces deployed in multiple AZs. + example: false + x-immutable: true + target_system: + type: string + description: '[Used by the Confluent Cloud Console] The target system or service that the PrivateLink Endpoint connects to (e.g. "MONGODB" or "SNOWFLAKE").' + example: S3 + networking.v1.AwsIngressPrivateLinkEndpoint: + type: object + description: AWS Ingress Private Link Endpoint. + required: + - kind + - vpc_endpoint_id + properties: + kind: + type: string + description: AwsIngressPrivateLinkEndpoint kind. + enum: + - AwsIngressPrivateLinkEndpoint + vpc_endpoint_id: + description: ID of a VPC Endpoint that will be connected to the VPC Endpoint service. + type: string + minLength: 1 + example: vpce-00000000000000000 + x-immutable: true + networking.v1.AzureEgressPrivateLinkEndpoint: + type: object + description: Azure Private Endpoint. + required: + - kind + - private_link_service_resource_id + properties: + kind: + type: string + description: AzureEgressPrivateLinkEndpoint kind. + enum: + - AzureEgressPrivateLinkEndpoint + private_link_service_resource_id: + description: Resource ID of the Azure Private Link service. + type: string + minLength: 1 + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3 + private_link_subresource_name: + type: string + description: Name of the subresource for the Private Endpoint to connect to. + example: sqlServer + target_system: + type: string + description: '[Used by the Confluent Cloud Console] The target system or service that the PrivateLink Endpoint connects to (e.g. "MONGODB" or "SNOWFLAKE").' + example: SNOWFLAKE + networking.v1.AzureIngressPrivateLinkEndpoint: + type: object + description: Azure Ingress Private Link Endpoint. + required: + - kind + - private_endpoint_resource_id + properties: + kind: + type: string + description: AzureIngressPrivateLinkEndpoint kind. + enum: + - AzureIngressPrivateLinkEndpoint + private_endpoint_resource_id: + description: Resource ID of a Private Endpoint that will be connected to the Private Link service. + type: string + minLength: 1 + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-centralus-rg/providers/Microsoft.Network/privateEndpoints/private-endpoint-azure-centralus + x-immutable: true + networking.v1.AwsPrivateNetworkInterface: + type: object + description: Confluent Private Network Interface powered by AWS ENI. + required: + - kind + properties: + kind: + type: string + description: AwsPrivateNetworkInterface kind. + enum: + - AwsPrivateNetworkInterface + network_interfaces: + description: List of the IDs of the Elastic Network Interfaces. + type: array + items: + type: string + uniqueItems: true + minItems: 51 + example: + - eni-00000000000000000 + - eni-00000000000000001 + - eni-00000000000000002 + - eni-00000000000000003 + - eni-00000000000000004 + - eni-00000000000000005 + - eni-00000000000000006 + - eni-00000000000000007 + - eni-00000000000000008 + - eni-00000000000000009 + - eni-00000000000000010 + - eni-00000000000000011 + - eni-00000000000000012 + - eni-00000000000000013 + - eni-00000000000000014 + - eni-00000000000000015 + - eni-00000000000000016 + - eni-00000000000000017 + - eni-00000000000000018 + - eni-00000000000000019 + - eni-00000000000000020 + - eni-00000000000000021 + - eni-00000000000000022 + - eni-00000000000000023 + - eni-00000000000000024 + - eni-00000000000000025 + - eni-00000000000000026 + - eni-00000000000000027 + - eni-00000000000000028 + - eni-00000000000000029 + - eni-00000000000000030 + - eni-00000000000000031 + - eni-00000000000000032 + - eni-00000000000000033 + - eni-00000000000000034 + - eni-00000000000000035 + - eni-00000000000000036 + - eni-00000000000000037 + - eni-00000000000000038 + - eni-00000000000000039 + - eni-00000000000000040 + - eni-00000000000000041 + - eni-00000000000000042 + - eni-00000000000000043 + - eni-00000000000000044 + - eni-00000000000000045 + - eni-00000000000000046 + - eni-00000000000000047 + - eni-00000000000000048 + - eni-00000000000000049 + - eni-00000000000000050 + account: + type: string + pattern: ^\d{12}$ + example: '000000000000' + description: The AWS account ID associated with the ENIs you are using for the Confluent Private Network Interface. + x-immutable: true + egress_routes: + type: array + description: List of egress CIDRs (IPv4) for egress PNI. + items: + type: string + uniqueItems: true + example: + - 10.0.0.0/16 + - 10.1.0.0/16 + - 10.2.0.0/16 + - 172.16.0.0/16 + networking.v1.GcpEgressPrivateServiceConnectEndpoint: + type: object + description: GCP Private Service Connect Endpoint. + required: + - kind + - private_service_connect_endpoint_target + properties: + kind: + type: string + description: GcpEgressPrivateServiceConnectEndpoint kind. + enum: + - GcpEgressPrivateServiceConnectEndpoint + private_service_connect_endpoint_target: + description: URI of the service attachment for the published service that the Private Service Connect Endpoint connects to or "ALL_GOOGLE_APIS" for global Google APIs. + type: string + minLength: 1 + example: projects/project-name/regions/us-central1/serviceAttachments/service-attachment-name + target_system: + type: string + description: '[Used by the Confluent Cloud Console] The target system or service that the PrivateLink Endpoint connects to (e.g. "GCS" or "SNOWFLAKE").' + example: GCS + networking.v1.GcpIngressPrivateServiceConnectEndpoint: + type: object + description: GCP Ingress Private Service Connect Endpoint. + required: + - kind + - private_service_connect_connection_id + properties: + kind: + type: string + description: GcpIngressPrivateServiceConnectEndpoint kind. + enum: + - GcpIngressPrivateServiceConnectEndpoint + private_service_connect_connection_id: + description: The ID of the Private Service Connect connection. + type: string + minLength: 1 + example: '00000000000000000' + networking.v1.AwsEgressPrivateLinkEndpointStatus: + type: object + title: AWS + description: Status of an AWS PrivateLink Endpoint. + required: + - kind + - vpc_endpoint_id + - vpc_endpoint_dns_name + properties: + kind: + description: AwsEgressPrivateLinkEndpointStatus kind. + type: string + enum: + - AwsEgressPrivateLinkEndpointStatus + vpc_endpoint_id: + description: ID of a VPC Endpoint (if any) that is connected to the VPC Endpoint service. + type: string + example: vpce-00000000000000000 + readOnly: true + vpc_endpoint_dns_name: + description: DNS name of a VPC Endpoint (if any) that is connected to the VPC Endpoint service. + type: string + example: vpce-00000000000000000-00000000.vpce-svc-00000000000000000.us-west-2.vpce.amazonaws.com + readOnly: true + networking.v1.AwsIngressPrivateLinkEndpointStatus: + type: object + description: Status of an AWS Ingress Private Link Endpoint. + required: + - kind + - vpc_endpoint_service_name + - vpc_endpoint_id + properties: + kind: + description: AwsIngressPrivateLinkEndpointStatus kind. + type: string + enum: + - AwsIngressPrivateLinkEndpointStatus + vpc_endpoint_service_name: + description: ID of the Confluent Cloud VPC Endpoint service used for PrivateLink. + type: string + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + readOnly: true + vpc_endpoint_id: + description: ID of the VPC Endpoint used for connecting to the VPC Endpoint service. + type: string + example: vpce-00000000000000000 + readOnly: true + dns_domain: + description: DNS domain name used to configure the Private Hosted Zone for the Access Point. + type: string + example: ap123abc.us-west-2.aws.accesspoint.confluent.cloud + readOnly: true + networking.v1.AzureEgressPrivateLinkEndpointStatus: + type: object + description: Status of an Azure Private Endpoint. + required: + - kind + - private_endpoint_resource_id + - private_endpoint_ip_address + properties: + kind: + description: AzureEgressPrivateLinkEndpointStatus kind. + type: string + enum: + - AzureEgressPrivateLinkEndpointStatus + private_endpoint_resource_id: + description: Resource ID of the Private Endpoint (if any) that is connected to the Private Link service. + type: string + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvpc/providers/Microsoft.Network/privateEndpoints/pe-plt-abcdef-az3 + private_endpoint_domain: + description: Domain of the Private Endpoint (if any) that is connected to the Private Link service. + type: string + readOnly: true + example: dbname.database.windows.net + private_endpoint_ip_address: + description: IP address of the Private Endpoint (if any) that is connected to the Private Link service. + type: string + readOnly: true + example: 10.2.0.68 + private_endpoint_custom_dns_config_domains: + description: Domains of the Private Endpoint (if any) based off FQDNs in Azure custom DNS configs, which are required in your private DNS setup. + type: array + items: + type: string + readOnly: true + example: + - dbname.database.windows.net + - dbname-region.database.windows.net + networking.v1.AzureIngressPrivateLinkEndpointStatus: + type: object + description: Status of an Azure Ingress Private Link Endpoint. + required: + - kind + - private_link_service_alias + - private_link_service_resource_id + - private_endpoint_resource_id + properties: + kind: + description: AzureIngressPrivateLinkEndpointStatus kind. + type: string + enum: + - AzureIngressPrivateLinkEndpointStatus + private_link_service_alias: + description: Alias of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: plattg-123abc-privatelink.00000000-0000-0000-0000-000000000000.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Resource ID of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/plattg-123abc/providers/Microsoft.Network/privateLinkServices/plattg-123abc-privatelink + private_endpoint_resource_id: + description: Resource ID of the Private Endpoint used for connecting to the Private Link Service. + type: string + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-centralus-rg/providers/Microsoft.Network/privateEndpoints/private-endpoint-azure-centralus + dns_domain: + description: DNS domain name used to configure the Private DNS Zone for the Access Point. + type: string + example: ap123abc.centralus.azure.accesspoint.confluent.cloud + readOnly: true + networking.v1.GcpEgressPrivateServiceConnectEndpointStatus: + type: object + description: Status of a GCP Private Service Connect Endpoint. + required: + - kind + - private_service_connect_endpoint_connection_id + - private_service_connect_endpoint_name + - private_service_connect_endpoint_ip_address + properties: + kind: + description: GcpEgressPrivateServiceConnectEndpointStatus kind. + type: string + enum: + - GcpEgressPrivateServiceConnectEndpointStatus + private_service_connect_endpoint_connection_id: + description: Connection ID of the Private Service Connect Endpoint (if any) that is connected to the endpoint target. + type: string + readOnly: true + example: '' + private_service_connect_endpoint_name: + description: Name of the Private Service Connect Endpoint (if any) that is connected to the endpoint target. + type: string + readOnly: true + example: plap-123456 + private_service_connect_endpoint_ip_address: + description: IP address of the Private Service Connect Endpoint (if any) that is connected to the endpoint target. + type: string + readOnly: true + example: 10.2.0.68 + networking.v1.GcpIngressPrivateServiceConnectEndpointStatus: + type: object + description: Status of a GCP Ingress Private Service Connect Endpoint. + required: + - kind + - private_service_connect_service_attachment + - private_service_connect_connection_id + properties: + kind: + description: GcpIngressPrivateServiceConnectEndpointStatus kind. + type: string + enum: + - GcpIngressPrivateServiceConnectEndpointStatus + private_service_connect_service_attachment: + description: URI of the Private Service Connect Service Attachment in Confluent Cloud. + type: string + readOnly: true + example: projects/traffic-prod/regions/us-central1/serviceAttachments/plattg-abc123-service-attachment + private_service_connect_connection_id: + description: The ID of the Private Service Connect connection. + type: string + readOnly: true + example: '00000000000000000' + dns_domain: + description: DNS domain name used to configure the DNS Zone for the Access Point. + type: string + example: ap123abc.us-central1.gcp.accesspoint.confluent.cloud + readOnly: true + networking.v1.PrivateLinkAccessPoint: + type: object + description: DNS record that is associated with a PrivateLink access point. + required: + - kind + - resource_id + properties: + kind: + description: PrivateLinkAccessPoint kind. + type: string + enum: + - PrivateLinkAccessPoint + resource_id: + description: ID of the target resource. + type: string + minLength: 1 + example: ap-12345 + networking.v1.AwsEgressPrivateLinkGatewaySpec: + type: object + description: AWS Egress Private Link Gateway details from AWS. + required: + - kind + - region + properties: + kind: + description: AWS Egress Private Link Gateway Spec kind type. + type: string + enum: + - AwsEgressPrivateLinkGatewaySpec + region: + type: string + description: AWS region of the Egress Private Link Gateway. + networking.v1.AwsPrivateNetworkInterfaceGatewaySpec: + type: object + description: AWS Private Network Interface Gateway details from AWS. + required: + - kind + - region + - zones + properties: + kind: + description: AWS Private Network Interface Gateway Spec kind type. + type: string + enum: + - AwsPrivateNetworkInterfaceGatewaySpec + region: + type: string + description: AWS region of the Private Network Interface Gateway. + zones: + type: array + items: + type: string + description: AWS availability zone ids of the Private Network Interface Gateway. + networking.v1.AwsIngressPrivateLinkGatewaySpec: + type: object + description: AWS Ingress Private Link Gateway details from AWS. + required: + - kind + - region + properties: + kind: + description: AWS Ingress Private Link Gateway Spec kind type. + type: string + enum: + - AwsIngressPrivateLinkGatewaySpec + region: + type: string + description: AWS region of the Ingress Private Link Gateway. + networking.v1.AwsPeeringGatewaySpec: + type: object + description: AWS Peering Gateway details from AWS. + required: + - kind + - region + properties: + kind: + description: AWS Peering Gateway Spec kind type. + type: string + enum: + - AwsPeeringGatewaySpec + region: + type: string + description: AWS region of the Peering Gateway. + networking.v1.AzurePeeringGatewaySpec: + type: object + description: Azure Peering Gateway details from Azure. + required: + - kind + - region + properties: + kind: + description: Azure Peering Gateway Spec kind type. + type: string + enum: + - AzurePeeringGatewaySpec + region: + type: string + description: Azure region of the Peering Gateway. + networking.v1.AzureEgressPrivateLinkGatewaySpec: + type: object + description: Azure Egress Private Link Gateway details from Azure. + required: + - kind + - region + properties: + kind: + description: Azure Egress Private Link Gateway Spec kind type. + type: string + enum: + - AzureEgressPrivateLinkGatewaySpec + region: + type: string + description: Azure region of the Egress Private Link Gateway. + networking.v1.AzureIngressPrivateLinkGatewaySpec: + type: object + description: Azure Ingress Private Link Gateway details from Azure. + required: + - kind + - region + properties: + kind: + description: Azure Ingress Private Link Gateway Spec kind type. + type: string + enum: + - AzureIngressPrivateLinkGatewaySpec + region: + type: string + description: Azure region of the Ingress Private Link Gateway. + networking.v1.GcpPeeringGatewaySpec: + type: object + description: GCP Peering Gateway details. + required: + - kind + - region + properties: + kind: + description: GCP Peering Gateway Spec kind type. + type: string + enum: + - GcpPeeringGatewaySpec + region: + type: string + description: GCP region of the Peering Gateway. + networking.v1.GcpEgressPrivateServiceConnectGatewaySpec: + type: object + description: GCP Private Service Connect Gateway details from GCP. + required: + - kind + - region + properties: + kind: + description: GCP Private Service Connect Gateway Spec kind type. + type: string + enum: + - GcpEgressPrivateServiceConnectGatewaySpec + region: + type: string + description: GCP region of the Egress Private Service Connect Gateway. + networking.v1.GcpIngressPrivateServiceConnectGatewaySpec: + type: object + description: GCP Ingress Private Service Connect Gateway details from GCP. + required: + - kind + - region + properties: + kind: + description: GCP Ingress Private Service Connect Gateway Spec kind type. + type: string + enum: + - GcpIngressPrivateServiceConnectGatewaySpec + region: + type: string + description: GCP region of the Ingress Private Service Connect Gateway. + networking.v1.AwsEgressPrivateLinkGatewayStatus: + type: object + required: + - kind + description: AWS Egress Private Link Gateway details from AWS. + properties: + kind: + description: AWS Egress Private Link Gateway Status kind type. + type: string + enum: + - AwsEgressPrivateLinkGatewayStatus + principal_arn: + description: The principal ARN used by the AWS Egress Private Link Gateway. + type: string + example: arn:aws:iam::123456789012:cc-tenant-1-role + readOnly: true + networking.v1.AwsIngressPrivateLinkGatewayStatus: + type: object + required: + - kind + description: AWS Ingress Private Link Gateway details from AWS. + properties: + kind: + description: AWS Ingress Private Link Gateway Status kind type. + type: string + enum: + - AwsIngressPrivateLinkGatewayStatus + vpc_endpoint_service_name: + description: The ID of the AWS VPC Endpoint Service that can be used to establish connections for all zones. + type: string + example: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000 + readOnly: true + networking.v1.AwsPrivateNetworkInterfaceGatewayStatus: + type: object + required: + - kind + description: AWS Private Network Interface Gateway details from AWS. + properties: + kind: + description: AWS Private Network Interface Gateway Status kind type. + type: string + enum: + - AwsPrivateNetworkInterfaceGatewayStatus + account: + description: The AWS account ID associated with the Private Network Interface Gateway. + type: string + example: '000000000000' + readOnly: true + networking.v1.AzureEgressPrivateLinkGatewayStatus: + type: object + required: + - kind + description: Azure Egress Private Link Gateway details from Azure. + properties: + kind: + description: Azure Egress Private Link Gateway Status kind type. + type: string + enum: + - AzureEgressPrivateLinkGatewayStatus + subscription: + type: string + description: The Azure Subscription ID associated with the Confluent Cloud VPC. + example: 00000000-0000-0000-0000-000000000000 + readOnly: true + networking.v1.AzureIngressPrivateLinkGatewayStatus: + type: object + required: + - kind + description: Azure Ingress Private Link Gateway details from Azure. + properties: + kind: + description: Azure Ingress Private Link Gateway Status kind type. + type: string + enum: + - AzureIngressPrivateLinkGatewayStatus + private_link_service_alias: + description: Alias of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: plattg-123abc-privatelink.00000000-0000-0000-0000-000000000000.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Resource ID of the Confluent Cloud Private Link Service. + type: string + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/plattg-123abc/providers/Microsoft.Network/privateLinkServices/plattg-123abc-privatelink + networking.v1.GcpPeeringGatewayStatus: + type: object + required: + - kind + description: GCP Peering Gateway details from GCP. + properties: + kind: + description: GCP Peering Gateway Status kind type. + type: string + enum: + - GcpPeeringGatewayStatus + iam_principal: + description: The IAM principal email used by the GCP Peering Gateway. + type: string + example: my-service-account@my-project.iam.gserviceaccount.com + readOnly: true + networking.v1.GcpEgressPrivateServiceConnectGatewayStatus: + type: object + required: + - kind + description: GCP Private Service Connect Gateway details from GCP. + properties: + kind: + description: GCP Private Service Connect Gateway Status kind type. + type: string + enum: + - GcpEgressPrivateServiceConnectGatewayStatus + project: + type: string + description: The GCP project used by the GCP Private Service Connect Gateway. + example: proj-tenant-1 + readOnly: true + networking.v1.GcpIngressPrivateServiceConnectGatewayStatus: + type: object + required: + - kind + description: GCP Ingress Private Service Connect Gateway details from GCP. + properties: + kind: + description: GCP Ingress Private Service Connect Gateway Status kind type. + type: string + enum: + - GcpIngressPrivateServiceConnectGatewayStatus + private_service_connect_service_attachment: + description: URI of the Private Service Connect Service Attachment in Confluent Cloud. + type: string + readOnly: true + example: projects/traffic-prod/regions/us-central1/serviceAttachments/plattg-abc123-service-attachment + networking.v1.Cidr: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+/\d+$ + description: IPv4 CIDR block + example: 10.200.0.0/16 + networking.v1.AwsVpcEndpointService: + description: | + AWS VPC Endpoint service that can be used to create VPC Endpoints. + type: object + required: + - vpc_endpoint_service_name + properties: + vpc_endpoint_service_name: + type: string + description: Id of the VPC Endpoint service. + readOnly: true + networking.v1.AzurePrivateLinkService: + type: object + description: | + Azure Private Link Service with reserved capacity to connect a Private Endpoint. + required: + - private_link_service_alias + - private_link_service_resource_id + properties: + private_link_service_alias: + description: Azure PrivateLink service alias. + type: string + minLength: 1 + readOnly: true + example: pls-plt-abcdef-az3.38748da8-3322-42f7-b97a-6448c21af653.centralus.azure.privatelinkservice + private_link_service_resource_id: + description: Azure PrivateLink service resource id. + type: string + minLength: 1 + readOnly: true + example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef + networking.v1.GcpPscServiceAttachment: + type: object + description: | + GCP PSC Service attachment with reserved capacity to + connect a PSC Endpoint. + required: + - private_service_connect_service_attachment + properties: + private_service_connect_service_attachment: + description: Id of a Private Service Connect Service Attachment in Confluent Cloud. + type: string + minLength: 1 + readOnly: true + example: projects/example-project/regions/us-central1/serviceAttachments/plt-abcdef-service-attachment-us-central1 + networking.v1.Ip: + type: string + pattern: ^\d+\.\d+\.\d+\.\d+$ + description: IPv4 Address + example: 10.200.0.0 + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + OverQuotaError: + x-summary: Over Quota + description: The request would exceed one or more quotas. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '402' + code: quota_exceeded + title: Kafka Clusters Per Org Quota Exceeded + detail: 'The request would exceed the quota: kafka_clusters_per_environment' + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/notifications.yaml b/provider-dev/source/notifications.yaml new file mode 100644 index 0000000..ee5a4fb --- /dev/null +++ b/provider-dev/source/notifications.yaml @@ -0,0 +1,6938 @@ +openapi: 3.0.0 +info: + title: notifications API + description: confluent notifications API + version: 1.0.0 +paths: + /notifications/v1/subscriptions: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNotificationsV1Subscriptions + summary: List of Subscriptions + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all subscriptions. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 250 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Subscription. + content: + application/json: + schema: + type: object + description: |- + `Subscription` objects represent the intent of the customers to get notifications of particular types. + A subscription is created for a particular `NotificationType` and the user will get notifications on the + `Integrations` that are provided while creating the subscription. + + This API allows you to create, retrieve, and update subscriptions, + as well as to view the list of all your subscriptions. You can also delete subscriptions + with RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Subscriptions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - SubscriptionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Subscription` objects represent the intent of the customers to get notifications of particular types. + A subscription is created for a particular `NotificationType` and the user will get notifications on the + `Integrations` that are provided while creating the subscription. + + This API allows you to create, retrieve, and update subscriptions, + as well as to view the list of all your subscriptions. You can also delete subscriptions + with RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Subscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the subscription. When the subscription is ENABLED, the user will receive + notification on the configured Integrations. If the subscription is DISABLED, the user will not + recieve any notification for the configured notification type. Note that, you cannot disable + a subscription for `REQUIRED` notification type. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - id + - metadata + - notification_type + - integrations + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNotificationsV1Subscription + summary: Create a Subscription + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a subscription. + tags: + - Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Subscription` objects represent the intent of the customers to get notifications of particular types. + A subscription is created for a particular `NotificationType` and the user will get notifications on the + `Integrations` that are provided while creating the subscription. + + This API allows you to create, retrieve, and update subscriptions, + as well as to view the list of all your subscriptions. You can also delete subscriptions + with RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Subscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the subscription. When the subscription is ENABLED, the user will receive + notification on the configured Integrations. If the subscription is DISABLED, the user will not + recieve any notification for the configured notification type. Note that, you cannot disable + a subscription for `REQUIRED` notification type. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - notification_type + - integrations + responses: + '201': + description: A Subscription was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/notifications/v1/subscriptions/{id} + description: Subscription resource uri + content: + application/json: + schema: + type: object + description: |- + `Subscription` objects represent the intent of the customers to get notifications of particular types. + A subscription is created for a particular `NotificationType` and the user will get notifications on the + `Integrations` that are provided while creating the subscription. + + This API allows you to create, retrieve, and update subscriptions, + as well as to view the list of all your subscriptions. You can also delete subscriptions + with RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Subscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the subscription. When the subscription is ENABLED, the user will receive + notification on the configured Integrations. If the subscription is DISABLED, the user will not + recieve any notification for the configured notification type. Note that, you cannot disable + a subscription for `REQUIRED` notification type. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - notification_type + - integrations + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/subscriptions/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNotificationsV1Subscription + summary: Read a Subscription + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a subscription. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the subscription. + tags: + - Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Subscription. + content: + application/json: + schema: + type: object + description: |- + `Subscription` objects represent the intent of the customers to get notifications of particular types. + A subscription is created for a particular `NotificationType` and the user will get notifications on the + `Integrations` that are provided while creating the subscription. + + This API allows you to create, retrieve, and update subscriptions, + as well as to view the list of all your subscriptions. You can also delete subscriptions + with RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Subscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the subscription. When the subscription is ENABLED, the user will receive + notification on the configured Integrations. If the subscription is DISABLED, the user will not + recieve any notification for the configured notification type. Note that, you cannot disable + a subscription for `REQUIRED` notification type. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - api_version + - kind + - id + - notification_type + - integrations + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNotificationsV1Subscription + summary: Update a Subscription + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a subscription. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the subscription. + tags: + - Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/notifications.v1.Subscription' + responses: + '200': + description: Subscription. + content: + application/json: + schema: + type: object + description: |- + `Subscription` objects represent the intent of the customers to get notifications of particular types. + A subscription is created for a particular `NotificationType` and the user will get notifications on the + `Integrations` that are provided while creating the subscription. + + This API allows you to create, retrieve, and update subscriptions, + as well as to view the list of all your subscriptions. You can also delete subscriptions + with RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Subscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the subscription. When the subscription is ENABLED, the user will receive + notification on the configured Integrations. If the subscription is DISABLED, the user will not + recieve any notification for the configured notification type. Note that, you cannot disable + a subscription for `REQUIRED` notification type. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - api_version + - kind + - id + - notification_type + - integrations + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNotificationsV1Subscription + summary: Delete a Subscription + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a subscription. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the subscription. + tags: + - Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Subscription is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/integrations: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNotificationsV1Integrations + summary: List of Integrations + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all integrations. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 250 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: |- + You can create an `Integration` to specify how we can notify you when we receive an alert/notification for + a subscription. Please note that you can only perform create, update and delete operations for integrations + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail` + and `UserEmail`. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Integrations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `integrations_per_org` | Maximum number of integrations in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + You can create an `Integration` to specify how we can notify you when we receive an alert/notification for + a subscription. Please note that you can only perform create, update and delete operations for integrations + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail` + and `UserEmail`. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Integrations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `integrations_per_org` | Maximum number of integrations in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: | + A human readable description for the particular integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + required: + - id + - metadata + - display_name + - target + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNotificationsV1Integration + summary: Create an Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an integration. + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + You can create an `Integration` to specify how we can notify you when we receive an alert/notification for + a subscription. Please note that you can only perform create, update and delete operations for integrations + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail` + and `UserEmail`. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Integrations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `integrations_per_org` | Maximum number of integrations in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: | + A human readable description for the particular integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + required: + - display_name + - target + responses: + '201': + description: An Integration was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/notifications/v1/integrations/{id} + description: Integration resource uri + content: + application/json: + schema: + type: object + description: |- + You can create an `Integration` to specify how we can notify you when we receive an alert/notification for + a subscription. Please note that you can only perform create, update and delete operations for integrations + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail` + and `UserEmail`. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Integrations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `integrations_per_org` | Maximum number of integrations in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: | + A human readable description for the particular integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + required: + - display_name + - target + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/integrations/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNotificationsV1Integration + summary: Read an Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an integration. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: |- + You can create an `Integration` to specify how we can notify you when we receive an alert/notification for + a subscription. Please note that you can only perform create, update and delete operations for integrations + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail` + and `UserEmail`. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Integrations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `integrations_per_org` | Maximum number of integrations in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: | + A human readable description for the particular integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + required: + - api_version + - kind + - id + - display_name + - target + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNotificationsV1Integration + summary: Update an Integration + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an integration. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/notifications.v1.Integration' + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: |- + You can create an `Integration` to specify how we can notify you when we receive an alert/notification for + a subscription. Please note that you can only perform create, update and delete operations for integrations + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail` + and `UserEmail`. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Integrations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `integrations_per_org` | Maximum number of integrations in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: | + A human readable description for the particular integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + required: + - api_version + - kind + - id + - display_name + - target + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNotificationsV1Integration + summary: Delete an Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an integration. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Integration is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/integrations:test: + post: + summary: Test a Webhook, Slack or Microsoft Teams integration + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Sends a test notification to validate the integration. This is supported only for Webhook, Slack + and MsTeams targets + requestBody: + content: + application/json: + schema: + type: object + description: |- + You can create an `Integration` to specify how we can notify you when we receive an alert/notification for + a subscription. Please note that you can only perform create, update and delete operations for integrations + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail` + and `UserEmail`. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Integrations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `integrations_per_org` | Maximum number of integrations in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: | + A human readable description for the particular integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + required: + - display_name + - target + x-lifecycle-stage: General Availability + x-self-access: true + x-name: notifications.v1.Integration + operationId: testNotificationsV1Integration + tags: + - Integrations (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: Notification sent to test integration. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/notification-types/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNotificationsV1NotificationType + summary: Read a Notification Type + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a notification type. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the notification type. + tags: + - Notification Types (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Notification Type. + content: + application/json: + schema: + type: object + description: |- + The type of notifications (and their corresponding metadata) supported by Confluent. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Notification Types Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NotificationType + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: | + Human readable display name of the notification type + example: Cluster Shrink + category: + type: string + x-extensible-enum: + - BILLING_LICENSING + - SECURITY + - SERVICE + - ACCOUNT + description: | + Represents the group with which the notification is associated. + Notifications are grouped under certain categories for better organization. + - BILLING_LICENSING: All billing, payments or licensing related notifications are grouped here. + - SECURITY: All Confluent Cloud and Platform security related notifications are grouped here. + - SERVICE: All Confluent services (eg. Kafka, Schema Registry, Connect etc.) related notifications are + grouped here. + - ACCOUNT: All Confluent account related notifications are grouped here. + For example: Billing, payment or license related notifications are grouped in BILLING_LICENSING category. + example: BILLING_LICENSING + description: + type: string + description: | + Human readable description of the notification type + example: Cluster shrink operation is completed + subscription_priority: + type: string + x-extensible-enum: + - REQUIRED + - RECOMMENDED + - OPTIONAL + description: | + Indicates whether the notification is auto-subscribed and if the user can opt-out. + - REQUIRED: the user is auto-subscribed to this notification and can't opt-out. + - RECOMMENDED: the user is auto-subscribed to this notification and can opt-out. + - OPTIONAL: the user is not auto-subscribed to this notification but can explicitly subscribe to it. + example: REQUIRED + is_included_in_plan: + type: boolean + description: | + Whether this notification is available to subscribe or not + as per the user's current billing plan. + severity: + type: string + x-extensible-enum: + - CRITICAL + - WARN + - INFO + description: | + Severity indicates the impact of this notification. + - CRITICAL: a high impact notification which needs immediate attention. + - WARN: a warning notification which can be addressed now or later. + - INFO: an informational notification. + example: INFO + required: + - api_version + - kind + - id + - display_name + - category + - description + - subscription_priority + - is_included_in_plan + - severity + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/notification-types: + get: + summary: Retrieve a list of all notification types for the resource type. + parameters: + - name: resource_type + description: Confluent Cloud resource type + in: query + required: false + schema: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 250 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNotificationsV1NotificationTypes + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to list_by_resource_type a notification type. + tags: + - Notification Types (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: List of Notification Type. + content: + application/json: + schema: + type: object + description: |- + The type of notifications (and their corresponding metadata) supported by Confluent. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Notification Types Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NotificationTypeList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + The type of notifications (and their corresponding metadata) supported by Confluent. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Notification Types Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NotificationType + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: | + Human readable display name of the notification type + example: Cluster Shrink + category: + type: string + x-extensible-enum: + - BILLING_LICENSING + - SECURITY + - SERVICE + - ACCOUNT + description: | + Represents the group with which the notification is associated. + Notifications are grouped under certain categories for better organization. + - BILLING_LICENSING: All billing, payments or licensing related notifications are grouped here. + - SECURITY: All Confluent Cloud and Platform security related notifications are grouped here. + - SERVICE: All Confluent services (eg. Kafka, Schema Registry, Connect etc.) related notifications are + grouped here. + - ACCOUNT: All Confluent account related notifications are grouped here. + For example: Billing, payment or license related notifications are grouped in BILLING_LICENSING category. + example: BILLING_LICENSING + description: + type: string + description: | + Human readable description of the notification type + example: Cluster shrink operation is completed + subscription_priority: + type: string + x-extensible-enum: + - REQUIRED + - RECOMMENDED + - OPTIONAL + description: | + Indicates whether the notification is auto-subscribed and if the user can opt-out. + - REQUIRED: the user is auto-subscribed to this notification and can't opt-out. + - RECOMMENDED: the user is auto-subscribed to this notification and can opt-out. + - OPTIONAL: the user is not auto-subscribed to this notification but can explicitly subscribe to it. + example: REQUIRED + is_included_in_plan: + type: boolean + description: | + Whether this notification is available to subscribe or not + as per the user's current billing plan. + severity: + type: string + x-extensible-enum: + - CRITICAL + - WARN + - INFO + description: | + Severity indicates the impact of this notification. + - CRITICAL: a high impact notification which needs immediate attention. + - WARN: a warning notification which can be addressed now or later. + - INFO: an informational notification. + example: INFO + required: + - id + - metadata + - display_name + - category + - description + - subscription_priority + - is_included_in_plan + - severity + uniqueItems: true + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/resource-preferences: + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNotificationsV1ResourcePreference + summary: Create a Resource Preference + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a resource preference. + tags: + - Resource Preferences (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `ResourcePreference` objects represent the intent of the customers to enable or disable all notifications + at the resource level. A ResourcePreference is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update and delete resourcePreferences. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Preferences Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourcePreference + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + required: + - resource + - resource_type + responses: + '201': + description: A Resource Preference was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/notifications/v1/resource-preferences/{id} + description: ResourcePreference resource uri + content: + application/json: + schema: + type: object + description: |- + `ResourcePreference` objects represent the intent of the customers to enable or disable all notifications + at the resource level. A ResourcePreference is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update and delete resourcePreferences. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Preferences Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourcePreference + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + required: + - resource + - resource_type + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/resource-preferences/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNotificationsV1ResourcePreference + summary: Read a Resource Preference + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a resource preference. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource preference. + tags: + - Resource Preferences (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Resource Preference. + content: + application/json: + schema: + type: object + description: |- + `ResourcePreference` objects represent the intent of the customers to enable or disable all notifications + at the resource level. A ResourcePreference is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update and delete resourcePreferences. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Preferences Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourcePreference + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + required: + - api_version + - kind + - id + - resource + - resource_type + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNotificationsV1ResourcePreference + summary: Update a Resource Preference + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a resource preference. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource preference. + tags: + - Resource Preferences (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/notifications.v1.ResourcePreference' + responses: + '200': + description: Resource Preference. + content: + application/json: + schema: + type: object + description: |- + `ResourcePreference` objects represent the intent of the customers to enable or disable all notifications + at the resource level. A ResourcePreference is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update and delete resourcePreferences. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Preferences Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourcePreference + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + required: + - api_version + - kind + - id + - resource + - resource_type + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNotificationsV1ResourcePreference + summary: Delete a Resource Preference + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a resource preference. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource preference. + tags: + - Resource Preferences (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Resource Preference is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/resource-preferences:lookup: + get: + summary: Lookup a resource preference by filter (returns one) + parameters: + - name: resource + description: Confluent Cloud resource definition + in: query + required: true + schema: + type: string + - name: resource_type + description: Confluent Cloud resource type + in: query + required: true + schema: + type: string + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 250 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + x-lifecycle-stage: General Availability + x-self-access: true + x-name: notifications.v1.ResourcePreference + operationId: getNotificationsV1ResourcePreferenceByFilter + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read_by_filter a resource preference. + tags: + - Resource Preferences (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Resource Preference. + content: + application/json: + schema: + type: object + description: |- + `ResourcePreference` objects represent the intent of the customers to enable or disable all notifications + at the resource level. A ResourcePreference is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update and delete resourcePreferences. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Preferences Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourcePreference + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + required: + - api_version + - kind + - id + - resource + - resource_type + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/resource-subscriptions: + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createNotificationsV1ResourceSubscription + summary: Create a Resource Subscription + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a resource subscription. + tags: + - Resource Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `ResourceSubscription` objects represent the intent of the customers to get notifications of particular types + at the resource level. A ResourceSubscription is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update, delete and list ResourceSubscription. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - resource + - resource_type + - notification_type + - integrations + responses: + '201': + description: A Resource Subscription was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/notifications/v1/resource-subscriptions/{id} + description: ResourceSubscription resource uri + content: + application/json: + schema: + type: object + description: |- + `ResourceSubscription` objects represent the intent of the customers to get notifications of particular types + at the resource level. A ResourceSubscription is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update, delete and list ResourceSubscription. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - resource + - resource_type + - notification_type + - integrations + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/resource-subscriptions/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getNotificationsV1ResourceSubscription + summary: Read a Resource Subscription + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a resource subscription. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource subscription. + tags: + - Resource Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Resource Subscription. + content: + application/json: + schema: + type: object + description: |- + `ResourceSubscription` objects represent the intent of the customers to get notifications of particular types + at the resource level. A ResourceSubscription is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update, delete and list ResourceSubscription. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - api_version + - kind + - id + - resource + - resource_type + - notification_type + - integrations + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateNotificationsV1ResourceSubscription + summary: Update a Resource Subscription + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a resource subscription. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource subscription. + tags: + - Resource Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/notifications.v1.ResourceSubscription' + responses: + '200': + description: Resource Subscription. + content: + application/json: + schema: + type: object + description: |- + `ResourceSubscription` objects represent the intent of the customers to get notifications of particular types + at the resource level. A ResourceSubscription is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update, delete and list ResourceSubscription. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - api_version + - kind + - id + - resource + - resource_type + - notification_type + - integrations + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteNotificationsV1ResourceSubscription + summary: Delete a Resource Subscription + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a resource subscription. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the resource subscription. + tags: + - Resource Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Resource Subscription is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /notifications/v1/resource-subscriptions:lookup: + get: + summary: Lookup a list of resource subscription by filter + parameters: + - name: resource + description: Confluent Cloud resource definition + in: query + required: true + schema: + type: string + - name: resource_type + description: Confluent Cloud resource type + in: query + required: true + schema: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + - name: page_size + in: query + required: false + schema: + type: integer + default: 100 + maximum: 250 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listNotificationsV1ResourceSubscriptionsByFilter + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to list_by_filter a resource subscription. + tags: + - Resource Subscriptions (notifications/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: List of ResourceSubscriptions + content: + application/json: + schema: + type: object + description: |- + `ResourceSubscription` objects represent the intent of the customers to get notifications of particular types + at the resource level. A ResourceSubscription is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update, delete and list ResourceSubscription. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Subscriptions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscriptionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ResourceSubscription` objects represent the intent of the customers to get notifications of particular types + at the resource level. A ResourceSubscription is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update, delete and list ResourceSubscription. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - id + - metadata + - resource + - resource_type + - notification_type + - integrations + uniqueItems: true + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + notifications.v1.SubscriptionList: + type: object + description: |- + `Subscription` objects represent the intent of the customers to get notifications of particular types. + A subscription is created for a particular `NotificationType` and the user will get notifications on the + `Integrations` that are provided while creating the subscription. + + This API allows you to create, retrieve, and update subscriptions, + as well as to view the list of all your subscriptions. You can also delete subscriptions + with RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Subscriptions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - SubscriptionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Subscription` objects represent the intent of the customers to get notifications of particular types. + A subscription is created for a particular `NotificationType` and the user will get notifications on the + `Integrations` that are provided while creating the subscription. + + This API allows you to create, retrieve, and update subscriptions, + as well as to view the list of all your subscriptions. You can also delete subscriptions + with RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Subscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the subscription. When the subscription is ENABLED, the user will receive + notification on the configured Integrations. If the subscription is DISABLED, the user will not + recieve any notification for the configured notification type. Note that, you cannot disable + a subscription for `REQUIRED` notification type. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - id + - metadata + - notification_type + - integrations + uniqueItems: true + notifications.v1.Subscription: + type: object + description: |- + `Subscription` objects represent the intent of the customers to get notifications of particular types. + A subscription is created for a particular `NotificationType` and the user will get notifications on the + `Integrations` that are provided while creating the subscription. + + This API allows you to create, retrieve, and update subscriptions, + as well as to view the list of all your subscriptions. You can also delete subscriptions + with RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Subscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the subscription. When the subscription is ENABLED, the user will receive + notification on the configured Integrations. If the subscription is DISABLED, the user will not + recieve any notification for the configured notification type. Note that, you cannot disable + a subscription for `REQUIRED` notification type. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + notifications.v1.IntegrationList: + type: object + description: |- + You can create an `Integration` to specify how we can notify you when we receive an alert/notification for + a subscription. Please note that you can only perform create, update and delete operations for integrations + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail` + and `UserEmail`. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Integrations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `integrations_per_org` | Maximum number of integrations in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + You can create an `Integration` to specify how we can notify you when we receive an alert/notification for + a subscription. Please note that you can only perform create, update and delete operations for integrations + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail` + and `UserEmail`. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Integrations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `integrations_per_org` | Maximum number of integrations in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: | + A human readable description for the particular integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + required: + - id + - metadata + - display_name + - target + uniqueItems: true + notifications.v1.Integration: + type: object + description: |- + You can create an `Integration` to specify how we can notify you when we receive an alert/notification for + a subscription. Please note that you can only perform create, update and delete operations for integrations + of type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail` + and `UserEmail`. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Integrations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `integrations_per_org` | Maximum number of integrations in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + maxLength: 64 + description: | + A human readable name for the particular integration + example: Slack integration + description: + type: string + maxLength: 128 + description: | + A human readable description for the particular integration + example: A Slack channel integration + target: + description: | + Integration-specific details (integration targets) + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + notifications.v1.NotificationType: + type: object + description: |- + The type of notifications (and their corresponding metadata) supported by Confluent. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Notification Types Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NotificationType + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: | + Human readable display name of the notification type + example: Cluster Shrink + category: + type: string + x-extensible-enum: + - BILLING_LICENSING + - SECURITY + - SERVICE + - ACCOUNT + description: | + Represents the group with which the notification is associated. + Notifications are grouped under certain categories for better organization. + - BILLING_LICENSING: All billing, payments or licensing related notifications are grouped here. + - SECURITY: All Confluent Cloud and Platform security related notifications are grouped here. + - SERVICE: All Confluent services (eg. Kafka, Schema Registry, Connect etc.) related notifications are + grouped here. + - ACCOUNT: All Confluent account related notifications are grouped here. + For example: Billing, payment or license related notifications are grouped in BILLING_LICENSING category. + example: BILLING_LICENSING + description: + type: string + description: | + Human readable description of the notification type + example: Cluster shrink operation is completed + subscription_priority: + type: string + x-extensible-enum: + - REQUIRED + - RECOMMENDED + - OPTIONAL + description: | + Indicates whether the notification is auto-subscribed and if the user can opt-out. + - REQUIRED: the user is auto-subscribed to this notification and can't opt-out. + - RECOMMENDED: the user is auto-subscribed to this notification and can opt-out. + - OPTIONAL: the user is not auto-subscribed to this notification but can explicitly subscribe to it. + example: REQUIRED + is_included_in_plan: + type: boolean + description: | + Whether this notification is available to subscribe or not + as per the user's current billing plan. + severity: + type: string + x-extensible-enum: + - CRITICAL + - WARN + - INFO + description: | + Severity indicates the impact of this notification. + - CRITICAL: a high impact notification which needs immediate attention. + - WARN: a warning notification which can be addressed now or later. + - INFO: an informational notification. + example: INFO + notifications.v1.NotificationTypeList: + type: object + description: |- + The type of notifications (and their corresponding metadata) supported by Confluent. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Notification Types Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NotificationTypeList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + The type of notifications (and their corresponding metadata) supported by Confluent. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Notification Types Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - NotificationType + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + description: | + Human readable display name of the notification type + example: Cluster Shrink + category: + type: string + x-extensible-enum: + - BILLING_LICENSING + - SECURITY + - SERVICE + - ACCOUNT + description: | + Represents the group with which the notification is associated. + Notifications are grouped under certain categories for better organization. + - BILLING_LICENSING: All billing, payments or licensing related notifications are grouped here. + - SECURITY: All Confluent Cloud and Platform security related notifications are grouped here. + - SERVICE: All Confluent services (eg. Kafka, Schema Registry, Connect etc.) related notifications are + grouped here. + - ACCOUNT: All Confluent account related notifications are grouped here. + For example: Billing, payment or license related notifications are grouped in BILLING_LICENSING category. + example: BILLING_LICENSING + description: + type: string + description: | + Human readable description of the notification type + example: Cluster shrink operation is completed + subscription_priority: + type: string + x-extensible-enum: + - REQUIRED + - RECOMMENDED + - OPTIONAL + description: | + Indicates whether the notification is auto-subscribed and if the user can opt-out. + - REQUIRED: the user is auto-subscribed to this notification and can't opt-out. + - RECOMMENDED: the user is auto-subscribed to this notification and can opt-out. + - OPTIONAL: the user is not auto-subscribed to this notification but can explicitly subscribe to it. + example: REQUIRED + is_included_in_plan: + type: boolean + description: | + Whether this notification is available to subscribe or not + as per the user's current billing plan. + severity: + type: string + x-extensible-enum: + - CRITICAL + - WARN + - INFO + description: | + Severity indicates the impact of this notification. + - CRITICAL: a high impact notification which needs immediate attention. + - WARN: a warning notification which can be addressed now or later. + - INFO: an informational notification. + example: INFO + required: + - id + - metadata + - display_name + - category + - description + - subscription_priority + - is_included_in_plan + - severity + uniqueItems: true + notifications.v1.ResourcePreference: + type: object + description: |- + `ResourcePreference` objects represent the intent of the customers to enable or disable all notifications + at the resource level. A ResourcePreference is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update and delete resourcePreferences. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Preferences Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourcePreference + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + notifications.v1.ResourceSubscription: + type: object + description: |- + `ResourceSubscription` objects represent the intent of the customers to get notifications of particular types + at the resource level. A ResourceSubscription is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update, delete and list ResourceSubscription. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + notifications.v1.ResourceSubscriptionList: + type: object + description: |- + `ResourceSubscription` objects represent the intent of the customers to get notifications of particular types + at the resource level. A ResourceSubscription is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update, delete and list ResourceSubscription. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Subscriptions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscriptionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ResourceSubscription` objects represent the intent of the customers to get notifications of particular types + at the resource level. A ResourceSubscription is created for a specific Confluent Cloud Resource + (e.g., a connector) and determines whether the user will receive notifications for that resource. + + This API allows you to create, retrieve, update, delete and list ResourceSubscription. + + + Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). + + ## The Resource Subscriptions Model + + properties: + api_version: + type: string + enum: + - notifications/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ResourceSubscription + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + resource: + type: string + description: Denotes the Confluent Cloud resource definition. + example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector + resource_type: + type: string + x-extensible-enum: + - ENVIRONMENT + - CLUSTER + - CONNECTOR + - FLINK_COMPUTE_POOL + - FLINK_STATEMENT + description: Denotes the Confluent Cloud resource type. + example: CONNECTOR + current_state: + type: string + x-extensible-enum: + - ENABLED + - DISABLED + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. + example: ENABLED + notification_type: + description: The type of notification to subscribe to. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + integrations: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: Integrations to which notifications are to be sent. + minItems: 1 + required: + - id + - metadata + - resource + - resource_type + - notification_type + - integrations + uniqueItems: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + GlobalObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + notifications.v1.Target: + description: Target for the particular integration + discriminator: + propertyName: kind + mapping: + Slack: '#/components/schemas/notifications.v1.SlackTarget' + RoleEmail: '#/components/schemas/notifications.v1.RoleEmailTarget' + UserEmail: '#/components/schemas/notifications.v1.UserEmailTarget' + Webhook: '#/components/schemas/notifications.v1.WebhookTarget' + MsTeams: '#/components/schemas/notifications.v1.MsTeamsTarget' + example: + kind: Slack + webhook_url: https://hooks.slack.com/services/{id}/{id}/{id} + type: object + required: + - kind + - webhook_url + - role_name + - user + - url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + role_name: + type: string + description: name of the role + example: OrganizationAdmin + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + notifications.v1.SlackTarget: + type: object + description: Target required for Slack integration + required: + - kind + - webhook_url + properties: + kind: + type: string + enum: + - Slack + description: Integration Type + example: Slack + webhook_url: + type: string + format: uri + description: Slack Webhook URL for the particular Slack channel + example: https://hooks.slack.com/services/{id}/{id}/{id} + notifications.v1.RoleEmailTarget: + type: object + description: Email integration target to send email to all user with specified role + required: + - kind + - role_name + properties: + kind: + type: string + enum: + - RoleEmail + description: Email Integration type for Role + example: RoleEmail + role_name: + type: string + description: name of the role + example: OrganizationAdmin + notifications.v1.UserEmailTarget: + type: object + description: Email integration target to send email to a particular user + required: + - kind + - user + properties: + kind: + type: string + enum: + - UserEmail + description: Email Integration type for User + example: UserEmail + user: + description: Reference to the user + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + notifications.v1.WebhookTarget: + type: object + description: Target required for webhook integration + required: + - kind + - url + properties: + kind: + type: string + enum: + - Webhook + description: Integration Type + example: Webhook + url: + type: string + format: uri + description: URL endpoint for the webhook + example: https://my.webhook.url/{id} + notifications.v1.MsTeamsTarget: + type: object + description: Target required for MS Teams integration + required: + - kind + - webhook_url + properties: + kind: + type: string + enum: + - MsTeams + description: Integration Type + example: MsTeams + webhook_url: + type: string + format: uri + description: MS Teams Webhook URL for the particular team channel + example: https://admin.webhook.office.com/webhookb2/{id}/IncomingWebhook/{id} + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + OverQuotaError: + x-summary: Over Quota + description: The request would exceed one or more quotas. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '402' + code: quota_exceeded + title: Kafka Clusters Per Org Quota Exceeded + detail: 'The request would exceed the quota: kafka_clusters_per_environment' +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/org.yaml b/provider-dev/source/org.yaml new file mode 100644 index 0000000..5dca21e --- /dev/null +++ b/provider-dev/source/org.yaml @@ -0,0 +1,2544 @@ +openapi: 3.0.0 +info: + title: org API + description: confluent org API + version: 1.0.0 +paths: + /org/v2/environments: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listOrgV2Environments + summary: List of Environments + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all environments. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Environments (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Environment. + content: + application/json: + schema: + type: object + description: |- + `Environment` objects represent an isolated namespace for your Confluent resources + for organizational purposes. + + The API allows you to create, delete, and update your environments. You can retrieve + individual environments as well as a list of all your environments. + + + Related guide: [Environments in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + ## The Environments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `environments_per_org` | Environments in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - EnvironmentList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Environment` objects represent an isolated namespace for your Confluent resources + for organizational purposes. + + The API allows you to create, delete, and update your environments. You can retrieve + individual environments as well as a list of all your environments. + + + Related guide: [Environments in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + ## The Environments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `environments_per_org` | Environments in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Environment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: prod-finance01 + description: A human-readable name for the Environment + stream_governance_config: + type: object + description: Stream Governance configurations for the environment + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: | + Stream Governance Package. Supported values are ESSENTIALS and ADVANCED. + Package comparison can be found + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + required: + - id + - metadata + - display_name + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createOrgV2Environment + summary: Create an Environment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an environment. + tags: + - Environments (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Environment` objects represent an isolated namespace for your Confluent resources + for organizational purposes. + + The API allows you to create, delete, and update your environments. You can retrieve + individual environments as well as a list of all your environments. + + + Related guide: [Environments in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + ## The Environments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `environments_per_org` | Environments in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Environment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: prod-finance01 + description: A human-readable name for the Environment + stream_governance_config: + type: object + description: Stream Governance configurations for the environment + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: | + Stream Governance Package. Supported values are ESSENTIALS and ADVANCED. + Package comparison can be found + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + required: + - display_name + responses: + '201': + description: An Environment was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/org/v2/environments/{id} + description: Environment resource uri + content: + application/json: + schema: + type: object + description: |- + `Environment` objects represent an isolated namespace for your Confluent resources + for organizational purposes. + + The API allows you to create, delete, and update your environments. You can retrieve + individual environments as well as a list of all your environments. + + + Related guide: [Environments in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + ## The Environments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `environments_per_org` | Environments in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Environment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: prod-finance01 + description: A human-readable name for the Environment + stream_governance_config: + type: object + description: Stream Governance configurations for the environment + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: | + Stream Governance Package. Supported values are ESSENTIALS and ADVANCED. + Package comparison can be found + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + required: + - display_name + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /org/v2/environments/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getOrgV2Environment + summary: Read an Environment + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an environment. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the environment. + tags: + - Environments (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Environment. + content: + application/json: + schema: + type: object + description: |- + `Environment` objects represent an isolated namespace for your Confluent resources + for organizational purposes. + + The API allows you to create, delete, and update your environments. You can retrieve + individual environments as well as a list of all your environments. + + + Related guide: [Environments in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + ## The Environments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `environments_per_org` | Environments in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Environment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: prod-finance01 + description: A human-readable name for the Environment + stream_governance_config: + type: object + description: Stream Governance configurations for the environment + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: | + Stream Governance Package. Supported values are ESSENTIALS and ADVANCED. + Package comparison can be found + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + required: + - api_version + - kind + - id + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateOrgV2Environment + summary: Update an Environment + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an environment. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the environment. + tags: + - Environments (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/org.v2.Environment' + responses: + '200': + description: Environment. + content: + application/json: + schema: + type: object + description: |- + `Environment` objects represent an isolated namespace for your Confluent resources + for organizational purposes. + + The API allows you to create, delete, and update your environments. You can retrieve + individual environments as well as a list of all your environments. + + + Related guide: [Environments in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + ## The Environments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `environments_per_org` | Environments in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Environment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: prod-finance01 + description: A human-readable name for the Environment + stream_governance_config: + type: object + description: Stream Governance configurations for the environment + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: | + Stream Governance Package. Supported values are ESSENTIALS and ADVANCED. + Package comparison can be found + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + required: + - api_version + - kind + - id + - display_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteOrgV2Environment + summary: Delete an Environment + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an environment. + + If successful, this request will also recursively delete all of the environment's associated resources, + including all Kafka clusters, connectors, etc. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the environment. + tags: + - Environments (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Environment is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /org/v2/organizations: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listOrgV2Organizations + summary: List of Organizations + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all organizations. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Organizations (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Organization. + content: + application/json: + schema: + type: object + description: |- + `Organization` objects represent a customer organization. An organization contains all customer + resources (e.g., Environments, Kafka Clusters, Service Accounts, API Keys) and is tied to a billing + agreement (including any annual commitment or support plan). + + The API allows you to list, view, and update your organizations. + + + Related guide: [Organizations for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + ## The Organizations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `organizations_per_user` | Confluent Cloud organizations a user belongs to | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OrganizationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Organization` objects represent a customer organization. An organization contains all customer + resources (e.g., Environments, Kafka Clusters, Service Accounts, API Keys) and is tied to a billing + agreement (including any annual commitment or support plan). + + The API allows you to list, view, and update your organizations. + + + Related guide: [Organizations for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + ## The Organizations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `organizations_per_user` | Confluent Cloud organizations a user belongs to | + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: Finance Org + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + description: A human-readable name for the Organization + jit_enabled: + type: boolean + description: The flag to toggle Just-In-Time user provisioning for SSO-enabled organization. Available for early access only. + required: + - id + - metadata + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /org/v2/organizations/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getOrgV2Organization + summary: Read an Organization + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an organization. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the organization. + tags: + - Organizations (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Organization. + content: + application/json: + schema: + type: object + description: |- + `Organization` objects represent a customer organization. An organization contains all customer + resources (e.g., Environments, Kafka Clusters, Service Accounts, API Keys) and is tied to a billing + agreement (including any annual commitment or support plan). + + The API allows you to list, view, and update your organizations. + + + Related guide: [Organizations for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + ## The Organizations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `organizations_per_user` | Confluent Cloud organizations a user belongs to | + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: Finance Org + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + description: A human-readable name for the Organization + jit_enabled: + type: boolean + description: The flag to toggle Just-In-Time user provisioning for SSO-enabled organization. Available for early access only. + required: + - api_version + - kind + - id + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateOrgV2Organization + summary: Update an Organization + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an organization. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the organization. + tags: + - Organizations (org/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/org.v2.Organization' + responses: + '200': + description: Organization. + content: + application/json: + schema: + type: object + description: |- + `Organization` objects represent a customer organization. An organization contains all customer + resources (e.g., Environments, Kafka Clusters, Service Accounts, API Keys) and is tied to a billing + agreement (including any annual commitment or support plan). + + The API allows you to list, view, and update your organizations. + + + Related guide: [Organizations for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + ## The Organizations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `organizations_per_user` | Confluent Cloud organizations a user belongs to | + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: Finance Org + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + description: A human-readable name for the Organization + jit_enabled: + type: boolean + description: The flag to toggle Just-In-Time user provisioning for SSO-enabled organization. Available for early access only. + required: + - api_version + - kind + - id + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '402': + $ref: '#/components/responses/OverQuotaError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + org.v2.EnvironmentList: + type: object + description: |- + `Environment` objects represent an isolated namespace for your Confluent resources + for organizational purposes. + + The API allows you to create, delete, and update your environments. You can retrieve + individual environments as well as a list of all your environments. + + + Related guide: [Environments in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + ## The Environments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `environments_per_org` | Environments in one Confluent Cloud organization | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - EnvironmentList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Environment` objects represent an isolated namespace for your Confluent resources + for organizational purposes. + + The API allows you to create, delete, and update your environments. You can retrieve + individual environments as well as a list of all your environments. + + + Related guide: [Environments in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + ## The Environments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `environments_per_org` | Environments in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Environment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: prod-finance01 + description: A human-readable name for the Environment + stream_governance_config: + type: object + description: Stream Governance configurations for the environment + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: | + Stream Governance Package. Supported values are ESSENTIALS and ADVANCED. + Package comparison can be found + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + required: + - id + - metadata + - display_name + uniqueItems: true + org.v2.Environment: + type: object + description: |- + `Environment` objects represent an isolated namespace for your Confluent resources + for organizational purposes. + + The API allows you to create, delete, and update your environments. You can retrieve + individual environments as well as a list of all your environments. + + + Related guide: [Environments in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/environments.html). + + ## The Environments Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `environments_per_org` | Environments in one Confluent Cloud organization | + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Environment + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: prod-finance01 + description: A human-readable name for the Environment + stream_governance_config: + type: object + description: Stream Governance configurations for the environment + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: | + Stream Governance Package. Supported values are ESSENTIALS and ADVANCED. + Package comparison can be found + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + org.v2.OrganizationList: + type: object + description: |- + `Organization` objects represent a customer organization. An organization contains all customer + resources (e.g., Environments, Kafka Clusters, Service Accounts, API Keys) and is tied to a billing + agreement (including any annual commitment or support plan). + + The API allows you to list, view, and update your organizations. + + + Related guide: [Organizations for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + ## The Organizations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `organizations_per_user` | Confluent Cloud organizations a user belongs to | + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OrganizationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Organization` objects represent a customer organization. An organization contains all customer + resources (e.g., Environments, Kafka Clusters, Service Accounts, API Keys) and is tied to a billing + agreement (including any annual commitment or support plan). + + The API allows you to list, view, and update your organizations. + + + Related guide: [Organizations for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + ## The Organizations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `organizations_per_user` | Confluent Cloud organizations a user belongs to | + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: Finance Org + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + description: A human-readable name for the Organization + jit_enabled: + type: boolean + description: The flag to toggle Just-In-Time user provisioning for SSO-enabled organization. Available for early access only. + required: + - id + - metadata + uniqueItems: true + org.v2.Organization: + type: object + description: |- + `Organization` objects represent a customer organization. An organization contains all customer + resources (e.g., Environments, Kafka Clusters, Service Accounts, API Keys) and is tied to a billing + agreement (including any annual commitment or support plan). + + The API allows you to list, view, and update your organizations. + + + Related guide: [Organizations for Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/hierarchy/organizations/cloud-organization.html). + + ## The Organizations Model + + + ## Quotas and Limits + This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): + + | Quota | Description | + | --- | --- | + | `organizations_per_user` | Confluent Cloud organizations a user belongs to | + properties: + api_version: + type: string + enum: + - org/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + display_name: + type: string + example: Finance Org + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + description: A human-readable name for the Organization + jit_enabled: + type: boolean + description: The flag to toggle Just-In-Time user provisioning for SSO-enabled organization. Available for early access only. + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + org.v2.StreamGovernanceConfig: + description: | + Configurations pertaining to Stream Governance + type: object + properties: + package: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: | + Stream Governance Package. Supported values are ESSENTIALS and ADVANCED. + Package comparison can be found + [here](https://docs.confluent.io/cloud/current/stream-governance/packages.html#features-by-package-type). + required: + - package + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + OverQuotaError: + x-summary: Over Quota + description: The request would exceed one or more quotas. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '402' + code: quota_exceeded + title: Kafka Clusters Per Org Quota Exceeded + detail: 'The request would exceed the quota: kafka_clusters_per_environment' + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/partner.yaml b/provider-dev/source/partner.yaml new file mode 100644 index 0000000..644d435 --- /dev/null +++ b/provider-dev/source/partner.yaml @@ -0,0 +1,2268 @@ +openapi: 3.0.0 +info: + title: partner API + description: confluent partner API + version: 1.0.0 +paths: + /partner/v2/entitlements: + get: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + operationId: listPartnerV2Entitlements + summary: List of Entitlements + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Retrieve a sorted, filtered, paginated list of all entitlements. + parameters: + - name: organization.id + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: Filter the results by exact match for organization.id. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + description: An opaque pagination token for collection requests. + tags: + - Entitlements (partner/v2) + security: + - oauth: + - partner:describe + responses: + '200': + description: Entitlement. + content: + application/json: + schema: + $ref: '#/components/schemas/partner.v2.EntitlementList' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-codeSamples: + - lang: Shell + source: |- + curl --request GET \ + --url 'https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE' \ + --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' + - lang: Java + source: |- + OkHttpClient client = new OkHttpClient(); + + Request request = new Request.Builder() + .url("https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE") + .get() + .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN") + .build(); + + Response response = client.newCall(request).execute(); + - lang: Go + source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" + - lang: Python + source: |- + import http.client + + conn = http.client.HTTPSConnection("api.confluent.cloud") + + headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" } + + conn.request("GET", "/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE", headers=headers) + + res = conn.getresponse() + data = res.read() + + print(data.decode("utf-8")) + - lang: Node + source: |- + const http = require("https"); + + const options = { + "method": "GET", + "hostname": "api.confluent.cloud", + "port": null, + "path": "/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE", + "headers": { + "Authorization": "Bearer REPLACE_BEARER_TOKEN" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.end(); + - lang: C + source: |- + CURL *hnd = curl_easy_init(); + + curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); + curl_easy_setopt(hnd, CURLOPT_URL, "https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE"); + + struct curl_slist *headers = NULL; + headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); + curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); + + CURLcode ret = curl_easy_perform(hnd); + - lang: C# + source: |- + var client = new RestClient("https://api.confluent.cloud/partner/v2/entitlements?organization.id=SOME_STRING_VALUE&page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE"); + var request = new RestRequest(Method.GET); + request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); + IRestResponse response = client.Execute(request); + post: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + operationId: createPartnerV2Entitlement + summary: Create an Entitlement + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to create an entitlement. + tags: + - Entitlements (partner/v2) + security: + - oauth: + - partner:create + requestBody: + content: + application/json: + schema: + type: object + description: '`Entitlement` objects represent metadata about a marketplace entitlement.' + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Entitlement + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + external_id: + type: string + description: The unique external ID of the entitlement (this should be unique to customer) + example: 1111-2222-3333-4444 + name: + type: string + description: The name of the entitlement + example: Acme Prod Entitlement + plan_id: + type: string + description: The plan ID the entitlement + example: confluent-cloud-payg-prod + x-extensible-enum: + - confluent-cloud-payg-prod + - payg-prod.gcpmarketplace.confluent.cloud + product_id: + type: string + description: The product ID of the entitlement + example: confluent-cloud-kafka-service-azure + x-extensible-enum: + - confluent-cloud-kafka-service-azure + - confluent-cloud-for-apache-kafka + - payg-prod.gcpmarketplace.confluent.cloud + usage_reporting_id: + type: string + description: | + The usage reporting ID of the entitlement (if usage reporting uses + a different ID, otherwise, same as external_id) + example: 1111-2222-3333-4444 + resource_id: + type: string + description: The resource ID of the entitlement + example: 1111-2222-3333-4444 + organization: + description: The organization associated with this object. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + additionalProperties: false + required: + - external_id + - name + - plan_id + - product_id + responses: + '201': + description: An Entitlement is being created. + headers: + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/partner/v2/entitlements/{id} + description: Entitlement resource uri + content: + application/json: + schema: + type: object + description: '`Entitlement` objects represent metadata about a marketplace entitlement.' + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Entitlement + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + external_id: + type: string + description: The unique external ID of the entitlement (this should be unique to customer) + example: 1111-2222-3333-4444 + name: + type: string + description: The name of the entitlement + example: Acme Prod Entitlement + plan_id: + type: string + description: The plan ID the entitlement + example: confluent-cloud-payg-prod + x-extensible-enum: + - confluent-cloud-payg-prod + - payg-prod.gcpmarketplace.confluent.cloud + product_id: + type: string + description: The product ID of the entitlement + example: confluent-cloud-kafka-service-azure + x-extensible-enum: + - confluent-cloud-kafka-service-azure + - confluent-cloud-for-apache-kafka + - payg-prod.gcpmarketplace.confluent.cloud + usage_reporting_id: + type: string + description: | + The usage reporting ID of the entitlement (if usage reporting uses + a different ID, otherwise, same as external_id) + example: 1111-2222-3333-4444 + resource_id: + type: string + description: The resource ID of the entitlement + example: 1111-2222-3333-4444 + organization: + description: The organization associated with this object. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + additionalProperties: false + required: + - external_id + - name + - plan_id + - product_id + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-codeSamples: + - lang: Shell + source: |- + curl --request POST \ + --url https://api.confluent.cloud/partner/v2/entitlements \ + --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \ + --header 'content-type: application/json' \ + --data '{"external_id":"1111-2222-3333-4444","name":"Acme Prod Entitlement","plan_id":"confluent-cloud-payg-prod","product_id":"confluent-cloud-kafka-service-azure","usage_reporting_id":"1111-2222-3333-4444","resource_id":"1111-2222-3333-4444","organization":{"related":"string"}}' + - lang: Java + source: |- + OkHttpClient client = new OkHttpClient(); + + MediaType mediaType = MediaType.parse("application/json"); + RequestBody body = RequestBody.create(mediaType, "{\"external_id\":\"1111-2222-3333-4444\",\"name\":\"Acme Prod Entitlement\",\"plan_id\":\"confluent-cloud-payg-prod\",\"product_id\":\"confluent-cloud-kafka-service-azure\",\"usage_reporting_id\":\"1111-2222-3333-4444\",\"resource_id\":\"1111-2222-3333-4444\",\"organization\":{\"related\":\"string\"}}"); + Request request = new Request.Builder() + .url("https://api.confluent.cloud/partner/v2/entitlements") + .post(body) + .addHeader("content-type", "application/json") + .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN") + .build(); + + Response response = client.newCall(request).execute(); + - lang: Go + source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.confluent.cloud/partner/v2/entitlements\"\n\n\tpayload := strings.NewReader(\"{\\\"external_id\\\":\\\"1111-2222-3333-4444\\\",\\\"name\\\":\\\"Acme Prod Entitlement\\\",\\\"plan_id\\\":\\\"confluent-cloud-payg-prod\\\",\\\"product_id\\\":\\\"confluent-cloud-kafka-service-azure\\\",\\\"usage_reporting_id\\\":\\\"1111-2222-3333-4444\\\",\\\"resource_id\\\":\\\"1111-2222-3333-4444\\\",\\\"organization\\\":{\\\"related\\\":\\\"string\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" + - lang: Python + source: |- + import http.client + + conn = http.client.HTTPSConnection("api.confluent.cloud") + + payload = "{\"external_id\":\"1111-2222-3333-4444\",\"name\":\"Acme Prod Entitlement\",\"plan_id\":\"confluent-cloud-payg-prod\",\"product_id\":\"confluent-cloud-kafka-service-azure\",\"usage_reporting_id\":\"1111-2222-3333-4444\",\"resource_id\":\"1111-2222-3333-4444\",\"organization\":{\"related\":\"string\"}}" + + headers = { + 'content-type': "application/json", + 'Authorization': "Bearer REPLACE_BEARER_TOKEN" + } + + conn.request("POST", "/partner/v2/entitlements", payload, headers) + + res = conn.getresponse() + data = res.read() + + print(data.decode("utf-8")) + - lang: Node + source: |- + const http = require("https"); + + const options = { + "method": "POST", + "hostname": "api.confluent.cloud", + "port": null, + "path": "/partner/v2/entitlements", + "headers": { + "content-type": "application/json", + "Authorization": "Bearer REPLACE_BEARER_TOKEN" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.write(JSON.stringify({ + external_id: '1111-2222-3333-4444', + name: 'Acme Prod Entitlement', + plan_id: 'confluent-cloud-payg-prod', + product_id: 'confluent-cloud-kafka-service-azure', + usage_reporting_id: '1111-2222-3333-4444', + resource_id: '1111-2222-3333-4444', + organization: {related: 'string'} + })); + req.end(); + - lang: C + source: |- + CURL *hnd = curl_easy_init(); + + curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST"); + curl_easy_setopt(hnd, CURLOPT_URL, "https://api.confluent.cloud/partner/v2/entitlements"); + + struct curl_slist *headers = NULL; + headers = curl_slist_append(headers, "content-type: application/json"); + headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); + curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); + + curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"external_id\":\"1111-2222-3333-4444\",\"name\":\"Acme Prod Entitlement\",\"plan_id\":\"confluent-cloud-payg-prod\",\"product_id\":\"confluent-cloud-kafka-service-azure\",\"usage_reporting_id\":\"1111-2222-3333-4444\",\"resource_id\":\"1111-2222-3333-4444\",\"organization\":{\"related\":\"string\"}}"); + + CURLcode ret = curl_easy_perform(hnd); + - lang: C# + source: |- + var client = new RestClient("https://api.confluent.cloud/partner/v2/entitlements"); + var request = new RestRequest(Method.POST); + request.AddHeader("content-type", "application/json"); + request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); + request.AddParameter("application/json", "{\"external_id\":\"1111-2222-3333-4444\",\"name\":\"Acme Prod Entitlement\",\"plan_id\":\"confluent-cloud-payg-prod\",\"product_id\":\"confluent-cloud-kafka-service-azure\",\"usage_reporting_id\":\"1111-2222-3333-4444\",\"resource_id\":\"1111-2222-3333-4444\",\"organization\":{\"related\":\"string\"}}", ParameterType.RequestBody); + IRestResponse response = client.Execute(request); + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + /partner/v2/entitlements/{id}: + get: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + operationId: getPartnerV2Entitlement + summary: Read an Entitlement + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to read an entitlement. + parameters: + - name: organization.id + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: Scope the operation to the given organization.id. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the entitlement. + tags: + - Entitlements (partner/v2) + security: + - oauth: + - partner:describe + responses: + '200': + description: Entitlement. + content: + application/json: + schema: + type: object + description: '`Entitlement` objects represent metadata about a marketplace entitlement.' + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Entitlement + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + external_id: + type: string + description: The unique external ID of the entitlement (this should be unique to customer) + example: 1111-2222-3333-4444 + name: + type: string + description: The name of the entitlement + example: Acme Prod Entitlement + plan_id: + type: string + description: The plan ID the entitlement + example: confluent-cloud-payg-prod + x-extensible-enum: + - confluent-cloud-payg-prod + - payg-prod.gcpmarketplace.confluent.cloud + product_id: + type: string + description: The product ID of the entitlement + example: confluent-cloud-kafka-service-azure + x-extensible-enum: + - confluent-cloud-kafka-service-azure + - confluent-cloud-for-apache-kafka + - payg-prod.gcpmarketplace.confluent.cloud + usage_reporting_id: + type: string + description: | + The usage reporting ID of the entitlement (if usage reporting uses + a different ID, otherwise, same as external_id) + example: 1111-2222-3333-4444 + resource_id: + type: string + description: The resource ID of the entitlement + example: 1111-2222-3333-4444 + organization: + description: The organization associated with this object. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + additionalProperties: false + required: + - external_id + - name + - plan_id + - product_id + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-codeSamples: + - lang: Shell + source: |- + curl --request GET \ + --url 'https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE' \ + --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' + - lang: Java + source: |- + OkHttpClient client = new OkHttpClient(); + + Request request = new Request.Builder() + .url("https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE") + .get() + .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN") + .build(); + + Response response = client.newCall(request).execute(); + - lang: Go + source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" + - lang: Python + source: |- + import http.client + + conn = http.client.HTTPSConnection("api.confluent.cloud") + + headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" } + + conn.request("GET", "/partner/v2/entitlements/%7Bid%7D?organization.id=SOME_STRING_VALUE", headers=headers) + + res = conn.getresponse() + data = res.read() + + print(data.decode("utf-8")) + - lang: Node + source: |- + const http = require("https"); + + const options = { + "method": "GET", + "hostname": "api.confluent.cloud", + "port": null, + "path": "/partner/v2/entitlements/%7Bid%7D?organization.id=SOME_STRING_VALUE", + "headers": { + "Authorization": "Bearer REPLACE_BEARER_TOKEN" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.end(); + - lang: C + source: |- + CURL *hnd = curl_easy_init(); + + curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); + curl_easy_setopt(hnd, CURLOPT_URL, "https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE"); + + struct curl_slist *headers = NULL; + headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); + curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); + + CURLcode ret = curl_easy_perform(hnd); + - lang: C# + source: |- + var client = new RestClient("https://api.confluent.cloud/partner/v2/entitlements/{id}?organization.id=SOME_STRING_VALUE"); + var request = new RestRequest(Method.GET); + request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); + IRestResponse response = client.Execute(request); + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + /partner/v2/organizations/{id}: + get: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + operationId: getPartnerV2Organization + summary: Read an Organization + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to read an organization. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the organization. + tags: + - Organizations (partner/v2) + security: + - oauth: + - marketplace::describe + responses: + '200': + description: Organization. + content: + application/json: + schema: + type: object + description: '`Organizations` objects represent an entire Confluent Cloud organization.' + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + name: + type: string + description: The name of the organization + example: Acme Organization + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + sso_url: + type: string + format: uri + description: The login URL for the customer to access Confluent Cloud + example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn + readOnly: true + sso_config: + discriminator: + propertyName: kind + type: object + required: + - kind + - tenant_id + properties: + kind: + type: string + example: AzureSSOConfig + tenant_id: + type: string + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: The Azure AD tenant ID + additionalProperties: false + required: + - api_version + - kind + - id + - metadata + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-codeSamples: + - lang: Shell + source: |- + curl --request GET \ + --url 'https://api.confluent.cloud/partner/v2/organizations/{id}' \ + --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' + - lang: Java + source: |- + OkHttpClient client = new OkHttpClient(); + + Request request = new Request.Builder() + .url("https://api.confluent.cloud/partner/v2/organizations/{id}") + .get() + .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN") + .build(); + + Response response = client.newCall(request).execute(); + - lang: Go + source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.confluent.cloud/partner/v2/organizations/{id}\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" + - lang: Python + source: |- + import http.client + + conn = http.client.HTTPSConnection("api.confluent.cloud") + + headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" } + + conn.request("GET", "/partner/v2/organizations/{id}", headers=headers) + + res = conn.getresponse() + data = res.read() + + print(data.decode("utf-8")) + - lang: Node + source: |- + const http = require("https"); + + const options = { + "method": "GET", + "hostname": "api.confluent.cloud", + "port": null, + "path": "/partner/v2/organizations/{id}", + "headers": { + "Authorization": "Bearer REPLACE_BEARER_TOKEN" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.end(); + - lang: C + source: |- + CURL *hnd = curl_easy_init(); + + curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); + curl_easy_setopt(hnd, CURLOPT_URL, "https://api.confluent.cloud/partner/v2/organizations/{id}"); + + struct curl_slist *headers = NULL; + headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); + curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); + + CURLcode ret = curl_easy_perform(hnd); + - lang: C# + source: |- + var client = new RestClient("https://api.confluent.cloud/partner/v2/organizations/{id}"); + var request = new RestRequest(Method.GET); + request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); + IRestResponse response = client.Execute(request); + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + /partner/v2/organizations: + get: + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + operationId: listPartnerV2Organizations + summary: List of Organizations + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Retrieve a sorted, filtered, paginated list of all organizations. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + description: An opaque pagination token for collection requests. + tags: + - Organizations (partner/v2) + security: + - oauth: + - marketplace::describe + responses: + '200': + description: Organization. + content: + application/json: + schema: + $ref: '#/components/schemas/partner.v2.OrganizationList' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-codeSamples: + - lang: Shell + source: |- + curl --request GET \ + --url 'https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE' \ + --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' + - lang: Java + source: |- + OkHttpClient client = new OkHttpClient(); + + Request request = new Request.Builder() + .url("https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE") + .get() + .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN") + .build(); + + Response response = client.newCall(request).execute(); + - lang: Go + source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" + - lang: Python + source: |- + import http.client + + conn = http.client.HTTPSConnection("api.confluent.cloud") + + headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" } + + conn.request("GET", "/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE", headers=headers) + + res = conn.getresponse() + data = res.read() + + print(data.decode("utf-8")) + - lang: Node + source: |- + const http = require("https"); + + const options = { + "method": "GET", + "hostname": "api.confluent.cloud", + "port": null, + "path": "/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE", + "headers": { + "Authorization": "Bearer REPLACE_BEARER_TOKEN" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.end(); + - lang: C + source: |- + CURL *hnd = curl_easy_init(); + + curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); + curl_easy_setopt(hnd, CURLOPT_URL, "https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE"); + + struct curl_slist *headers = NULL; + headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); + curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); + + CURLcode ret = curl_easy_perform(hnd); + - lang: C# + source: |- + var client = new RestClient("https://api.confluent.cloud/partner/v2/organizations?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE"); + var request = new RestRequest(Method.GET); + request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN"); + IRestResponse response = client.Execute(request); + x-lifecycle-stage: Early Access + x-request-access-name: Partner v2 + /partner/v2/signup: + post: + summary: Signup an Organization on behalf of a Customer + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Create an organization for a customer. You must pass in either an entitlement object reference (a url to + a previously created entitlement) or entitlement details. If you pass in an entitlement object reference, we will link with the + created entitlement. If you pass in the entitlement details, we will create the entitlement with the organization + in a single transaction. If you pass in user details (email, given name, and family name), we will + create a user as well. If you do not pass in user details, you MUST call `/partner/v2/signup/activate` + with user details to complete signup. + parameters: + - name: dry_run + in: query + required: false + schema: + type: boolean + description: If true, only perform validation of signup + requestBody: + description: A JSON object containing signup information + content: + application/json: + schema: + $ref: '#/components/schemas/PartnerSignupRequest' + x-lifecycle-stage: Early Access + operationId: signup + tags: + - Signup (partner/v2) + security: + - oauth: + - partner:create + responses: + '201': + description: Successful signup. + content: + application/json: + schema: + $ref: '#/components/schemas/PartnerSignupResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + /partner/v2/signup/activate: + post: + summary: Activate an Incomplete Signup + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Creates a user in the organization previously created in `/partner/v2/signup`. This completes the signup + process if you did not pass in user details to `/partner/v2/signup`. Calling this endpoint if the signup + process has been completed will result in a `409 Conflict` error. + requestBody: + description: A JSON object containing signup information + content: + application/json: + schema: + $ref: '#/components/schemas/ActivatePartnerSignupRequest' + x-lifecycle-stage: Early Access + operationId: activateSignup + tags: + - Signup (partner/v2) + security: + - oauth: + - partner:create + responses: + '201': + description: Successful signup activation. User is being created. + content: + application/json: + schema: + $ref: '#/components/schemas/PartnerSignupResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Early Access + /partner/v2/signup/link: + post: + summary: Signup a Customer by Linking to an Existing Organization + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Signup a customer by linking a new entitlement to an existing Confluent Cloud organization. + parameters: + - name: dry_run + in: query + required: false + schema: + type: boolean + description: If true, only perform validation of signup + requestBody: + description: A JSON object containing signup information + content: + application/json: + schema: + $ref: '#/components/schemas/PartnerLinkRequest' + x-lifecycle-stage: Early Access + operationId: signupPartnerV2Link + tags: + - Signup (partner/v2) + security: + - oauth: + - partner:create + responses: + '201': + description: Successful signup. + content: + application/json: + schema: + $ref: '#/components/schemas/PartnerSignupResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + partner.v2.EntitlementList: + type: object + description: '`Entitlement` objects represent metadata about a marketplace entitlement.' + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - EntitlementList + metadata: + $ref: '#/components/schemas/ListMeta' + data: + type: array + items: + type: object + description: '`Entitlement` objects represent metadata about a marketplace entitlement.' + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Entitlement + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + external_id: + type: string + description: The unique external ID of the entitlement (this should be unique to customer) + example: 1111-2222-3333-4444 + name: + type: string + description: The name of the entitlement + example: Acme Prod Entitlement + plan_id: + type: string + description: The plan ID the entitlement + example: confluent-cloud-payg-prod + x-extensible-enum: + - confluent-cloud-payg-prod + - payg-prod.gcpmarketplace.confluent.cloud + product_id: + type: string + description: The product ID of the entitlement + example: confluent-cloud-kafka-service-azure + x-extensible-enum: + - confluent-cloud-kafka-service-azure + - confluent-cloud-for-apache-kafka + - payg-prod.gcpmarketplace.confluent.cloud + usage_reporting_id: + type: string + description: | + The usage reporting ID of the entitlement (if usage reporting uses + a different ID, otherwise, same as external_id) + example: 1111-2222-3333-4444 + resource_id: + type: string + description: The resource ID of the entitlement + example: 1111-2222-3333-4444 + organization: + description: The organization associated with this object. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + additionalProperties: false + required: + - id + - metadata + - external_id + - name + - plan_id + - product_id + uniqueItems: true + additionalProperties: false + partner.v2.Entitlement: + type: object + description: '`Entitlement` objects represent metadata about a marketplace entitlement.' + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Entitlement + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + external_id: + type: string + description: The unique external ID of the entitlement (this should be unique to customer) + example: 1111-2222-3333-4444 + name: + type: string + description: The name of the entitlement + example: Acme Prod Entitlement + plan_id: + type: string + description: The plan ID the entitlement + example: confluent-cloud-payg-prod + x-extensible-enum: + - confluent-cloud-payg-prod + - payg-prod.gcpmarketplace.confluent.cloud + product_id: + type: string + description: The product ID of the entitlement + example: confluent-cloud-kafka-service-azure + x-extensible-enum: + - confluent-cloud-kafka-service-azure + - confluent-cloud-for-apache-kafka + - payg-prod.gcpmarketplace.confluent.cloud + usage_reporting_id: + type: string + description: | + The usage reporting ID of the entitlement (if usage reporting uses + a different ID, otherwise, same as external_id) + example: 1111-2222-3333-4444 + resource_id: + type: string + description: The resource ID of the entitlement + example: 1111-2222-3333-4444 + organization: + description: The organization associated with this object. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + additionalProperties: false + partner.v2.Organization: + type: object + description: '`Organizations` objects represent an entire Confluent Cloud organization.' + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + name: + type: string + description: The name of the organization + example: Acme Organization + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + sso_url: + type: string + format: uri + description: The login URL for the customer to access Confluent Cloud + example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn + readOnly: true + sso_config: + discriminator: + propertyName: kind + type: object + required: + - kind + - tenant_id + properties: + kind: + type: string + example: AzureSSOConfig + tenant_id: + type: string + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: The Azure AD tenant ID + additionalProperties: false + partner.v2.OrganizationList: + type: object + description: '`Organizations` objects represent an entire Confluent Cloud organization.' + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OrganizationList + metadata: + $ref: '#/components/schemas/ListMeta' + data: + type: array + items: + type: object + description: '`Organizations` objects represent an entire Confluent Cloud organization.' + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + name: + type: string + description: The name of the organization + example: Acme Organization + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + sso_url: + type: string + format: uri + description: The login URL for the customer to access Confluent Cloud + example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn + readOnly: true + sso_config: + discriminator: + propertyName: kind + type: object + required: + - kind + - tenant_id + properties: + kind: + type: string + example: AzureSSOConfig + tenant_id: + type: string + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: The Azure AD tenant ID + additionalProperties: false + required: + - id + - metadata + uniqueItems: true + additionalProperties: false + PartnerSignupRequest: + type: object + description: The partner signup request + required: + - organization + - entitlement + properties: + organization: + type: object + description: '`Organizations` objects represent an entire Confluent Cloud organization.' + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + name: + type: string + description: The name of the organization + example: Acme Organization + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + sso_url: + type: string + format: uri + description: The login URL for the customer to access Confluent Cloud + example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn + readOnly: true + sso_config: + discriminator: + propertyName: kind + type: object + required: + - kind + - tenant_id + properties: + kind: + type: string + example: AzureSSOConfig + tenant_id: + type: string + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: The Azure AD tenant ID + additionalProperties: false + required: + - name + - sso_config + user: + type: string + description: (opaque JSON object) + required: + - given_name + - family_name + - email + entitlement: + type: object + description: '`Entitlement` objects represent metadata about a marketplace entitlement.' + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Entitlement + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + external_id: + type: string + description: The unique external ID of the entitlement (this should be unique to customer) + example: 1111-2222-3333-4444 + name: + type: string + description: The name of the entitlement + example: Acme Prod Entitlement + plan_id: + type: string + description: The plan ID the entitlement + example: confluent-cloud-payg-prod + x-extensible-enum: + - confluent-cloud-payg-prod + - payg-prod.gcpmarketplace.confluent.cloud + product_id: + type: string + description: The product ID of the entitlement + example: confluent-cloud-kafka-service-azure + x-extensible-enum: + - confluent-cloud-kafka-service-azure + - confluent-cloud-for-apache-kafka + - payg-prod.gcpmarketplace.confluent.cloud + usage_reporting_id: + type: string + description: | + The usage reporting ID of the entitlement (if usage reporting uses + a different ID, otherwise, same as external_id) + example: 1111-2222-3333-4444 + resource_id: + type: string + description: The resource ID of the entitlement + example: 1111-2222-3333-4444 + organization: + description: The organization associated with this object. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + additionalProperties: false + required: + - external_id + - name + - plan_id + - product_id + - id + - related + - resource_name + PartnerSignupResponse: + type: object + description: The partner signup response + required: + - organization_id + - sso_url + properties: + organization_id: + type: string + description: The ID of the organization + example: b3a17773-05cc-4431-9560-433fb4613da8 + sso_url: + type: string + format: uri + description: The login URL for the customer to access Confluent Cloud + example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn + display_message: + type: string + description: The display message contains useful information which is shown on the Marketplace UI to the customers. + example: Your support plan will remain the same, to change the plan, follow this [link](https://docs.confluent.io/cloud/current/faq.html#how-do-i-change-support-plans). + ActivatePartnerSignupRequest: + type: object + description: The partner signup activation request + required: + - user + - organization_id + properties: + user: + type: string + description: (opaque JSON object) + required: + - given_name + - family_name + - email + organization_id: + type: string + description: The ID of the organization + example: b3a17773-05cc-4431-9560-433fb4613da8 + PartnerLinkRequest: + type: object + description: The partner linking request + required: + - token + - organization + - entitlement + properties: + token: + type: string + description: The linking token that was generated. + example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c + x-redact: true + organization: + type: object + description: '`Organizations` objects represent an entire Confluent Cloud organization.' + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Organization + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + name: + type: string + description: The name of the organization + example: Acme Organization + pattern: ^[^<>#%'*^`{|}~\"]{1,31}$ + sso_url: + type: string + format: uri + description: The login URL for the customer to access Confluent Cloud + example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn + readOnly: true + sso_config: + discriminator: + propertyName: kind + type: object + required: + - kind + - tenant_id + properties: + kind: + type: string + example: AzureSSOConfig + tenant_id: + type: string + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: The Azure AD tenant ID + additionalProperties: false + required: + - sso_config + entitlement: + type: object + description: '`Entitlement` objects represent metadata about a marketplace entitlement.' + properties: + api_version: + type: string + enum: + - partner/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Entitlement + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + readOnly: true + example: dlz-f3a90de + metadata: + $ref: '#/components/schemas/ObjectMeta' + external_id: + type: string + description: The unique external ID of the entitlement (this should be unique to customer) + example: 1111-2222-3333-4444 + name: + type: string + description: The name of the entitlement + example: Acme Prod Entitlement + plan_id: + type: string + description: The plan ID the entitlement + example: confluent-cloud-payg-prod + x-extensible-enum: + - confluent-cloud-payg-prod + - payg-prod.gcpmarketplace.confluent.cloud + product_id: + type: string + description: The product ID of the entitlement + example: confluent-cloud-kafka-service-azure + x-extensible-enum: + - confluent-cloud-kafka-service-azure + - confluent-cloud-for-apache-kafka + - payg-prod.gcpmarketplace.confluent.cloud + usage_reporting_id: + type: string + description: | + The usage reporting ID of the entitlement (if usage reporting uses + a different ID, otherwise, same as external_id) + example: 1111-2222-3333-4444 + resource_id: + type: string + description: The resource ID of the entitlement + example: 1111-2222-3333-4444 + organization: + description: The organization associated with this object. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + additionalProperties: false + required: + - external_id + - name + - plan_id + - product_id + - id + - related + - resource_name + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + ObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + AzureSSOConfig: + type: object + required: + - kind + - tenant_id + properties: + kind: + type: string + example: AzureSSOConfig + tenant_id: + type: string + example: b3a17773-05cc-4431-9560-433fb4613da8 + description: The Azure AD tenant ID + v2.User: + type: string + description: (opaque JSON object) + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/provider_integrations.yaml b/provider-dev/source/provider_integrations.yaml new file mode 100644 index 0000000..07c9e16 --- /dev/null +++ b/provider-dev/source/provider_integrations.yaml @@ -0,0 +1,4300 @@ +openapi: 3.0.0 +info: + title: provider_integrations API + description: confluent provider_integrations API + version: 1.0.0 +paths: + /pim/v1/integrations: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listPimV1Integrations + summary: List of Integrations + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all integrations. + + If no `provider` filter is specified, returns provider integrations from all clouds. + parameters: + - name: provider + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for provider. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Integrations (pim/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, and delete individual integrations, and also obtain a + list of all your provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - pim/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, and delete individual integrations, and also obtain a + list of all your provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: s3_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider integration. + example: AWS + default: AWS + x-extensible-enum: + - AWS + config: + type: object + description: Cloud provider specific configs for provider integration + discriminator: + propertyName: kind + mapping: + AwsIntegrationConfig: '#/components/schemas/pim.v1.AwsIntegrationConfig' + x-immutable: true + properties: + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true' + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - config + - environment + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createPimV1Integration + summary: Create an Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an integration. + tags: + - Integrations (pim/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, and delete individual integrations, and also obtain a + list of all your provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: s3_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider integration. + example: AWS + default: AWS + x-extensible-enum: + - AWS + config: + type: object + description: Cloud provider specific configs for provider integration + discriminator: + propertyName: kind + mapping: + AwsIntegrationConfig: '#/components/schemas/pim.v1.AwsIntegrationConfig' + x-immutable: true + properties: + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true' + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - config + - environment + responses: + '201': + description: An Integration was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/pim/v1/integrations/{id} + description: Integration resource uri + content: + application/json: + schema: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, and delete individual integrations, and also obtain a + list of all your provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: s3_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider integration. + example: AWS + default: AWS + x-extensible-enum: + - AWS + config: + type: object + description: Cloud provider specific configs for provider integration + discriminator: + propertyName: kind + mapping: + AwsIntegrationConfig: '#/components/schemas/pim.v1.AwsIntegrationConfig' + x-immutable: true + properties: + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true' + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - config + - environment + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /pim/v1/integrations/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getPimV1Integration + summary: Read an Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (pim/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, and delete individual integrations, and also obtain a + list of all your provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: s3_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider integration. + example: AWS + default: AWS + x-extensible-enum: + - AWS + config: + type: object + description: Cloud provider specific configs for provider integration + discriminator: + propertyName: kind + mapping: + AwsIntegrationConfig: '#/components/schemas/pim.v1.AwsIntegrationConfig' + x-immutable: true + properties: + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true' + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - config + - environment + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deletePimV1Integration + summary: Delete an Integration + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete an integration. + + This request fails if existing workloads are using this CSP integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (pim/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Integration is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /pim/v2/integrations: + get: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + operationId: listPimV2Integrations + summary: List of Integrations + description: | + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Retrieve a sorted, filtered, paginated list of all integrations. + + If no `provider` filter is specified, returns provider integrations from all clouds. + parameters: + - name: display_name + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: bigquery_provider_integration + description: Filter the results by a partial search of display_name. + - name: provider + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: GCP + description: Filter the results by exact match for provider. + - name: status + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: CREATED + description: Filter the results by exact match for status. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, update, delete, and validate individual integrations, and also obtain a + list of all your provider integrations. + + Note: The pim/v2 API currently supports only Azure and GCP provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - pim/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, update, delete, and validate individual integrations, and also obtain a + list of all your provider integrations. + + Note: The pim/v2 API currently supports only Azure and GCP provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: | + Cloud provider specific configuration for the provider integration. + Required only when updating integrations with `DRAFT` status. Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud uses to impersonate + customer Google Service Account when it accesses resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud impersonates + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: | + The ID of the Confluent Multi-Tenant App that Confluent Cloud uses to impersonate + customer Azure App when it accesses resources in your Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: | + The ID of the customer's Azure Active Directory (Azure AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: | + Status of the provider integration. + - `DRAFT`: Integration exists but is not associated with customer configuration + - `CREATED`: Integration has been associated with customer configuration + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - id + - status + - environment + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + operationId: createPimV2Integration + summary: Create an Integration + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to create an integration. + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, update, delete, and validate individual integrations, and also obtain a + list of all your provider integrations. + + Note: The pim/v2 API currently supports only Azure and GCP provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: | + Cloud provider specific configuration for the provider integration. + Required only when updating integrations with `DRAFT` status. Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud uses to impersonate + customer Google Service Account when it accesses resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud impersonates + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: | + The ID of the Confluent Multi-Tenant App that Confluent Cloud uses to impersonate + customer Azure App when it accesses resources in your Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: | + The ID of the customer's Azure Active Directory (Azure AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: | + Status of the provider integration. + - `DRAFT`: Integration exists but is not associated with customer configuration + - `CREATED`: Integration has been associated with customer configuration + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - environment + responses: + '201': + description: An Integration was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/pim/v2/integrations/{id} + description: Integration resource uri + content: + application/json: + schema: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, update, delete, and validate individual integrations, and also obtain a + list of all your provider integrations. + + Note: The pim/v2 API currently supports only Azure and GCP provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: | + Cloud provider specific configuration for the provider integration. + Required only when updating integrations with `DRAFT` status. Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud uses to impersonate + customer Google Service Account when it accesses resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud impersonates + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: | + The ID of the Confluent Multi-Tenant App that Confluent Cloud uses to impersonate + customer Azure App when it accesses resources in your Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: | + The ID of the customer's Azure Active Directory (Azure AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: | + Status of the provider integration. + - `DRAFT`: Integration exists but is not associated with customer configuration + - `CREATED`: Integration has been associated with customer configuration + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - status + - environment + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + /pim/v2/integrations/{id}: + get: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + operationId: getPimV2Integration + summary: Read an Integration + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to read an integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, update, delete, and validate individual integrations, and also obtain a + list of all your provider integrations. + + Note: The pim/v2 API currently supports only Azure and GCP provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: | + Cloud provider specific configuration for the provider integration. + Required only when updating integrations with `DRAFT` status. Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud uses to impersonate + customer Google Service Account when it accesses resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud impersonates + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: | + The ID of the Confluent Multi-Tenant App that Confluent Cloud uses to impersonate + customer Azure App when it accesses resources in your Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: | + The ID of the customer's Azure Active Directory (Azure AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: | + Status of the provider integration. + - `DRAFT`: Integration exists but is not associated with customer configuration + - `CREATED`: Integration has been associated with customer configuration + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - status + - environment + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + operationId: updatePimV2Integration + summary: Update an Integration + description: |+ + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to update an integration. + + This request only works for integrations with `DRAFT` status. + + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, update, delete, and validate individual integrations, and also obtain a + list of all your provider integrations. + + Note: The pim/v2 API currently supports only Azure and GCP provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: | + Cloud provider specific configuration for the provider integration. + Required only when updating integrations with `DRAFT` status. Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud uses to impersonate + customer Google Service Account when it accesses resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud impersonates + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: | + The ID of the Confluent Multi-Tenant App that Confluent Cloud uses to impersonate + customer Azure App when it accesses resources in your Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: | + The ID of the customer's Azure Active Directory (Azure AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: | + Status of the provider integration. + - `DRAFT`: Integration exists but is not associated with customer configuration + - `CREATED`: Integration has been associated with customer configuration + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - environment + responses: + '200': + description: Integration. + content: + application/json: + schema: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, update, delete, and validate individual integrations, and also obtain a + list of all your provider integrations. + + Note: The pim/v2 API currently supports only Azure and GCP provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: | + Cloud provider specific configuration for the provider integration. + Required only when updating integrations with `DRAFT` status. Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud uses to impersonate + customer Google Service Account when it accesses resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud impersonates + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: | + The ID of the Confluent Multi-Tenant App that Confluent Cloud uses to impersonate + customer Azure App when it accesses resources in your Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: | + The ID of the customer's Azure Active Directory (Azure AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: | + Status of the provider integration. + - `DRAFT`: Integration exists but is not associated with customer configuration + - `CREATED`: Integration has been associated with customer configuration + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - status + - environment + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + operationId: deletePimV2Integration + summary: Delete an Integration + description: | + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Make a request to delete an integration. + + This request fails if existing workloads are using this CSP integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the integration. + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: An Integration is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + /pim/v2/integrations:validate: + post: + description: | + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) + + Validate the provider integration configuration. + requestBody: + content: + application/json: + schema: + type: object + description: Request to validate the provider integration configuration. + properties: + api_version: + type: string + enum: + - pim/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationValidateRequest + id: + type: string + description: The ID of the provider integration to validate. + example: cspi-00000 + maxLength: 255 + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + config: + type: object + description: | + Cloud provider specific configuration for the provider integration. + Required only for integrations in `DRAFT` status. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud uses to impersonate + customer Google Service Account when it accesses resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud impersonates + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: | + The ID of the Confluent Multi-Tenant App that Confluent Cloud uses to impersonate + customer Azure App when it accesses resources in your Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: | + The ID of the customer's Azure Active Directory (Azure AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - environment + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration + x-name: pim.v2.Integration + operationId: validatePimV2Integration + summary: Validate an Integration + tags: + - Integrations (pim/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: The provider integration configuration is validated successfully. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Early Access + x-self-access: false + x-request-access-name: Provider Integration +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + pim.v1.IntegrationList: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, and delete individual integrations, and also obtain a + list of all your provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - pim/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, and delete individual integrations, and also obtain a + list of all your provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: s3_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider integration. + example: AWS + default: AWS + x-extensible-enum: + - AWS + config: + type: object + description: Cloud provider specific configs for provider integration + discriminator: + propertyName: kind + mapping: + AwsIntegrationConfig: '#/components/schemas/pim.v1.AwsIntegrationConfig' + x-immutable: true + properties: + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true' + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - config + - environment + uniqueItems: true + pim.v1.Integration: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, and delete individual integrations, and also obtain a + list of all your provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: s3_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider integration. + example: AWS + default: AWS + x-extensible-enum: + - AWS + config: + type: object + description: Cloud provider specific configs for provider integration + discriminator: + propertyName: kind + mapping: + AwsIntegrationConfig: '#/components/schemas/pim.v1.AwsIntegrationConfig' + x-immutable: true + properties: + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + environment: + description: The environment to which this belongs. + x-immutable: true' + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + pim.v2.IntegrationList: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, update, delete, and validate individual integrations, and also obtain a + list of all your provider integrations. + + Note: The pim/v2 API currently supports only Azure and GCP provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - pim/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, update, delete, and validate individual integrations, and also obtain a + list of all your provider integrations. + + Note: The pim/v2 API currently supports only Azure and GCP provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: | + Cloud provider specific configuration for the provider integration. + Required only when updating integrations with `DRAFT` status. Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud uses to impersonate + customer Google Service Account when it accesses resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud impersonates + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: | + The ID of the Confluent Multi-Tenant App that Confluent Cloud uses to impersonate + customer Azure App when it accesses resources in your Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: | + The ID of the customer's Azure Active Directory (Azure AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: | + Status of the provider integration. + - `DRAFT`: Integration exists but is not associated with customer configuration + - `CREATED`: Integration has been associated with customer configuration + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + required: + - id + - status + - environment + uniqueItems: true + pim.v2.Integration: + type: object + description: |- + `Provider Integration` objects represent access to public cloud service provider (CSP) resources + that may be accessed by Confluent resources (for example, connectors). + + The API allows you to create, retrieve, update, delete, and validate individual integrations, and also obtain a + list of all your provider integrations. + + Note: The pim/v2 API currently supports only Azure and GCP provider integrations. + + + Related guide: [Provider Integration in Confluent Cloud](https://docs.confluent.io/home/overview.html). + + ## The Integrations Model + + properties: + api_version: + type: string + enum: + - pim/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Integration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + example: bigquery_provider_integration + description: Display name of Provider Integration. + maxLength: 60 + x-immutable: true + provider: + type: string + description: Cloud provider to which access is provided through provider integration. + example: GCP + default: GCP + x-extensible-enum: + - GCP + x-immutable: true + config: + type: object + description: | + Cloud provider specific configuration for the provider integration. + Required only when updating integrations with `DRAFT` status. Not required during creation. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud uses to impersonate + customer Google Service Account when it accesses resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud impersonates + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: | + The ID of the Confluent Multi-Tenant App that Confluent Cloud uses to impersonate + customer Azure App when it accesses resources in your Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: | + The ID of the customer's Azure Active Directory (Azure AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + usages: + type: array + description: List of resource crns where this integration is being used. + minItems: 0 + items: + type: string + description: crn that specifies the resource using this integration + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector + readOnly: true + status: + type: string + description: | + Status of the provider integration. + - `DRAFT`: Integration exists but is not associated with customer configuration + - `CREATED`: Integration has been associated with customer configuration + - `ACTIVE`: Integration is in use by Confluent resources + example: CREATED + x-extensible-enum: + - DRAFT + - CREATED + - ACTIVE + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + pim.v2.IntegrationValidateRequest: + type: object + description: Request to validate the provider integration configuration. + properties: + api_version: + type: string + enum: + - pim/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - IntegrationValidateRequest + id: + type: string + description: The ID of the provider integration to validate. + example: cspi-00000 + maxLength: 255 + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + config: + type: object + description: | + Cloud provider specific configuration for the provider integration. + Required only for integrations in `DRAFT` status. + discriminator: + propertyName: kind + mapping: + GcpIntegrationConfig: '#/components/schemas/pim.v2.GcpIntegrationConfig' + AzureIntegrationConfig: '#/components/schemas/pim.v2.AzureIntegrationConfig' + AwsIntegrationConfig: '#/components/schemas/pim.v2.AwsIntegrationConfig' + properties: + google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud uses to impersonate + customer Google Service Account when it accesses resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud impersonates + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + confluent_multi_tenant_app_id: + type: string + description: | + The ID of the Confluent Multi-Tenant App that Confluent Cloud uses to impersonate + customer Azure App when it accesses resources in your Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: | + The ID of the customer's Azure Active Directory (Azure AD) tenant + example: 12345678-1234-1234-1234-123456789abc + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + required: + - kind + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + pim.v1.AwsIntegrationConfig: + type: object + description: | + config schema for AWS cloud service provider. + properties: + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + GlobalObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + pim.v2.GcpIntegrationConfig: + type: object + description: | + config schema for GCP cloud service provider. + properties: + google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud uses to impersonate + customer Google Service Account when it accesses resources in your GCP project. + example: cspi-sa1@cflt-project.iam.gserviceaccount.com + readOnly: true + customer_google_service_account: + type: string + description: | + The ID of the Google Service Account that Confluent Cloud impersonates + to access resources in your GCP Project. + example: customer-sa@customer-project.iam.gserviceaccount.com + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: GcpIntegrationConfig + x-extensible-enum: + - GcpIntegrationConfig + required: + - kind + pim.v2.AzureIntegrationConfig: + type: object + description: | + config schema for Azure cloud service provider. + properties: + confluent_multi_tenant_app_id: + type: string + description: | + The ID of the Confluent Multi-Tenant App that Confluent Cloud uses to impersonate + customer Azure App when it accesses resources in your Azure subscription. + example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a + readOnly: true + customer_azure_tenant_id: + type: string + description: | + The ID of the customer's Azure Active Directory (Azure AD) tenant + example: 12345678-1234-1234-1234-123456789abc + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: AzureIntegrationConfig + x-extensible-enum: + - AzureIntegrationConfig + required: + - kind + pim.v2.AwsIntegrationConfig: + type: object + description: | + config schema for AWS cloud service provider. + properties: + iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud uses to assume + customer IAM role when it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + external_id: + type: string + format: uuid + description: | + Unique external ID that Confluent Cloud uses when it assumes the IAM role + in your Amazon Web Services (AWS) account. + readOnly: true + customer_iam_role_arn: + type: string + description: | + Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) + Identity and Access Management (IAM) role that Confluent Cloud assumes when + it accesses resources in your AWS account. + example: arn:aws:iam::000000000000:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + kind: + type: string + description: Cloud provider specific config to which access is provided through provider integration. + example: AwsIntegrationConfig + x-extensible-enum: + - AwsIntegrationConfig + required: + - kind + ObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + api_version: + type: string + description: API group and version of the referred resource + minLength: 1 + readOnly: true + kind: + type: string + description: Kind of the referred resource + minLength: 1 + readOnly: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/quotas.yaml b/provider-dev/source/quotas.yaml new file mode 100644 index 0000000..01d1d3b --- /dev/null +++ b/provider-dev/source/quotas.yaml @@ -0,0 +1,3598 @@ +openapi: 3.0.0 +info: + title: quotas API + description: confluent quotas API + version: 1.0.0 +paths: + /service-quota/v1/applied-quotas: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listServiceQuotaV1AppliedQuotas + summary: List of Applied Quotas + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all applied quotas. + + Shows all quotas for a given scope. + parameters: + - name: scope + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: ORGANIZATION + description: | + The applied scope the quota belongs to. + - name: environment + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: | + The environment ID the quota is associated with. + - name: network + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: n-12034 + description: | + The network ID the quota is associated with. + - name: kafka_cluster + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: | + The kafka cluster ID the quota is associated with. + - name: id + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: iam.max_environments.per_org + description: | + The id (quota code) that this quota belongs to. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 200 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Applied Quotas (service-quota/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Applied Quota. + content: + application/json: + schema: + type: object + description: |- + A `quota` object represents a quota configuration for a specific Confluent Cloud resource. + Use this API to retrieve an individual quota or list of quotas for a given scope. + + + Related guide: [Service Quotas for Confluent Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). + + ## The Applied Quotas Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AppliedQuotaList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + A `quota` object represents a quota configuration for a specific Confluent Cloud resource. + Use this API to retrieve an individual quota or list of quotas for a given scope. + + + Related guide: [Service Quotas for Confluent Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). + + ## The Applied Quotas Model + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AppliedQuota + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + scope: + type: string + description: The applied scope that this quota belongs to. + example: ORGANIZATION + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - NETWORK + - KAFKA_CLUSTER + - SERVICE_ACCOUNT + - USER_ACCOUNT + display_name: + type: string + example: Kafka Cluster Per Organization + description: A human-readable name for the quota type name. + x-immutable: true + default_limit: + type: integer + format: int32 + description: | + The default service quota value. + applied_limit: + type: integer + format: int32 + description: | + The latest applied service quota value, taking into account any limit adjustments. + usage: + type: integer + description: | + Show the quota usage value if the quota usage is available for this quota. + format: int32 + user: + description: The user associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + organization: + nullable: true + description: A unique organization id to associate a specific organization to this quota. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + environment: + nullable: true + description: | + The environment ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + nullable: true + description: | + The network ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + nullable: true + description: | + The kafka cluster ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - scope + - display_name + - default_limit + - applied_limit + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /service-quota/v1/applied-quotas/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getServiceQuotaV1AppliedQuota + summary: Read an Applied Quota + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read an applied quota. + parameters: + - name: environment + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: | + The environment ID the quota is associated with. + This field is only required when retrieving a single quota and + the scope of quota is "ENVIRONMENT" or "NETWORK" or "KAFKA_CLUSTER". + - name: network + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: n-12034 + description: | + The network ID the quota is associated with. + This field is only required when retrieving a single quota and + the scope of quota is "NETWORK". + - name: kafka_cluster + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: | + The kafka cluster ID the quota is associated with. + This field is required only when the scope of quota is "KAFKA_CLUSTER". + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the applied quota. + tags: + - Applied Quotas (service-quota/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Applied Quota. + content: + application/json: + schema: + type: object + description: |- + A `quota` object represents a quota configuration for a specific Confluent Cloud resource. + Use this API to retrieve an individual quota or list of quotas for a given scope. + + + Related guide: [Service Quotas for Confluent Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). + + ## The Applied Quotas Model + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AppliedQuota + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + scope: + type: string + description: The applied scope that this quota belongs to. + example: ORGANIZATION + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - NETWORK + - KAFKA_CLUSTER + - SERVICE_ACCOUNT + - USER_ACCOUNT + display_name: + type: string + example: Kafka Cluster Per Organization + description: A human-readable name for the quota type name. + x-immutable: true + default_limit: + type: integer + format: int32 + description: | + The default service quota value. + applied_limit: + type: integer + format: int32 + description: | + The latest applied service quota value, taking into account any limit adjustments. + usage: + type: integer + description: | + Show the quota usage value if the quota usage is available for this quota. + format: int32 + user: + description: The user associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + organization: + nullable: true + description: A unique organization id to associate a specific organization to this quota. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + environment: + nullable: true + description: | + The environment ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + nullable: true + description: | + The network ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + nullable: true + description: | + The kafka cluster ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - scope + - display_name + - default_limit + - applied_limit + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /service-quota/v1/scopes: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listServiceQuotaV1Scopes + summary: List of Scopes + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all scopes. + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 200 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Scopes (service-quota/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Scope. + content: + application/json: + schema: + type: object + description: |- + Gets a list of all available scopes for applied quotas. + + + Related guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). + + ## The Scopes Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ScopeList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + Gets a list of all available scopes for applied quotas. + + + Related guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). + + ## The Scopes Model + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Scope + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + description: + type: string + description: the quota scope for listing quotas queries + example: ORGANIZATION scope that quotas would be applied to + required: + - id + - metadata + - description + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /service-quota/v1/scopes/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getServiceQuotaV1Scope + summary: Read a Scope + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a scope. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the scope. + tags: + - Scopes (service-quota/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Scope. + content: + application/json: + schema: + type: object + description: |- + Gets a list of all available scopes for applied quotas. + + + Related guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). + + ## The Scopes Model + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Scope + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + description: + type: string + description: the quota scope for listing quotas queries + example: ORGANIZATION scope that quotas would be applied to + required: + - api_version + - kind + - id + - description + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /kafka-quotas/v1/client-quotas: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listKafkaQuotasV1ClientQuotas + summary: List of Client Quotas + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all client quotas. + parameters: + - name: spec.cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-xxxxx + description: Filter the results by exact match for spec.cluster. + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-xxxxx + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Client Quotas (kafka-quotas/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Client Quota. + content: + application/json: + schema: + type: object + description: |- + `ClientQuota` objects represent Client Quotas you can set at the service account level. + + The API allows you to list, create, read, update, and delete your client quotas. + + + Related guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + ## The Client Quotas Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuotaList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ClientQuota` objects represent Client Quotas you can set at the service account level. + + The API allows you to list, create, read, update, and delete your client quotas. + + + Related guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + ## The Client Quotas Model + + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuota + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaSpec' + required: + - id + - metadata + - spec + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + requestBody: + required: true + content: + application/json: + schema: + example: + spec: + display_name: QuotaForSA1 + description: This quota defines limits on how much the target principals can use cluster lkc-xxxxx + throughput: + ingress_byte_rate: '5' + egress_byte_rate: '5' + cluster: + id: lkc-xxxxx + principals: + - id: sa-xxxxx + environment: + id: env-xxxxx + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createKafkaQuotasV1ClientQuota + summary: Create a Client Quota + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a client quota. + tags: + - Client Quotas (kafka-quotas/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '202': + description: A Client Quota is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/kafka-quotas/v1/client-quotas/{id} + description: ClientQuota resource uri + content: + application/json: + schema: + type: object + description: |- + `ClientQuota` objects represent Client Quotas you can set at the service account level. + + The API allows you to list, create, read, update, and delete your client quotas. + + + Related guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + ## The Client Quotas Model + + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuota + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaSpec' + required: + - spec + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /kafka-quotas/v1/client-quotas/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getKafkaQuotasV1ClientQuota + summary: Read a Client Quota + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a client quota. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the client quota. + tags: + - Client Quotas (kafka-quotas/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Client Quota. + content: + application/json: + schema: + type: object + description: |- + `ClientQuota` objects represent Client Quotas you can set at the service account level. + + The API allows you to list, create, read, update, and delete your client quotas. + + + Related guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + ## The Client Quotas Model + + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuota + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaSpec' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateKafkaQuotasV1ClientQuota + summary: Update a Client Quota + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a client quota. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the client quota. + tags: + - Client Quotas (kafka-quotas/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `ClientQuota` objects represent Client Quotas you can set at the service account level. + + The API allows you to list, create, read, update, and delete your client quotas. + + + Related guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + ## The Client Quotas Model + + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuota + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaSpec' + required: + - spec + responses: + '200': + description: Client Quota. + content: + application/json: + schema: + type: object + description: |- + `ClientQuota` objects represent Client Quotas you can set at the service account level. + + The API allows you to list, create, read, update, and delete your client quotas. + + + Related guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + ## The Client Quotas Model + + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuota + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaSpec' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteKafkaQuotasV1ClientQuota + summary: Delete a Client Quota + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a client quota. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the client quota. + tags: + - Client Quotas (kafka-quotas/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Client Quota is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + service-quota.v1.AppliedQuotaList: + type: object + description: |- + A `quota` object represents a quota configuration for a specific Confluent Cloud resource. + Use this API to retrieve an individual quota or list of quotas for a given scope. + + + Related guide: [Service Quotas for Confluent Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). + + ## The Applied Quotas Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AppliedQuotaList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + A `quota` object represents a quota configuration for a specific Confluent Cloud resource. + Use this API to retrieve an individual quota or list of quotas for a given scope. + + + Related guide: [Service Quotas for Confluent Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). + + ## The Applied Quotas Model + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AppliedQuota + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + scope: + type: string + description: The applied scope that this quota belongs to. + example: ORGANIZATION + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - NETWORK + - KAFKA_CLUSTER + - SERVICE_ACCOUNT + - USER_ACCOUNT + display_name: + type: string + example: Kafka Cluster Per Organization + description: A human-readable name for the quota type name. + x-immutable: true + default_limit: + type: integer + format: int32 + description: | + The default service quota value. + applied_limit: + type: integer + format: int32 + description: | + The latest applied service quota value, taking into account any limit adjustments. + usage: + type: integer + description: | + Show the quota usage value if the quota usage is available for this quota. + format: int32 + user: + description: The user associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + organization: + nullable: true + description: A unique organization id to associate a specific organization to this quota. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + environment: + nullable: true + description: | + The environment ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + nullable: true + description: | + The network ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + nullable: true + description: | + The kafka cluster ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - scope + - display_name + - default_limit + - applied_limit + uniqueItems: true + service-quota.v1.AppliedQuota: + type: object + description: |- + A `quota` object represents a quota configuration for a specific Confluent Cloud resource. + Use this API to retrieve an individual quota or list of quotas for a given scope. + + + Related guide: [Service Quotas for Confluent Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). + + ## The Applied Quotas Model + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - AppliedQuota + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + scope: + type: string + description: The applied scope that this quota belongs to. + example: ORGANIZATION + x-extensible-enum: + - ORGANIZATION + - ENVIRONMENT + - NETWORK + - KAFKA_CLUSTER + - SERVICE_ACCOUNT + - USER_ACCOUNT + display_name: + type: string + example: Kafka Cluster Per Organization + description: A human-readable name for the quota type name. + x-immutable: true + default_limit: + type: integer + format: int32 + description: | + The default service quota value. + applied_limit: + type: integer + format: int32 + description: | + The latest applied service quota value, taking into account any limit adjustments. + usage: + type: integer + description: | + Show the quota usage value if the quota usage is available for this quota. + format: int32 + user: + description: The user associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + organization: + nullable: true + description: A unique organization id to associate a specific organization to this quota. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + environment: + nullable: true + description: | + The environment ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + network: + nullable: true + description: | + The network ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + nullable: true + description: | + The kafka cluster ID the quota is associated with. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + service-quota.v1.ScopeList: + type: object + description: |- + Gets a list of all available scopes for applied quotas. + + + Related guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). + + ## The Scopes Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ScopeList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + Gets a list of all available scopes for applied quotas. + + + Related guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). + + ## The Scopes Model + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Scope + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + description: + type: string + description: the quota scope for listing quotas queries + example: ORGANIZATION scope that quotas would be applied to + required: + - id + - metadata + - description + uniqueItems: true + service-quota.v1.Scope: + type: object + description: |- + Gets a list of all available scopes for applied quotas. + + + Related guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). + + ## The Scopes Model + + properties: + api_version: + type: string + enum: + - service-quota/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Scope + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + description: + type: string + description: the quota scope for listing quotas queries + example: ORGANIZATION scope that quotas would be applied to + kafka-quotas.v1.ClientQuotaList: + type: object + description: |- + `ClientQuota` objects represent Client Quotas you can set at the service account level. + + The API allows you to list, create, read, update, and delete your client quotas. + + + Related guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + ## The Client Quotas Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuotaList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ClientQuota` objects represent Client Quotas you can set at the service account level. + + The API allows you to list, create, read, update, and delete your client quotas. + + + Related guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + ## The Client Quotas Model + + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuota + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaSpec' + required: + - id + - metadata + - spec + uniqueItems: true + kafka-quotas.v1.ClientQuota: + type: object + description: |- + `ClientQuota` objects represent Client Quotas you can set at the service account level. + + The API allows you to list, create, read, update, and delete your client quotas. + + + Related guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). + + ## The Client Quotas Model + + properties: + api_version: + type: string + enum: + - kafka-quotas/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClientQuota + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/kafka-quotas.v1.ClientQuotaSpec' + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + GlobalObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + EnvScopedObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka-quotas.v1.ClientQuotaSpec: + type: object + description: The desired state of the Client Quota + properties: + display_name: + type: string + description: The name of the client quota. + example: QuotaForSA1 + description: + type: string + example: This quota defines limits on how much the target principals can use cluster lkc-xxxxx + description: A human readable description for the client quota. + throughput: + type: object + description: Throughput for the client quota. + required: + - ingress_byte_rate + - egress_byte_rate + properties: + ingress_byte_rate: + type: string + format: int64 + example: '5' + description: Ingress throughput limit for principals specified in bytes per second. + egress_byte_rate: + type: string + format: int64 + example: '5' + description: Egress throughput limit for principals specified in bytes per second. + cluster: + description: | + The ID of the Dedicated Kafka cluster where the client quota is applied. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + principals: + type: array + items: + $ref: '#/components/schemas/GlobalObjectReference' + description: | + A list of principals to apply a client quota to. + Use `""` to apply a client quota to all service accounts + (see [Control application usage with Client Quotas](https://docs.confluent.io/cloud/current/clusters/client-quotas.html#control-application-usage-with-client-quotas) for more details). + minItems: 1 + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + kafka-quotas.v1.Throughput: + description: Quotas on maximum throughput + required: + - ingress_byte_rate + - egress_byte_rate + properties: + ingress_byte_rate: + type: string + format: int64 + example: '5' + description: Ingress throughput limit for principals specified in bytes per second. + egress_byte_rate: + type: string + format: int64 + example: '5' + description: Egress throughput limit for principals specified in bytes per second. + type: object + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/schema_registry.yaml b/provider-dev/source/schema_registry.yaml new file mode 100644 index 0000000..b3f3b85 --- /dev/null +++ b/provider-dev/source/schema_registry.yaml @@ -0,0 +1,3636 @@ +openapi: 3.0.0 +info: + title: schema_registry API + description: confluent schema_registry API + version: 1.0.0 +paths: + /clusterconfig: + get: + tags: + - Config (v1) + summary: Get cluster config + description: Retrieves cluster config information. + operationId: getClusterConfig + responses: + '200': + description: The cluster config + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ClusterConfig' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ClusterConfig' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ClusterConfig' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /compatibility/subjects/{subject}/versions/{version}: + post: + tags: + - Compatibility (v1) + summary: Test schema compatibility against a particular schema subject-version + description: 'Test input schema against a particular version of a subject''s schema for compatibility. The compatibility level applied for the check is the configured compatibility level for the subject (http:get:: /config/(string: subject)). If this subject''s compatibility level was never changed, then the global compatibility level applies (http:get:: /config).' + operationId: testCompatibilityBySubjectName + parameters: + - name: subject + in: path + description: Subject of the schema version against which compatibility is to be tested + required: true + schema: + type: string + - name: version + in: path + description: Version of the subject's schema against which compatibility is to be tested. Valid values for versionId are between [1,2^31-1] or the string "latest"."latest" checks compatibility of the input schema with the last registered schema under the specified subject + required: true + schema: + type: string + - name: normalize + in: query + description: Whether to normalize the given schema + schema: + type: boolean + - name: verbose + in: query + description: Whether to return detailed error messages + schema: + type: boolean + requestBody: + description: Schema + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + required: true + responses: + '200': + description: Compatibility check result. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. Error code 40402 indicates version not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: Unprocessable entity. Error code 42201 indicates an invalid schema or schema type. Error code 42202 indicates an invalid version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /compatibility/subjects/{subject}/versions: + post: + tags: + - Compatibility (v1) + summary: Test schema compatibility against all schemas under a subject + description: 'Test input schema against a subject''s schemas for compatibility, based on the configured compatibility level of the subject. In other words, it will perform the same compatibility check as register for that subject. The compatibility level applied for the check is the configured compatibility level for the subject (http:get:: /config/(string: subject)). If this subject''s compatibility level was never changed, then the global compatibility level applies (http:get:: /config).' + operationId: testCompatibilityForSubject + parameters: + - name: subject + in: path + description: Subject of the schema version against which compatibility is to be tested + required: true + schema: + type: string + - name: verbose + in: query + description: Whether to return detailed error messages + schema: + type: boolean + requestBody: + description: Schema + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + required: true + responses: + '200': + description: Compatibility check result. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/CompatibilityCheckResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '422': + description: Unprocessable Entity. Error code 42201 indicates an invalid schema or schema type. Error code 42202 indicates an invalid version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /config/{subject}: + get: + tags: + - Config (v1) + summary: Get subject compatibility level + description: |- + Retrieves compatibility level, compatibility group, normalization, + default metadata, and rule set for a subject. + operationId: getSubjectLevelConfig + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: defaultToGlobal + in: query + description: Whether to return the global compatibility level if subject compatibility level not found + schema: + type: boolean + responses: + '200': + description: The subject compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Config' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Config' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Config' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Config (v1) + summary: Update subject compatibility level + description: |- + Update compatibility level, compatibility group, normalization, + default metadata, and rule set for the specified subject. On success, + echoes the original request back to the client. + operationId: updateSubjectLevelConfig + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + requestBody: + description: Config Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '422': + description: Unprocessable Entity. Error code 42203 indicates invalid compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. Error code 50003 indicates a failure forwarding the request to the primary. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Config (v1) + summary: Delete subject compatibility level + description: Deletes the specified subject-level compatibility level config and reverts to the global default. + operationId: deleteSubjectConfig + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + responses: + '200': + description: Operation succeeded. Returns old compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + application/json; qs=0.5: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /config: + get: + tags: + - Config (v1) + summary: Get global compatibility level + description: |- + Retrieves the global compatibility level, compatibility group, + normalization, default metadata, and rule set. + operationId: getTopLevelConfig + responses: + '200': + description: The global compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Config' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Config' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Config' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Config (v1) + summary: Update global compatibility level + description: |- + Updates the global compatibility level, compatibility group, + schema normalization, default metadata, and rule set. On success, echoes the + original request back to the client. + operationId: updateTopLevelConfig + requestBody: + description: Config Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ConfigUpdateRequest' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '422': + description: Unprocessable Entity. Error code 42203 indicates invalid compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. Error code 50003 indicates a failure forwarding the request to the primary. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Config (v1) + summary: Delete global compatibility level + description: Deletes the global compatibility level config and reverts to the default. + operationId: deleteTopLevelConfig + responses: + '200': + description: Operation succeeded. Returns old global compatibility level. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + application/json; qs=0.5: + schema: + type: string + x-extensible-enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + example: FULL_TRANSITIVE + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /exporters: + get: + tags: + - Exporters (v1) + summary: Gets all schema exporters + description: Retrieves a list of schema exporters that have been created. + operationId: listExporters + responses: + '200': + description: Name of the exporter + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: string + example: '["exporter1", "exporter2"]' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + post: + tags: + - Exporters (v1) + summary: Creates a new schema exporter + description: Creates a new schema exporter. All attributes in request body are optional except config. + operationId: registerExporter + requestBody: + description: Schema + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterReference' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ExporterReference' + application/json: + schema: + $ref: '#/components/schemas/ExporterReference' + required: true + responses: + '200': + description: Schema successfully registered. + content: + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ExporterResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '409': + description: Conflict. Error code 40950 – Missing or invalid exporter name \ Error code 40951 – Missing or invalid exporter config \ Error code 40952 – Invalid exporter subjects \ Error code 40960 – Exporter already exists \ Error code 40964 – Too many exporters + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /exporters/{name}: + get: + tags: + - Exporters (v1) + summary: Gets schema exporter by name + description: Retrieves the information of the schema exporter. + operationId: getExporterInfoByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterReference' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40450 – Exporter not found + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Exporters (v1) + summary: Update schema exporter by name + description: Updates the information or configurations of the schema exporter. All attributes in request body are optional. + operationId: updateExporterInfo + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + requestBody: + description: Exporter Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterUpdateRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ExporterUpdateRequest' + application/json: + schema: + $ref: '#/components/schemas/ExporterUpdateRequest' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '409': + description: Invalid. Error code 40952 – Invalid exporter subjects. Error code 40963 – Exporter not paused. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Exporters (v1) + summary: Delete schema exporter by name + description: Deletes the schema exporter. + operationId: deleteExporter + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '204': + description: No content. + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + $ref: '#/components/responses/schemaregistry.v1.AccountNotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /exporters/{name}/status: + get: + tags: + - Exporters (v1) + summary: Gets schema exporter status by name + description: Retrieves the status of the schema exporter. + operationId: getExporterStatusByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterStatusResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40450 – Exporter not found + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /exporters/{name}/config: + get: + tags: + - Exporters (v1) + summary: Gets schema exporter config by name + description: Retrieves the config of the schema exporter. + operationId: getExporterConfigByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterConfigResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40450 – Exporter not found + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Exporters (v1) + summary: Update schema exporter config by name + description: Updates the configuration of the schema exporter. + operationId: updateExporterConfigByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + requestBody: + description: Exporter Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterConfigResponse' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ExporterConfigResponse' + application/json: + schema: + $ref: '#/components/schemas/ExporterConfigResponse' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '409': + description: Invalid. Error code 40952 – Invalid exporter subjects. Error code 40963 – Exporter not paused. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /exporters/{name}/pause: + put: + tags: + - Exporters (v1) + summary: Pause schema exporter by name + description: Pauses the state of the schema exporter. + operationId: pauseExporterByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '409': + description: Invalid. Error code 40952 – Invalid exporter subjects. Error code 40963 – Exporter not paused. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /exporters/{name}/reset: + put: + tags: + - Exporters (v1) + summary: Reset schema exporter by name + description: Reset the state of the schema exporter. + operationId: resetExporterByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40450 – Exporter not found + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '409': + description: Invalid. Error code 40963 – Exporter not paused. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /exporters/{name}/resume: + put: + tags: + - Exporters (v1) + summary: Resume schema exporter by name + description: Resume running of the schema exporter. + operationId: resumeExporterByName + parameters: + - name: name + in: path + description: Name of the exporter + required: true + schema: + type: string + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ExporterResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40450 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '409': + description: Invalid. Error code 40961 – Exporter already running. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /contexts: + get: + tags: + - Contexts (v1) + summary: List contexts + description: Retrieves a list of contexts. + operationId: listContexts + parameters: + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: The contexts. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: string + example: . + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: string + example: . + application/json; qs=0.5: + schema: + type: array + items: + type: string + example: . + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: 'Internal Server Error. Error code 50001 indicates a failure in the backend data store. ' + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /mode/{subject}: + get: + tags: + - Modes (v1) + summary: Get subject mode + description: Retrieves the subject mode. + operationId: getMode + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: defaultToGlobal + in: query + description: Whether to return the global mode if subject mode not found + schema: + type: boolean + responses: + '200': + description: The subject mode. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Mode' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Mode' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Mode' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Modes (v1) + summary: Update subject mode + description: Update mode for the specified subject. On success, echoes the original request back to the client. + operationId: updateMode + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: force + in: query + description: Whether to force update if setting mode to IMPORT and schemas currently exist + schema: + type: boolean + requestBody: + description: Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '422': + description: Unprocessable Entity. Error code 42204 indicates an invalid mode. Error code 42205 indicates operation not permitted. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. Error code 50003 indicates a failure forwarding the request to the primary. Error code 50004 indicates unknown leader. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Modes (v1) + summary: Delete subject mode + description: Deletes the specified subject-level mode and reverts to the global default. + operationId: deleteSubjectMode + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + responses: + '200': + description: Operation succeeded. Returns old mode. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Mode' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Mode' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Mode' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /mode: + get: + tags: + - Modes (v1) + summary: Get global mode + description: Retrieves global mode. + operationId: getTopLevelMode + responses: + '200': + description: The global mode + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Mode' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Mode' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Mode' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Error code 50001 -- Error in the backend data store + security: + - resource-api-key: [] + - external-access-token: [] + put: + tags: + - Modes (v1) + summary: Update global mode + description: Update global mode. On success, echoes the original request back to the client. + operationId: updateTopLevelMode + parameters: + - name: force + in: query + description: Whether to force update if setting mode to IMPORT and schemas currently exist + schema: + type: boolean + requestBody: + description: Update Request + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + required: true + responses: + '200': + description: The original request. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ModeUpdateRequest' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '422': + description: Unprocessable Entity. Error code 42204 indicates an invalid mode. Error code 42205 indicates operation not permitted. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. Error code 50003 indicates a failure forwarding the request to the primary. Error code 50004 indicates unknown leader. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /schemas/ids/{id}: + get: + tags: + - Schemas (v1) + summary: Get schema string by ID + description: Retrieves the schema string identified by the input ID. + operationId: getSchema + parameters: + - name: id + in: path + description: Globally unique identifier of the schema + required: true + schema: + type: integer + format: int32 + - name: subject + in: query + description: Name of the subject + schema: + type: string + - name: format + in: query + description: 'Desired output format, dependent on schema type. For AVRO schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, valid values are: " " (default), "ignore_extensions", or "serialized" (The parameter does not apply to JSON schemas.)' + schema: + type: string + default: '' + responses: + '200': + description: The schema string. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/SchemaString' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/SchemaString' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/SchemaString' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40403 indicates schema not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /schemas/ids/{id}/schema: + get: + tags: + - Schemas (v1) + summary: Get schema by ID + description: Retrieves the schema identified by the input ID. + operationId: getSchemaOnly + parameters: + - name: id + in: path + description: Globally unique identifier of the schema + required: true + schema: + type: integer + format: int32 + - name: subject + in: query + description: Name of the subject + schema: + type: string + - name: format + in: query + description: 'Desired output format, dependent on schema type. For AVRO schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, valid values are: " " (default), "ignore_extensions", or "serialized" (The parameter does not apply to JSON schemas.)' + schema: + type: string + default: '' + responses: + '200': + description: Raw schema string. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + application/json; qs=0.5: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40403 indicates schema not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /schemas/types: + get: + tags: + - Schemas (v1) + summary: List supported schema types + description: Retrieve the schema types supported by this registry. + operationId: getSchemaTypes + responses: + '200': + description: List of supported schema types. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: string + example: AVRO + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: string + example: AVRO + application/json; qs=0.5: + schema: + type: array + items: + type: string + example: AVRO + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /schemas: + get: + tags: + - Schemas (v1) + summary: List schemas + description: Get the schemas matching the specified parameters. + operationId: getSchemas + parameters: + - name: subjectPrefix + in: query + description: Filters results by the respective subject prefix + schema: + type: string + default: '' + - name: aliases + in: query + description: Whether to include aliases in the search + schema: + type: boolean + default: false + - name: deleted + in: query + description: Whether to return soft deleted schemas + schema: + type: boolean + default: false + - name: latestOnly + in: query + description: Whether to return latest schema versions only for each matching subject + schema: + type: boolean + default: false + - name: ruleType + in: query + description: Filters results by the given rule type + schema: + type: string + default: '' + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of schemas matching the specified parameters. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + $ref: '#/components/schemas/Schema' + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + $ref: '#/components/schemas/Schema' + application/json; qs=0.5: + schema: + type: array + items: + $ref: '#/components/schemas/Schema' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /schemas/ids/{id}/subjects: + get: + tags: + - Schemas (v1) + summary: List subjects associated to schema ID + description: Retrieves all the subjects associated with a particular schema ID. + operationId: getSubjects + parameters: + - name: id + in: path + description: Globally unique identifier of the schema + required: true + schema: + type: integer + format: int32 + - name: subject + in: query + description: Filters results by the respective subject + schema: + type: string + - name: format + in: query + description: 'Desired output format, dependent on schema type. For AVRO schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, valid values are: " " (default), "ignore_extensions", or "serialized" (The parameter does not apply to JSON schemas.)' + schema: + type: string + default: '' + - name: deleted + in: query + description: Whether to include subjects where the schema was deleted + schema: + type: boolean + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of subjects matching the specified parameters. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: string + example: User + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: string + example: User + application/json; qs=0.5: + schema: + type: array + items: + type: string + example: User + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40403 indicates schema not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /schemas/ids/{id}/versions: + get: + tags: + - Schemas (v1) + summary: List subject-versions associated to schema ID + description: Get all the subject-version pairs associated with the input ID. + operationId: getVersions + parameters: + - name: id + in: path + description: Globally unique identifier of the schema + required: true + schema: + type: integer + format: int32 + - name: subject + in: query + description: Filters results by the respective subject + schema: + type: string + - name: deleted + in: query + description: Whether to include subject versions where the schema was deleted + schema: + type: boolean + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of subject versions matching the specified parameters. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + $ref: '#/components/schemas/SubjectVersion' + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + $ref: '#/components/schemas/SubjectVersion' + application/json; qs=0.5: + schema: + type: array + items: + $ref: '#/components/schemas/SubjectVersion' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40403 indicates schema not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /subjects/{subject}/versions/{version}: + get: + tags: + - Subjects (v1) + summary: Get schema by version + description: Retrieves a specific version of the schema registered under this subject. + operationId: getSchemaByVersion + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: version + in: path + description: Version of the schema to be returned. Valid values for versionId are between [1,2^31-1] or the string "latest". "latest" returns the last registered schema under the specified subject. Note that there may be a new latest schema that gets registered right after this request is served. + required: true + schema: + type: string + - name: format + in: query + description: 'Desired output format, dependent on schema type. For AVRO schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, valid values are: " " (default), "ignore_extensions", or "serialized" (The parameter does not apply to JSON schemas.)' + schema: + type: string + default: '' + - name: deleted + in: query + description: Whether to include deleted schema + schema: + type: boolean + responses: + '200': + description: The schema. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Schema' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Schema' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Schema' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. Error code 40402 indicates version not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: Unprocessable Entity. Error code 42202 indicates an invalid version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Subjects (v1) + summary: Delete schema version + description: Deletes a specific version of the schema registered under this subject. This only deletes the version and the schema ID remains intact making it still possible to decode data using the schema ID. This API is recommended to be used only in development environments or under extreme circumstances where-in, its required to delete a previously registered schema for compatibility purposes or re-register previously registered schema. + operationId: deleteSchemaVersion + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: version + in: path + description: Version of the schema to be returned. Valid values for versionId are between [1,2^31-1] or the string "latest". "latest" returns the last registered schema under the specified subject. Note that there may be a new latest schema that gets registered right after this request is served. + required: true + schema: + type: string + - name: permanent + in: query + description: Whether to perform a permanent delete + schema: + type: boolean + responses: + '200': + description: Operation succeeded. Returns the schema version. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: integer + format: int32 + example: 1 + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: integer + format: int32 + example: 1 + application/json; qs=0.5: + schema: + type: integer + format: int32 + example: 1 + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. Error code 40402 indicates version not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: Unprocessable Entity. Error code 42202 indicates an invalid version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /subjects/{subject}/versions/{version}/referencedby: + get: + tags: + - Subjects (v1) + summary: List schemas referencing a schema + description: Retrieves the IDs of schemas that reference the specified schema. + operationId: getReferencedBy + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: version + in: path + description: Version of the schema to be returned. Valid values for versionId are between [1,2^31-1] or the string "latest". "latest" returns the last registered schema under the specified subject. Note that there may be a new latest schema that gets registered right after this request is served. + required: true + schema: + type: string + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of IDs for schemas that reference the specified schema. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: integer + format: int32 + example: 100001 + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: integer + format: int32 + example: 100001 + application/json; qs=0.5: + schema: + type: array + items: + type: integer + format: int32 + example: 100001 + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. Error code 40402 indicates version not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: Unprocessable Entity. Error code 42202 indicates an invalid version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /subjects/{subject}/versions/{version}/schema: + get: + tags: + - Subjects (v1) + summary: Get schema string by version + description: Retrieves the schema for the specified version of this subject. Only the unescaped schema string is returned. + operationId: getSchemaOnly_1 + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: version + in: path + description: Version of the schema to be returned. Valid values for versionId are between [1,2^31-1] or the string "latest". "latest" returns the last registered schema under the specified subject. Note that there may be a new latest schema that gets registered right after this request is served. + required: true + schema: + type: string + - name: deleted + in: query + description: Whether to include deleted schema + schema: + type: boolean + responses: + '200': + description: The schema string. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + application/json; qs=0.5: + schema: + type: string + example: '{"schema": "{"type": "string"}"}' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. Error code 40402 indicates version not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: Unprocessable Entity. Error code 42202 indicates an invalid version. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /subjects/{subject}/versions: + get: + tags: + - Subjects (v1) + summary: List versions under subject + description: Retrieves a list of versions registered under the specified subject. + operationId: listVersions + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: deleted + in: query + description: Whether to include deleted schemas + schema: + type: boolean + - name: deletedOnly + in: query + description: Whether to return deleted schemas only + schema: + type: boolean + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of version numbers matching the specified parameters. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + application/json; qs=0.5: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: 'Not Found. Error code 40401 indicates subject not found. ' + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + post: + tags: + - Subjects (v1) + summary: Register schema under a subject + description: |- + Register a new schema under the specified subject. If successfully registered, this returns the unique identifier of this schema in the registry. The returned identifier should be used to retrieve this schema from the schemas resource and is different from the schema's version which is associated with the subject. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects. + A schema should be compatible with the previously registered schema or schemas (if there are any) as per the configured compatibility level. The configured compatibility level can be obtained by issuing a GET http:get:: /config/(string: subject). If that returns null, then GET http:get:: /config + When there are multiple instances of Schema Registry running in the same cluster, the schema registration request will be forwarded to one of the instances designated as the primary. If the primary is not available, the client will get an error code indicating that the forwarding has failed. + operationId: register + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: normalize + in: query + description: Whether to register the normalized schema + schema: + type: boolean + - name: format + in: query + description: 'Desired output format, dependent on schema type. For AVRO schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, valid values are: " " (default), "ignore_extensions", or "serialized" (The parameter does not apply to JSON schemas.)' + schema: + type: string + default: '' + requestBody: + description: Schema + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + required: true + responses: + '200': + description: Schema successfully registered. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/RegisterSchemaResponse' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/RegisterSchemaResponse' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/RegisterSchemaResponse' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '409': + description: Conflict. Incompatible schema. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '422': + description: 'Unprocessable entity. Error code 42201 indicates an invalid schema or schema type. ' + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. Error code 50002 indicates operation timed out. Error code 50003 indicates a failure forwarding the request to the primary. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /subjects/{subject}: + post: + tags: + - Subjects (v1) + summary: Lookup schema under subject + description: Check if a schema has already been registered under the specified subject. If so, this returns the schema string along with its globally unique identifier, its version under this subject and the subject name. + operationId: lookUpSchemaUnderSubject + parameters: + - name: subject + in: path + description: Subject under which the schema will be registered + required: true + schema: + type: string + - name: normalize + in: query + description: Whether to lookup the normalized schema + schema: + type: boolean + - name: format + in: query + description: 'Desired output format, dependent on schema type. For AVRO schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, valid values are: " " (default), "ignore_extensions", or "serialized" (The parameter does not apply to JSON schemas.)' + schema: + type: string + default: '' + - name: deleted + in: query + description: Whether to lookup deleted schemas + schema: + type: boolean + requestBody: + description: Schema + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/vnd.schemaregistry+json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/json: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + application/octet-stream: + schema: + $ref: '#/components/schemas/RegisterSchemaRequest' + required: true + responses: + '200': + description: The schema. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Schema' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Schema' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Schema' + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. Error code 40403 indicates schema not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + delete: + tags: + - Subjects (v1) + summary: Delete subject + description: Deletes the specified subject and its associated compatibility level if registered. It is recommended to use this API only when a topic needs to be recycled or in development environment. + operationId: deleteSubject + parameters: + - name: subject + in: path + description: Name of the subject + required: true + schema: + type: string + - name: permanent + in: query + description: Whether to perform a permanent delete + schema: + type: boolean + responses: + '200': + description: Operation succeeded. Returns list of schema versions deleted + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + application/json; qs=0.5: + schema: + type: array + items: + type: integer + format: int32 + example: 1 + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '404': + description: Not Found. Error code 40401 indicates subject not found. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /subjects: + get: + tags: + - Subjects (v1) + summary: List subjects + description: Retrieves a list of registered subjects matching specified parameters. + operationId: list + parameters: + - name: subjectPrefix + in: query + description: Subject name prefix + schema: + type: string + default: ':*:' + - name: deleted + in: query + description: Whether to look up deleted subjects + schema: + type: boolean + - name: deletedOnly + in: query + description: Whether to return deleted subjects only + schema: + type: boolean + - name: offset + in: query + description: Pagination offset for results + schema: + type: integer + format: int32 + default: 0 + - name: limit + in: query + description: Pagination size for results. Ignored if negative + schema: + type: integer + format: int32 + default: -1 + responses: + '200': + description: List of subjects matching the specified parameters. + content: + application/vnd.schemaregistry.v1+json: + schema: + type: array + items: + type: string + example: User + application/vnd.schemaregistry+json; qs=0.9: + schema: + type: array + items: + type: string + example: User + application/json; qs=0.5: + schema: + type: array + items: + type: string + example: User + '400': + $ref: '#/components/responses/schemaregistry.v1.BadRequestError' + '401': + $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' + '403': + $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/ErrorMessage' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/ErrorMessage' + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. + /subjects/{subject}/metadata: + get: + tags: + - Subjects (v1) + summary: Retrieve the latest version with the given metadata. + description: Retrieve the latest version with the given metadata. + operationId: getLatestWithMetadata + parameters: + - name: subject + in: path + description: Subject under which the schema will be registered + required: true + schema: + type: string + - name: key + in: query + description: The metadata key. Add "?key=key" at the end of the request to match a metadata key. This query parameter can appear multiple times. Each instance is matched with a corresponding value query parameter, in order. + schema: + type: string + - name: value + in: query + description: The metadata value. Add "?value=value" at the end of the request to match a metadata value. This query parameter can appear multiple times. Each instance is matched with a corresponding key query parameter, in order. + schema: + type: string + - name: format + in: query + description: 'Desired output format, dependent on schema type. For AVRO schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, valid values are: " " (default), "ignore_extensions", or "serialized" (The parameter does not apply to JSON schemas.)' + schema: + type: string + default: '' + - name: deleted + in: query + description: Whether to lookup deleted schemas + schema: + type: boolean + responses: + '200': + description: The schema. + content: + application/vnd.schemaregistry.v1+json: + schema: + $ref: '#/components/schemas/Schema' + application/vnd.schemaregistry+json; qs=0.9: + schema: + $ref: '#/components/schemas/Schema' + application/json; qs=0.5: + schema: + $ref: '#/components/schemas/Schema' + '404': + description: |- + Error code 40401 -- Subject not found + Error code 40403 -- Schema not found + '500': + description: Internal Server Error. + security: + - resource-api-key: [] + - external-access-token: [] + servers: + - url: https://psrc-00000.region.provider.confluent.cloud + description: Confluent Cloud Schema Registry Endpoint. +components: + schemas: + ClusterConfig: + type: object + properties: + maxSchemas: + type: integer + description: Maximum number of registered schemas allowed + format: int32 + example: 20000 + maxRequestsPerSec: + type: integer + description: Maximum number of allowed requests per second + format: int32 + example: 25 + description: Cluster Config + RegisterSchemaRequest: + type: object + properties: + version: + type: integer + description: Version number + format: int32 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + schemaType: + type: string + description: Schema type + references: + type: array + description: References to other schemas + items: + $ref: '#/components/schemas/SchemaReference' + schema: + type: string + description: Schema definition string + metadata: + $ref: '#/components/schemas/Metadata' + ruleSet: + $ref: '#/components/schemas/RuleSet' + schemaTagsToAdd: + type: array + items: + $ref: '#/components/schemas/SchemaTags' + schemaTagsToRemove: + type: array + items: + $ref: '#/components/schemas/SchemaTags' + propagateSchemaTags: + type: boolean + description: Schema register request + CompatibilityCheckResponse: + type: object + properties: + is_compatible: + type: boolean + description: Whether the compared schemas are compatible + messages: + type: array + description: Error messages + example: [] + items: + type: string + description: Error messages + example: '[]' + description: Compatibility check response + ErrorMessage: + type: object + properties: + error_code: + type: integer + description: The error code + format: int32 + message: + type: string + description: The error message + description: Error message of this operation + Config: + type: object + properties: + alias: + type: string + description: |- + If alias is specified, then this subject is an alias for the subject + named by the alias. That means that any reference to this subject + will be replaced by the alias. + normalize: + type: boolean + description: |- + If true, then schemas are automatically normalized when registered or + when passed during lookups. This means that clients do not have to + pass the "normalize" query parameter to have normalization occur. + compatibilityLevel: + type: string + description: Compatibility Level + example: FULL_TRANSITIVE + x-extensible-enum: + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + - NONE + compatibilityGroup: + type: string + description: |- + Only schemas that belong to the same compatibility group will be + checked for compatibility. + defaultMetadata: + type: object + description: Default value for the metadata to be used during schema registration. + properties: + properties: + type: string + description: The metadata properties and their new values (opaque JSON object) + overrideMetadata: + type: object + description: Override value for the metadata to be used during schema registration. + properties: + properties: + type: string + description: The metadata properties and their new values (opaque JSON object) + defaultRuleSet: + type: object + description: Default value for the ruleSet to be used during schema registration. + properties: + properties: + type: string + description: The metadata properties and their new values (opaque JSON object) + overrideRuleSet: + type: object + description: Override value for the ruleSet to be used during schema registration. + properties: + properties: + type: string + description: The metadata properties and their new values (opaque JSON object) + description: Config + ConfigUpdateRequest: + type: object + properties: + alias: + type: string + description: |- + If alias is specified, then this subject is an alias for the subject + named by the alias. That means that any reference to this subject + will be replaced by the alias. + normalize: + type: boolean + description: |- + If true, then schemas are automatically normalized when registered + or when passed during lookups. This means that clients do not have + to pass the "normalize" query parameter to have normalization occur. + compatibility: + type: string + description: Compatibility Level + example: FULL_TRANSITIVE + x-extensible-enum: + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + - NONE + compatibilityGroup: + type: string + description: |- + Only schemas that belong to the same compatibility group will be + checked for compatibility. + defaultMetadata: + type: object + description: Default value for the metadata to be used during schema registration. + properties: + properties: + type: string + description: The metadata properties and their new values (opaque JSON object) + overrideMetadata: + type: object + description: Override value for the metadata to be used during schema registration. + properties: + properties: + type: string + description: The metadata properties and their new values (opaque JSON object) + defaultRuleSet: + type: object + description: Default value for the ruleSet to be used during schema registration. + properties: + properties: + type: string + description: The metadata properties and their new values (opaque JSON object) + overrideRuleSet: + type: object + description: Override value for the ruleSet to be used during schema registration. + properties: + properties: + type: string + description: The metadata properties and their new values (opaque JSON object) + description: Config update request + ExporterReference: + type: object + properties: + name: + type: string + description: Name of the exporter + example: test-exporter + contextType: + description: Context type of the exporter. One of CUSTOM, NONE or AUTO (default) + type: string + example: CUSTOM + x-extensible-enum: + - CUSTOM + - AUTO + - NONE + context: + type: string + description: Customized context of the exporter if contextType equals CUSTOM. + example: User + subjects: + type: array + description: Name of each exporter subject + items: + type: string + kekRenameFormat: + type: string + description: Format string for the KEK name in the destination cluster, which may contain ${kek} as a placeholder for the originating KEK name. For example, dc_${kek} for the KEK aws_key will map to the destination KEK name dc_aws_key. + subjectRenameFormat: + type: string + description: Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders. + config: + type: object + description: The map containing exporter's configurations + additionalProperties: + type: string + description: The format for a typical exporter object + ExporterResponse: + type: object + properties: + name: + type: string + description: Name of the exporter + example: test-exporter + description: Exporter register response + ExporterUpdateRequest: + type: object + properties: + contextType: + description: Context type of the exporter. One of CUSTOM, NONE or AUTO (default) + type: string + example: CUSTOM + x-extensible-enum: + - CUSTOM + - AUTO + - NONE + context: + type: string + description: Customized context of the exporter if contextType equals CUSTOM. + example: User + subjects: + type: array + description: Name of each exporter subject + items: + type: string + kekRenameFormat: + type: string + description: |- + Format string for the KEK name in the destination cluster, which may + contain ${kek} as a placeholder for the originating KEK name. For + example, dc_${kek} for the KEK aws_key will map to the destination + KEK name dc_aws_key. + subjectRenameFormat: + type: string + description: |- + Format string for the subject name in the destination cluster, which + may contain ${subject} as a placeholder for the originating subject + name. For example, dc_${subject} for the subject orders will map to + the destination subject name dc_orders. + config: + type: object + description: The map containing exporter's configurations + additionalProperties: + type: string + description: Exporter update request + ExporterStatusResponse: + type: object + properties: + name: + description: Name of exporter. + type: string + example: test-exporter + state: + type: string + description: State of the exporter. Could be STARTING, RUNNING or PAUSED + example: RUNNING + x-extensible-enum: + - STARTING + - RUNNING + - PAUSED + offset: + type: integer + description: Offset of the exporter + format: int64 + example: 100 + ts: + type: integer + description: Timestamp of the exporter + format: int64 + example: 1631206325 + trace: + description: Error trace of the exporter + type: string + example: '' + description: Exporter status get request + ExporterConfigResponse: + type: object + properties: + schema.registry.url: + description: Config SR URL + type: string + example: + basic.auth.credentials.source: + description: Config SR Auth + type: string + example: USER_INFO + basic.auth.user.info: + description: Config SR User Info + type: string + description: The map containing exporter's configurations + Mode: + type: object + properties: + mode: + type: string + description: Schema Registry operating mode + example: READWRITE + x-extensible-enum: + - READWRITE + - READONLY + - READONLY_OVERRIDE + - IMPORT + description: Schema Registry operating mode + ModeUpdateRequest: + type: object + properties: + mode: + type: string + description: Schema Registry operating mode + example: READWRITE + x-extensible-enum: + - READWRITE + - READONLY + - READONLY_OVERRIDE + - IMPORT + description: Mode update request + SchemaString: + type: object + properties: + schemaType: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema string identified by the ID + example: '{"schema": "{"type": "string"}"}' + references: + type: array + description: References to other schemas + items: + $ref: '#/components/schemas/SchemaReference' + metadata: + $ref: '#/components/schemas/Metadata' + ruleSet: + $ref: '#/components/schemas/RuleSet' + schemaTags: + type: array + description: Schema tags + items: + $ref: '#/components/schemas/SchemaTags' + maxId: + type: integer + description: Maximum ID + format: int32 + example: 1 + description: Schema definition + Schema: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schemaType: + type: string + description: Schema type + example: AVRO + references: + type: array + description: References to other schemas + items: + $ref: '#/components/schemas/SchemaReference' + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + metadata: + $ref: '#/components/schemas/Metadata' + ruleSet: + $ref: '#/components/schemas/RuleSet' + schemaTags: + type: array + description: Schema tags + items: + $ref: '#/components/schemas/SchemaTags' + description: Schema + SubjectVersion: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + description: Subject version pair + RegisterSchemaResponse: + type: object + properties: + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + description: Schema register response + SchemaReference: + type: object + properties: + name: + type: string + description: Reference name + example: io.confluent.kafka.example.User + subject: + type: string + description: Name of the referenced subject + example: User + version: + type: integer + description: Version number of the referenced subject + format: int32 + example: 1 + description: Schema reference + Metadata: + description: User-defined metadata + nullable: true + properties: + tags: + additionalProperties: + items: + type: string + type: array + uniqueItems: true + type: object + properties: + additionalProperties: + type: string + type: object + sensitive: + items: + type: string + type: array + uniqueItems: true + type: object + RuleSet: + description: Schema rule set + nullable: true + properties: + migrationRules: + items: + $ref: '#/components/schemas/Rule' + type: array + domainRules: + items: + $ref: '#/components/schemas/Rule' + type: array + type: object + SchemaTags: + type: object + properties: + schemaEntity: + $ref: '#/components/schemas/SchemaEntity' + tags: + type: array + items: + type: string + Rule: + description: Rule + properties: + name: + description: Rule name + type: string + doc: + description: Rule doc + type: string + kind: + description: Rule kind + enum: + - TRANSFORM + - CONDITION + type: string + mode: + description: Rule mode + enum: + - UPGRADE + - DOWNGRADE + - UPDOWN + - WRITE + - READ + - WRITEREAD + type: string + type: + description: Rule type + type: string + tags: + description: The tags to which this rule applies + items: + description: The tags to which this rule applies + type: string + type: array + uniqueItems: true + params: + additionalProperties: + description: Optional params for the rule + type: string + description: Optional params for the rule + type: object + expr: + description: Rule expression + type: string + onSuccess: + description: Rule action on success + type: string + onFailure: + description: Rule action on failure + type: string + disabled: + description: Whether the rule is disabled + type: boolean + type: object + SchemaEntity: + type: object + properties: + entityPath: + type: string + entityType: + type: string + enum: + - sr_record + - sr_field + responses: + schemaregistry.v1.BadRequestError: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 400 + message: Bad Request + schemaregistry.v1.UnauthorizedError: + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 401 + message: Unauthorized + schemaregistry.v1.ForbiddenError: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 403 + message: Forbidden + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + schemaregistry.v1.DefaultSystemError: + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 500 + message: Oops, something went wrong + schemaregistry.v1.AccountNotFoundError: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + error_code: 404 + message: account not found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/schema_registry_clusters.yaml b/provider-dev/source/schema_registry_clusters.yaml new file mode 100644 index 0000000..5648325 --- /dev/null +++ b/provider-dev/source/schema_registry_clusters.yaml @@ -0,0 +1,3170 @@ +openapi: 3.0.0 +info: + title: schema_registry_clusters API + description: confluent schema_registry_clusters API + version: 1.0.0 +paths: + /srcm/v2/regions: + get: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: listSrcmV2Regions + summary: List of Regions + description: |- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all regions. + parameters: + - name: spec.cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for spec.cloud. + - name: spec.region_name + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: us-east-2 + description: Filter the results by exact match for spec.region_name. + - name: spec.packages + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - ESSENTIALS + - ADVANCED + description: Filter the results by exact match for spec.packages. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Regions (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Region. + content: + application/json: + schema: + type: object + description: |- + `Region` objects represent cloud provider regions available when placing Schema Registry clusters. + The API allows you to list Schema Registry regions. + + + Related guides: + * [Confluent Cloud providers and region support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Regions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RegionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Region` objects represent cloud provider regions available when placing Schema Registry clusters. + The API allows you to list Schema Registry regions. + + + Related guides: + * [Confluent Cloud providers and region support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Regions Model + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.RegionSpec' + required: + - id + - metadata + - spec + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Deprecated + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + /srcm/v2/regions/{id}: + get: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: getSrcmV2Region + summary: Read a Region + description: |- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a region. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the region. + tags: + - Regions (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Region. + content: + application/json: + schema: + type: object + description: |- + `Region` objects represent cloud provider regions available when placing Schema Registry clusters. + The API allows you to list Schema Registry regions. + + + Related guides: + * [Confluent Cloud providers and region support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Regions Model + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.RegionSpec' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Deprecated + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + /srcm/v2/clusters: + get: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: listSrcmV2Clusters + summary: List of Clusters + description: |- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Clusters (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list, create, read, and delete your Schema Registry clusters. + + + Related guides: + * [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Clusters Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list, create, read, and delete your Schema Registry clusters. + + + Related guides: + * [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Clusters Model + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: createSrcmV2Cluster + summary: Create a Cluster + description: |- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a cluster. + tags: + - Clusters (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list, create, read, and delete your Schema Registry clusters. + + + Related guides: + * [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Clusters Model + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + required: + - spec + responses: + '202': + description: A Cluster is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/srcm/v2/clusters/{id} + description: Cluster resource uri + content: + application/json: + schema: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list, create, read, and delete your Schema Registry clusters. + + + Related guides: + * [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Clusters Model + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Deprecated + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + /srcm/v2/clusters/{id}: + get: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: getSrcmV2Cluster + summary: Read a Cluster + description: |- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list, create, read, and delete your Schema Registry clusters. + + + Related guides: + * [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Clusters Model + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: updateSrcmV2Cluster + summary: Update a Cluster + description: |+ + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a cluster. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list, create, read, and delete your Schema Registry clusters. + + + Related guides: + * [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Clusters Model + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + required: + - spec + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list, create, read, and delete your Schema Registry clusters. + + + Related guides: + * [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Clusters Model + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Deprecated + deprecated: true + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + operationId: deleteSrcmV2Cluster + summary: Delete a Cluster + description: |- + [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (srcm/v2) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Cluster is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Deprecated + x-deprecated-at: 20240801T00:00:00Z + x-sunset-at: 20250228T00:00:00Z + x-self-access: true + /srcm/v3/clusters: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listSrcmV3Clusters + summary: List of Clusters + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Clusters (srcm/v3) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list and read your Schema Registry clusters. + + + Related guide: [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + ## The Clusters Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - srcm/v3 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list and read your Schema Registry clusters. + + + Related guide: [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + ## The Clusters Model + + properties: + api_version: + type: string + enum: + - srcm/v3 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v3.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v3.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /srcm/v3/clusters/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getSrcmV3Cluster + summary: Read a Cluster + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the cluster. + tags: + - Clusters (srcm/v3) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Cluster. + content: + application/json: + schema: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list and read your Schema Registry clusters. + + + Related guide: [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + ## The Clusters Model + + properties: + api_version: + type: string + enum: + - srcm/v3 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v3.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v3.ClusterStatus' + required: + - api_version + - kind + - id + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + MultipleSearchFilter: + description: Filter a collection by a string search for one or more values + type: array + items: + type: string + srcm.v2.RegionList: + type: object + description: |- + `Region` objects represent cloud provider regions available when placing Schema Registry clusters. + The API allows you to list Schema Registry regions. + + + Related guides: + * [Confluent Cloud providers and region support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Regions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RegionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Region` objects represent cloud provider regions available when placing Schema Registry clusters. + The API allows you to list Schema Registry regions. + + + Related guides: + * [Confluent Cloud providers and region support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Regions Model + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.RegionSpec' + required: + - id + - metadata + - spec + uniqueItems: true + srcm.v2.Region: + type: object + description: |- + `Region` objects represent cloud provider regions available when placing Schema Registry clusters. + The API allows you to list Schema Registry regions. + + + Related guides: + * [Confluent Cloud providers and region support](https://docs.confluent.io/cloud/current/stream-governance/packages.html#cloud-providers-and-region-support). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Regions Model + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.RegionSpec' + srcm.v2.ClusterList: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list, create, read, and delete your Schema Registry clusters. + + + Related guides: + * [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Clusters Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list, create, read, and delete your Schema Registry clusters. + + + Related guides: + * [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Clusters Model + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + srcm.v2.Cluster: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list, create, read, and delete your Schema Registry clusters. + + + Related guides: + * [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). + + + ## The Clusters Model + + properties: + api_version: + type: string + enum: + - srcm/v2 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v2.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v2.ClusterStatus' + srcm.v3.ClusterList: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list and read your Schema Registry clusters. + + + Related guide: [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + ## The Clusters Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - srcm/v3 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list and read your Schema Registry clusters. + + + Related guide: [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + ## The Clusters Model + + properties: + api_version: + type: string + enum: + - srcm/v3 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v3.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v3.ClusterStatus' + required: + - id + - metadata + - spec + - status + uniqueItems: true + srcm.v3.Cluster: + type: object + description: |- + `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. + + The API allows you to list and read your Schema Registry clusters. + + + Related guide: [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). + + ## The Clusters Model + + properties: + api_version: + type: string + enum: + - srcm/v3 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Cluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/srcm.v3.ClusterSpec' + status: + $ref: '#/components/schemas/srcm.v3.ClusterStatus' + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + srcm.v2.RegionSpec: + type: object + description: The desired state of the Region + properties: + display_name: + type: string + description: The display name. + example: Ohio (us-east-2) + x-immutable: true + readOnly: true + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + readOnly: true + region_name: + type: string + description: The region name. + example: us-east-2 + x-immutable: true + readOnly: true + packages: + type: array + items: + type: string + x-extensible-enum: + - ESSENTIALS + - ADVANCED + description: List of Stream Governance packages allowing placement in this region. + example: + - ESSENTIALS + - ADVANCED + x-immutable: true + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + srcm.v2.ClusterSpec: + type: object + description: The desired state of the Cluster + properties: + display_name: + type: string + description: The cluster name. + example: Stream Governance package + x-immutable: true + readOnly: true + package: + type: string + description: | + The billing package. + + Note: Clusters can be upgraded from ESSENTIALS to ADVANCED, but cannot be + downgraded from ADVANCED to ESSENTIALS. + x-extensible-enum: + - ESSENTIALS + - ADVANCED + example: ESSENTIALS + http_endpoint: + type: string + description: The cluster HTTP request URL. + format: uri + example: https://psrc-00000.us-central1.gcp.confluent.cloud + x-immutable: true + readOnly: true + environment: + description: The environment to which this belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + region: + description: The region to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + srcm.v2.ClusterStatus: + type: object + required: + - phase + description: The status of the Cluster + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PROVISIONED + - FAILED + description: | + The lifecyle phase of the cluster: + + PROVISIONED: cluster is provisioned; + + PROVISIONING: cluster provisioning is in progress; + + FAILED: provisioning failed + + Note: Schema Registry Cluster Management is handled through the org/v2 Environments API as of srcm/v3. + readOnly: true + example: PROVISIONED + readOnly: true + srcm.v3.ClusterSpec: + type: object + description: The desired state of the Cluster + properties: + display_name: + type: string + description: The cluster name. + example: Stream Governance package + x-immutable: true + readOnly: true + package: + type: string + description: | + The billing package. + + Note: Clusters can be upgraded from ESSENTIALS to ADVANCED, but cannot be + downgraded from ADVANCED to ESSENTIALS. + x-extensible-enum: + - ESSENTIALS + - ADVANCED + example: ESSENTIALS + http_endpoint: + type: string + description: The cluster HTTP request URL. + format: uri + example: https://psrc-00000.us-central1.gcp.confluent.cloud + x-immutable: true + readOnly: true + catalog_http_endpoint: + type: string + description: The cluster's catalog HTTP request URL. + format: uri + example: https://psrc-00000.us-central1.gcp.confluent.cloud + x-immutable: true + readOnly: true + private_http_endpoint: + type: string + description: | + The cluster's private HTTP request URL. + + DEPRECATED - Please use the `private_networking_config.regional_endpoints` attribute instead, + which supersedes the `private_http_endpoint` attribute. + format: uri + example: https://lsrc-abc.us-central-1.aws.private.confluent.cloud + x-immutable: true + readOnly: true + private_networking_config: + type: object + description: Available HTTP request URLs for private connectivity. + properties: + regional_endpoints: + type: object + description: A map of region identifiers to their corresponding private HTTP request URL. + additionalProperties: + type: string + format: uri + example: + regional_endpoints: + us-central-1: https://lsrc-abc.us-central-1.aws.private.confluent.cloud + us-west-2: https://lsrc-abc.us-west-2.aws.private.confluent.cloud + x-immutable: true + readOnly: true + cloud: + type: string + description: The cloud service provider in which the cluster is running. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: GCP + x-immutable: true + region: + type: string + description: The cloud service provider region where the cluster is running. + example: us-east4 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + srcm.v3.ClusterStatus: + type: object + required: + - phase + description: The status of the Cluster + properties: + phase: + type: string + x-extensible-enum: + - PROVISIONING + - PROVISIONED + - FAILED + description: | + The lifecyle phase of the cluster: + + PROVISIONED: cluster is provisioned; + + PROVISIONING: cluster provisioning is in progress; + + FAILED: provisioning failed + readOnly: true + example: PROVISIONED + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + GlobalObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/share_group.yaml b/provider-dev/source/share_group.yaml new file mode 100644 index 0000000..ed22a5e --- /dev/null +++ b/provider-dev/source/share_group.yaml @@ -0,0 +1,764 @@ +openapi: 3.0.0 +info: + title: share_group API + description: confluent share_group API + version: 1.0.0 +paths: + /kafka/v3/clusters/{cluster_id}/share-groups: + get: + summary: List Share Groups + operationId: listKafkaShareGroups + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the list of share groups that belong to the specified + Kafka cluster. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListShareGroupsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}: + get: + summary: Get Share Group + operationId: getKafkaShareGroup + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the share group specified by the ``group_id``. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetShareGroupResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + delete: + summary: Delete Share Group + operationId: deleteKafkaShareGroup + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete the share group specified by the ``group_id``. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '204': + $ref: '#/components/responses/NoContentResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '404': + $ref: '#/components/responses/NotFoundErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers: + get: + summary: List Share Group Consumers + operationId: listKafkaShareGroupConsumers + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return a list of consumers that belong to the specified share + group. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListShareGroupConsumersResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}: + get: + summary: Get Share Group Consumer + operationId: getKafkaShareGroupConsumer + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the consumer specified by the ``consumer_id``. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetShareGroupConsumerResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConsumerId' + /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}/assignments: + get: + summary: List Share Group Consumer Assignments + operationId: listKafkaShareGroupConsumerAssignments + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the consumer assignments specified by the ``consumer_id``. + tags: + - Share Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListShareGroupConsumerAssignmentsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConsumerId' +components: + schemas: + ShareGroupDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ShareGroupData' + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + ShareGroupData: + type: object + required: + - kind + - metadata + - cluster_id + - share_group_id + - state + - coordinator + - consumers + - consumer_count + - partition_count + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + share_group_id: + type: string + state: + $ref: '#/components/schemas/ShareGroupState' + coordinator: + $ref: '#/components/schemas/Relationship' + consumers: + $ref: '#/components/schemas/Relationship' + consumer_count: + type: integer + format: int32 + description: Number of consumers in this share group + partition_count: + type: integer + format: int32 + description: Total number of partitions assigned to this share group across all consumers + assigned_topic_partitions: + type: array + items: + $ref: '#/components/schemas/ShareGroupTopicPartitionData' + description: List of topic-partitions assigned to this share group, including those from empty groups + ShareGroupConsumerDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ShareGroupConsumerData' + ShareGroupConsumerData: + type: object + required: + - kind + - metadata + - cluster_id + - group_id + - consumer_id + - client_id + - assignments + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + group_id: + type: string + consumer_id: + type: string + client_id: + type: string + assignments: + $ref: '#/components/schemas/Relationship' + ShareGroupConsumerAssignmentDataList: + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + items: + $ref: '#/components/schemas/ShareGroupConsumerAssignmentData' + ResourceCollection: + type: object + required: + - kind + - metadata + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + Resource: + type: object + required: + - kind + - metadata + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + ShareGroupState: + type: string + x-extensible-enum: + - UNKNOWN + - PREPARING_REBALANCE + - COMPLETING_REBALANCE + - STABLE + - DEAD + - EMPTY + Relationship: + type: object + required: + - related + properties: + related: + type: string + ShareGroupTopicPartitionData: + type: object + required: + - kind + - metadata + - topic_name + - partition_id + - partition + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + topic_name: + type: string + description: The name of the topic + partition_id: + type: integer + format: int32 + description: The partition ID + partition: + $ref: '#/components/schemas/Relationship' + description: Link to the topic partition + ShareGroupConsumerAssignmentData: + type: object + required: + - kind + - metadata + - cluster_id + - group_id + - consumer_id + - topic_name + - partition_id + - partition + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + group_id: + type: string + consumer_id: + type: string + topic_name: + type: string + partition_id: + type: integer + partition: + $ref: '#/components/schemas/Relationship' + ResourceCollectionMetadata: + type: object + required: + - self + properties: + self: + type: string + next: + type: string + nullable: true + ResourceMetadata: + type: object + required: + - self + properties: + self: + type: string + resource_name: + type: string + nullable: true + responses: + ListShareGroupsResponse: + description: The list of share groups. + content: + application/json: + schema: + $ref: '#/components/schemas/ShareGroupDataList' + example: + kind: KafkaShareGroupList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups + next: null + data: + - kind: KafkaShareGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1 + cluster_id: cluster-1 + share_group_id: share-group-1 + state: STABLE + coordinator: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + consumers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers + consumer_count: 2 + partition_count: 3 + assigned_topic_partitions: + - kind: KafkaShareGroupTopicPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/assigned-topic-partitions/topic-1/0 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/topic-partition=topic-1:0 + topic_name: topic-1 + partition_id: 0 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0 + - kind: KafkaShareGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-2 + resource_name: crn:///kafka=cluster-1/share-group=share-group-2 + cluster_id: cluster-1 + share_group_id: share-group-2 + state: EMPTY + coordinator: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2 + consumers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-2/consumers + consumer_count: 2 + partition_count: 3 + assigned_topic_partitions: + - kind: KafkaShareGroupTopicPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-2/assigned-topic-partitions/topic-1/0 + resource_name: crn:///kafka=cluster-1/share-group=share-group-2/topic-partition=topic-1:0 + topic_name: topic-1 + partition_id: 0 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0 + BadRequestErrorResponse: + description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + bad_request_cannot_deserialize: + description: Thrown when trying to deserialize an integer from non-integer data. + value: + error_code: 400 + message: 'Cannot deserialize value of type `java.lang.Integer` from String "A": not a valid `java.lang.Integer` value' + unsupported_version_exception: + description: Thrown when the version of this API is not supported in the underlying Kafka cluster. + value: + error_code: 40035 + message: The version of this API is not supported in the underlying Kafka cluster. + UnauthorizedErrorResponse: + description: Indicates a client authentication error. Kafka authentication failures will contain error code 40101 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + kafka_authentication_failed: + description: Thrown when using Basic authentication with wrong Kafka credentials. + value: + error_code: 40101 + message: Authentication failed + ForbiddenErrorResponse: + description: Indicates a client authorization error. Kafka authorization failures will contain error code 40301 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + kafka_authorization_failed: + description: Thrown when the caller is not authorized to perform the underlying operation. + value: + error_code: 40301 + message: Request is not authorized + TooManyRequestsErrorResponse: + description: Indicates that a rate limit threshold has been reached, and the client should retry again later. + content: + text/html: + schema: + type: string + example: + description: A sample response from Jetty's DoSFilter. + value: Error 429 Too Many Requests

HTTP ERROR 429 Too Many Requests

URI: /v3/clusters/my-cluster
STATUS: 429
MESSAGE: Too Many Requests
SERVLET: default
+ ServerErrorResponse: + description: A server-side problem that might not be addressable from the client side. Retriable Kafka errors will contain error code 50003 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + generic_internal_server_error: + description: Thrown for generic HTTP 500 errors. + value: + error_code: 500 + message: Internal Server Error + GetShareGroupResponse: + description: The share group. + content: + application/json: + schema: + $ref: '#/components/schemas/ShareGroupData' + example: + kind: KafkaShareGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1 + cluster_id: cluster-1 + share_group_id: share-group-1 + state: STABLE + coordinator: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1 + consumers: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers + consumer_count: 2 + partition_count: 3 + assigned_topic_partitions: + - kind: KafkaShareGroupTopicPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/assigned-topic-partitions/topic-1/0 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/topic-partition=topic-1:0 + topic_name: topic-1 + partition_id: 0 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0 + - kind: KafkaShareGroupTopicPartition + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/assigned-topic-partitions/topic-1/1 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/topic-partition=topic-1:1 + topic_name: topic-1 + partition_id: 1 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + NoContentResponse: + description: Operation succeeded, no content in the response + NotFoundErrorResponse: + description: Indicates attempted access to an unreachable or non-existing resource like e.g. an unknown topic or partition. GET requests to endpoints not allowed in the accesslists will also result in this response. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + endpoint_not_found: + description: Thrown for generic HTTP 404 errors. + value: + error_code: 404 + message: HTTP 404 Not Found + cluster_not_found: + description: Thrown when using a non-existing cluster ID. + value: + error_code: 404 + message: Cluster my-cluster cannot be found. + unknown_topic_or_partition: + description: Thrown when using a non-existing topic name or partition ID. + value: + error_code: 40403 + message: This server does not host this topic-partition. + ListShareGroupConsumersResponse: + description: The list of consumers. + content: + application/json: + schema: + $ref: '#/components/schemas/ShareGroupConsumerDataList' + example: + kind: KafkaShareConsumerList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers + next: null + data: + - kind: KafkaShareGroupConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-1 + client_id: client-1 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments + - kind: KafkaShareGroupConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-2 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-2 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-2 + client_id: client-2 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-2/assignments + - kind: KafkaShareGroupConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-3 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-3 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-3 + client_id: client-3 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-3/assignments + GetShareGroupConsumerResponse: + description: The consumer. + content: + application/json: + schema: + $ref: '#/components/schemas/ShareGroupConsumerData' + example: + kind: KafkaShareGroupConsumer + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-1 + client_id: client-1 + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments + ListShareGroupConsumerAssignmentsResponse: + description: The list of share group assignments. + content: + application/json: + schema: + $ref: '#/components/schemas/ShareGroupConsumerAssignmentDataList' + example: + kind: KafkaConsumerAssignmentList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments + next: null + data: + - kind: KafkaShareGroupConsumerAssignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments/topic-1/partitions/1 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1/assignment=topic=1/partition=1 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-1 + topic_name: topic-1 + partition_id: 1 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1 + - kind: KafkaShareGroupConsumerAssignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments/topic-2/partitions/2 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1/assignment=topic=2/partition=2 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-1 + topic_name: topic-2 + partition_id: 2 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions/2 + - kind: KafkaShareGroupConsumerAssignment + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments/topic-3/partitions/3 + resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1/assignment=topic=3/partition=3 + cluster_id: cluster-1 + group_id: share-group-1 + consumer_id: consumer-1 + topic_name: topic-3 + partition_id: 3 + partition: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions/3 + parameters: + ClusterId: + name: cluster_id + description: The Kafka cluster ID. + in: path + required: true + schema: + type: string + example: cluster-1 + GroupId: + name: group_id + description: The group ID. + in: path + required: true + schema: + type: string + example: group-1 + ConsumerId: + name: consumer_id + description: The consumer ID. + in: path + required: true + schema: + type: string + example: consumer-1 +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/sql.yaml b/provider-dev/source/sql.yaml new file mode 100644 index 0000000..ef4fe48 --- /dev/null +++ b/provider-dev/source/sql.yaml @@ -0,0 +1,7543 @@ +openapi: 3.0.0 +info: + title: sql API + description: confluent sql API + version: 1.0.0 +paths: + /sql/v1/organizations/{organization_id}/environments/{environment_id}/connections: + get: + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1Connections + summary: List of Connections + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered and paginated list of all Connections. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: spec.connection_type + in: query + required: false + schema: + type: string + x-extensible-enum: + - AZUREML + - AZUREOPENAI + - A2A + - ANTHROPIC + - BEDROCK + - CONFLUENT_JDBC + - COSMOSDB + - COUCHBASE + - ELASTIC + - FIREWORKSAI + - GOOGLEAI + - MCP_SERVER + - MONGODB + - OPENAI + - PINECONE + - REST + - S3VECTORS + - SAGEMAKER + - VERTEXAI + description: Filter the results by exact match for spec.connection_type + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Connections (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Connections. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.ConnectionList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Preview + x-self-access: false + x-request-access-name: SQL API v1 + operationId: createSqlv1Connection + summary: Create a Connection + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a Connection. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + tags: + - Connections (sql/v1) + security: + - resource-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Connection` models a reusable endpoint and auth token to authenticate the caller to + use that endpoint. + Only `OrganizationAdmins` and `EnvironmentAdmins` will have the permissions to create, update and delete `Connections`. + `FlinkDevelopers` and `ModelResourceOwners` can later reference a `Connection` resource within their Model + creation statements. + The API allows you to list, create, read, and delete your connections. + ## The Connections Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Connection + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: my-openai-connection + description: The user provided name of the resource, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ConnectionSpec' + status: + $ref: '#/components/schemas/sql.v1.ConnectionStatus' + required: + - spec + - name + responses: + '201': + description: A Connection has been successfully created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{name} + description: Connection resource uri + content: + application/json: + schema: + type: object + description: |- + `Connection` models a reusable endpoint and auth token to authenticate the caller to + use that endpoint. + Only `OrganizationAdmins` and `EnvironmentAdmins` will have the permissions to create, update and delete `Connections`. + `FlinkDevelopers` and `ModelResourceOwners` can later reference a `Connection` resource within their Model + creation statements. + The API allows you to list, create, read, and delete your connections. + ## The Connections Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Connection + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: my-openai-connection + description: The user provided name of the resource, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ConnectionSpec' + status: + $ref: '#/components/schemas/sql.v1.ConnectionStatus' + required: + - spec + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + /sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}: + get: + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1Connection + summary: Read a Connection + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a Connection. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: connection_name + in: path + required: true + schema: + type: string + description: The user provided name of the Connection. Unique within a region within an org and env. + tags: + - Connections (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Connection. + content: + application/json: + schema: + type: object + description: |- + `Connection` models a reusable endpoint and auth token to authenticate the caller to + use that endpoint. + Only `OrganizationAdmins` and `EnvironmentAdmins` will have the permissions to create, update and delete `Connections`. + `FlinkDevelopers` and `ModelResourceOwners` can later reference a `Connection` resource within their Model + creation statements. + The API allows you to list, create, read, and delete your connections. + ## The Connections Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Connection + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: my-openai-connection + description: The user provided name of the resource, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ConnectionSpec' + status: + $ref: '#/components/schemas/sql.v1.ConnectionStatus' + required: + - api_version + - kind + - metadata + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Preview + x-self-access: false + x-request-access-name: SQL API v1 + operationId: deleteSqlv1Connection + summary: Delete a Connection + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a statement. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: connection_name + in: path + required: true + schema: + type: string + description: The unique identifier for the connection. + tags: + - Connections (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: A Connection has been deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + x-lifecycle-stage: Preview + x-self-access: false + x-request-access-name: SQL API v1 + operationId: updateSqlv1Connection + summary: Update a Connection + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a connection. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: connection_name + in: path + required: true + schema: + type: string + description: The unique identifier for the connection. + tags: + - Connections (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: A Connection has been updated. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Connection` models a reusable endpoint and auth token to authenticate the caller to + use that endpoint. + Only `OrganizationAdmins` and `EnvironmentAdmins` will have the permissions to create, update and delete `Connections`. + `FlinkDevelopers` and `ModelResourceOwners` can later reference a `Connection` resource within their Model + creation statements. + The API allows you to list, create, read, and delete your connections. + ## The Connections Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Connection + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: my-openai-connection + description: The user provided name of the resource, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ConnectionSpec' + status: + $ref: '#/components/schemas/sql.v1.ConnectionStatus' + required: + - spec + - name + - metadata + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name}/results: + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1StatementResult + summary: Read Statement Result + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Read Statement Result. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: It contains the field offset in the CollectSinkFunction protocol. On the first request, it should be unset. The offset is assumed to start at 0. + tags: + - Statement Results (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: Statement Result. + content: + application/json: + schema: + type: object + description: |- + `Statement Result` represents a resource used to model results of SQL statements. + The API allows you to read your SQL statement result. + required: + - api_version + - kind + - metadata + - data + - results + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementResult + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements + next: + description: A URL that can be followed to get the next batch of results. + type: string + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + results: + type: object + description: A results property that contains a data property that contains an array of results. + properties: + data: + type: array + description: | + A data property that contains an array of results. Each entry in the array is a separate result. + + The value of `op` attribute (if present) represents the kind of change that a row can describe in a changelog: + + `0`: represents `INSERT` (`+I`), i.e. insertion operation; + + `1`: represents `UPDATE_BEFORE` (`-U`), i.e. update operation with the previous content of the updated row. + This kind should occur together with `UPDATE_AFTER` for modelling an update that needs to retract + the previous row first. It is useful in cases of a non-idempotent update, i.e., an update of a row that is not + uniquely identifiable by a key; + + `2`: represents `UPDATE_AFTER` (`+U`), i.e. update operation with new content of the updated row; + This kind CAN occur together with `UPDATE_BEFORE` for modelling an update that + needs to retract the previous row first or it describes an idempotent update, i.e., an + update of a row that is uniquely identifiable by a key; + + `3`: represents `DELETE` (`-D`), i.e. deletion operation; + + Defaults to `0`. + items: {} + example: + - op: 0 + row: + - '101' + - Jay + - - null + - abc + - - null + - '456' + - 1990-01-12 12:00.12 + - - - null + - Alice + - - '42' + - Bob + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements: + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1Statements + summary: List of Statements + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all statements. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: spec.compute_pool_id + in: query + required: false + schema: + type: string + example: lfcp-00000 + description: |- + Filter the results by exact match for spec.compute_pool_id. + When creating statements, if compute_pool_id is not specified, the statement will use the default compute pool. The default pool is automatically determined by the system. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + - name: label_selector + in: query + required: false + schema: + type: string + style: form + explode: false + description: A comma-separated label selector to filter the statements. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: Statements. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.StatementList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: createSqlv1Statement + summary: Create a Statement + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a statement. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Statement` represents a core resource used to model SQL statements for execution. + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session + management or any higher-level functionality. + The API allows you to list, create, read, and delete your statements. + ## The Statements Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Statement + readOnly: true + metadata: + description: The metadata of the statement. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: A system generated globally unique identifier for this resource. + resource_version: + type: string + example: a23av + description: A system generated string that uniquely identifies the version of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + resource_name: + example: '' + readOnly: true + type: object + name: + type: string + example: sql123 + description: The user provided name of the resource, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + spec: + $ref: '#/components/schemas/sql.v1.StatementSpec' + status: + $ref: '#/components/schemas/sql.v1.StatementStatus' + result: + $ref: '#/components/schemas/sql.v1.StatementResult' + required: + - spec + - name + responses: + '201': + description: A Statement is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name} + description: Statement resource uri + content: + application/json: + schema: + type: object + description: |- + `Statement` represents a core resource used to model SQL statements for execution. + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session + management or any higher-level functionality. + The API allows you to list, create, read, and delete your statements. + ## The Statements Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Statement + readOnly: true + metadata: + description: The metadata of the statement. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: A system generated globally unique identifier for this resource. + resource_version: + type: string + example: a23av + description: A system generated string that uniquely identifies the version of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + resource_name: + example: '' + readOnly: true + type: object + name: + type: string + example: sql123 + description: The user provided name of the resource, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + spec: + $ref: '#/components/schemas/sql.v1.StatementSpec' + status: + $ref: '#/components/schemas/sql.v1.StatementStatus' + result: + $ref: '#/components/schemas/sql.v1.StatementResult' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1Statement + summary: Read a Statement + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a statement. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: statement_name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: Statement. + content: + application/json: + schema: + type: object + description: |- + `Statement` represents a core resource used to model SQL statements for execution. + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session + management or any higher-level functionality. + The API allows you to list, create, read, and delete your statements. + ## The Statements Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Statement + readOnly: true + metadata: + description: The metadata of the statement. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: A system generated globally unique identifier for this resource. + resource_version: + type: string + example: a23av + description: A system generated string that uniquely identifies the version of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + resource_name: + example: '' + readOnly: true + type: object + name: + type: string + example: sql123 + description: The user provided name of the resource, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + spec: + $ref: '#/components/schemas/sql.v1.StatementSpec' + status: + $ref: '#/components/schemas/sql.v1.StatementStatus' + result: + $ref: '#/components/schemas/sql.v1.StatementResult' + required: + - api_version + - kind + - metadata + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: deleteSqlv1Statement + summary: Delete a Statement + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a statement. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: statement_name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '202': + description: A Statement is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: updateSqlv1Statement + summary: Update a Statement + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a statement. + The request will fail with a 409 Conflict error if the Statement has changed since it was fetched. + In this case, do a GET, reapply the modifications, and try the update again. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: statement_name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '202': + description: A Statement is being updated. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Statement` represents a core resource used to model SQL statements for execution. + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session + management or any higher-level functionality. + The API allows you to list, create, read, and delete your statements. + ## The Statements Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Statement + readOnly: true + metadata: + description: The metadata of the statement. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: A system generated globally unique identifier for this resource. + resource_version: + type: string + example: a23av + description: A system generated string that uniquely identifies the version of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + resource_name: + example: '' + readOnly: true + type: object + name: + type: string + example: sql123 + description: The user provided name of the resource, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + spec: + $ref: '#/components/schemas/sql.v1.StatementSpec' + status: + $ref: '#/components/schemas/sql.v1.StatementStatus' + result: + $ref: '#/components/schemas/sql.v1.StatementResult' + required: + - spec + - name + - metadata + patch: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: patchSqlv1Statement + summary: Patch a Statement + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to patch a statement. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: statement_name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + tags: + - Statements (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/PatchRequest' + responses: + '200': + description: Patched Statement. + content: + application/json: + schema: + type: object + description: |- + `Statement` represents a core resource used to model SQL statements for execution. + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session + management or any higher-level functionality. + The API allows you to list, create, read, and delete your statements. + ## The Statements Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Statement + readOnly: true + metadata: + description: The metadata of the statement. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: A system generated globally unique identifier for this resource. + resource_version: + type: string + example: a23av + description: A system generated string that uniquely identifies the version of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + resource_name: + example: '' + readOnly: true + type: object + name: + type: string + example: sql123 + description: The user provided name of the resource, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + spec: + $ref: '#/components/schemas/sql.v1.StatementSpec' + status: + $ref: '#/components/schemas/sql.v1.StatementStatus' + result: + $ref: '#/components/schemas/sql.v1.StatementResult' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}/exceptions: + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1StatementExceptions + summary: List of Statement Exceptions + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a list of the 10 most recent statement exceptions. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: statement_name + in: path + required: true + schema: + type: string + description: The unique identifier for the statement. + tags: + - Statement Exceptions (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: Statement Exceptions. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.StatementExceptionList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + /sql/v1/organizations/{organization_id}/environments/{environment_id}/materialized-tables: + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1MaterializedTables + summary: List all materialized tables + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted and paginated list of all materialized tables. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: page_size + in: query + required: false + schema: + type: integer + format: int32 + default: 10 + maximum: 100 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Materialized Tables (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: A list of Materialized Tables. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.MaterializedTableList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables: + post: + x-lifecycle-stage: General Availability + operationId: createSqlv1MaterializedTable + summary: Create a materialized table + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Create a new Materialized Table. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + tags: + - Materialized Tables (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + description: Represents a Materialized Table resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - MaterializedTable + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: The user-provided name of the resource, unique within this environment. + pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$ + maxLength: 100 + example: high-value-orders + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.MaterializedTableSpec' + status: + readOnly: true + type: object + description: The status of the Materialized Table. + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - RUNNING + - COMPLETED + - DELETING + - FAILING + - FAILED + - CREATING + - ALTERING + - DEGRADED + - STOPPING + - STOPPED + description: The lifecycle phase of the materialized table. + example: RUNNING + detail: + type: string + description: Optional. Human-readable description of phase. + example: Materialized table is running. + warnings: + type: array + description: List of warnings encountered during materialized table execution. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTableWarning' + creation_statement: + type: string + description: Entire Materialized Table statement as submitted by user e.g CREATE OR ALTER MATERIALIZED TABLE ... + example: CREATE OR ALTER MATERIALIZED TABLE high-value-orders AS SELECT user_id, product_id, price, quantity FROM orders WHERE price > 1000; + scaling_status: + $ref: '#/components/schemas/sql.v1.ScalingStatus' + version: + type: integer + format: int32 + minimum: 1 + description: Represents the evolution history of the Materialized Table. The current value indicates the latest version. + example: 3 + latest_version: + type: integer + format: int32 + minimum: 1 + description: Represents the latest submitted version of the Materialized Table. When a query evolution is accepted, `latest_version` is incremented immediately and will be greater than `version` until the new query is fully activated. + example: 4 + responses: + '201': + description: Materialized Table is being created + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name} + description: Materialized Table uri + content: + application/json: + schema: + type: object + description: Represents a Materialized Table resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + - status + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - MaterializedTable + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: The user-provided name of the resource, unique within this environment. + pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$ + maxLength: 100 + example: high-value-orders + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.MaterializedTableSpec' + status: + readOnly: true + type: object + description: The status of the Materialized Table. + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - RUNNING + - COMPLETED + - DELETING + - FAILING + - FAILED + - CREATING + - ALTERING + - DEGRADED + - STOPPING + - STOPPED + description: The lifecycle phase of the materialized table. + example: RUNNING + detail: + type: string + description: Optional. Human-readable description of phase. + example: Materialized table is running. + warnings: + type: array + description: List of warnings encountered during materialized table execution. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTableWarning' + creation_statement: + type: string + description: Entire Materialized Table statement as submitted by user e.g CREATE OR ALTER MATERIALIZED TABLE ... + example: CREATE OR ALTER MATERIALIZED TABLE high-value-orders AS SELECT user_id, product_id, price, quantity FROM orders WHERE price > 1000; + scaling_status: + $ref: '#/components/schemas/sql.v1.ScalingStatus' + version: + type: integer + format: int32 + minimum: 1 + description: Represents the evolution history of the Materialized Table. The current value indicates the latest version. + example: 3 + latest_version: + type: integer + format: int32 + minimum: 1 + description: Represents the latest submitted version of the Materialized Table. When a query evolution is accepted, `latest_version` is incremented immediately and will be greater than `version` until the new query is fully activated. + example: 4 + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}: + get: + x-lifecycle-stage: General Availability + operationId: getSqlv1MaterializedTable + summary: Read a materialized table + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a specific Materialized Table by name. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: table_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Materialized Table + tags: + - Materialized Tables (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: The requested Materialized Table. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.MaterializedTable' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + x-lifecycle-stage: General Availability + operationId: updateSqlv1MaterializedTable + summary: Update/Evolve a materialized table + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a Materialized Table's mutable fields. + Mutable fields include: `query`, `stopped`, `compute_pool_id`, `principal`, `columns`, `watermark`, `constraints` and `table_options`. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: table_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Materialized Table + tags: + - Materialized Tables (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + description: The Materialized Table resource with updated spec fields. + required: true + content: + application/json: + schema: + type: object + description: Represents a Materialized Table resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - MaterializedTable + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: The user-provided name of the resource, unique within this environment. + pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$ + maxLength: 100 + example: high-value-orders + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.MaterializedTableSpec' + status: + readOnly: true + type: object + description: The status of the Materialized Table. + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - RUNNING + - COMPLETED + - DELETING + - FAILING + - FAILED + - CREATING + - ALTERING + - DEGRADED + - STOPPING + - STOPPED + description: The lifecycle phase of the materialized table. + example: RUNNING + detail: + type: string + description: Optional. Human-readable description of phase. + example: Materialized table is running. + warnings: + type: array + description: List of warnings encountered during materialized table execution. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTableWarning' + creation_statement: + type: string + description: Entire Materialized Table statement as submitted by user e.g CREATE OR ALTER MATERIALIZED TABLE ... + example: CREATE OR ALTER MATERIALIZED TABLE high-value-orders AS SELECT user_id, product_id, price, quantity FROM orders WHERE price > 1000; + scaling_status: + $ref: '#/components/schemas/sql.v1.ScalingStatus' + version: + type: integer + format: int32 + minimum: 1 + description: Represents the evolution history of the Materialized Table. The current value indicates the latest version. + example: 3 + latest_version: + type: integer + format: int32 + minimum: 1 + description: Represents the latest submitted version of the Materialized Table. When a query evolution is accepted, `latest_version` is incremented immediately and will be greater than `version` until the new query is fully activated. + example: 4 + responses: + '200': + description: Materialized Table update accepted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.MaterializedTable' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + operationId: deleteSqlv1MaterializedTable + summary: Delete a materialized table + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Delete a specific Materialized Table by name. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: table_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Materialized Table + tags: + - Materialized Tables (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '202': + description: A Materialized Table is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions: + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1MaterializedTableVersions + summary: List all the versions of a materialized table + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted and paginated list of all versions for a specific Materialized Table. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - in: path + name: table_name + required: true + schema: + type: string + description: The unique identifier for the Materialized Table. + - name: page_size + in: query + required: false + schema: + type: integer + format: int32 + default: 10 + maximum: 100 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Materialized Table Versions (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: A list of Materialized Table Versions. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.MaterializedTableVersionList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions/{version}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1MaterializedTableVersion + summary: Read a materialized table version + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a specific version of a Materialized Table. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - in: path + name: table_name + required: true + schema: + type: string + description: The unique identifier for the Materialized Table. + - in: path + name: version + required: true + schema: + type: integer + format: int32 + minimum: 1 + description: The version number of the Materialized Table. + tags: + - Materialized Table Versions (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: The requested Materialized Table Version. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.MaterializedTableVersion' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/agents: + get: + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1Agents + summary: List all agents + description: | + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted and paginated list of all agents. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: page_size + in: query + required: false + schema: + type: integer + format: int32 + default: 10 + maximum: 100 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Agents (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: A list of Agents. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.AgentList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents: + post: + x-lifecycle-stage: Preview + operationId: createSqlv1Agent + summary: Create an Agent + description: | + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create an Agent. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + tags: + - Agents (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: Represents an Agent resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Agent + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: The user-provided name of the agent, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + maxLength: 100 + example: chat-listener-agent + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.AgentSpec' + status: + readOnly: true + type: object + description: The status of the Agent. + properties: + phase: + type: string + x-extensible-enum: + - READY + - RUNNING + description: | + Describes the status of the agent: + + READY: The Agent is created; + + RUNNING: The Agent is created and running in a query; + example: RUNNING + responses: + '200': + description: Agent. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name} + description: Agent uri + content: + application/json: + schema: + type: object + description: Represents an Agent resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Agent + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: The user-provided name of the agent, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + maxLength: 100 + example: chat-listener-agent + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.AgentSpec' + status: + readOnly: true + type: object + description: The status of the Agent. + properties: + phase: + type: string + x-extensible-enum: + - READY + - RUNNING + description: | + Describes the status of the agent: + + READY: The Agent is created; + + RUNNING: The Agent is created and running in a query; + example: RUNNING + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name}: + get: + x-lifecycle-stage: Preview + operationId: getSqlv1Agent + summary: Read an Agent + description: | + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a specific Agent by name. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: agent_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Agent + tags: + - Agents (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: The requested Agent. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.Agent' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + put: + x-lifecycle-stage: Preview + operationId: updateSqlv1Agent + summary: Alter an Agent + description: | + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update an Agent's mutable fields. + Mutable fields include: `description`, `model`, `prompt`, and `properties`. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: agent_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Agent + tags: + - Agents (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + requestBody: + description: The Agent resource with updated spec fields. + required: true + content: + application/json: + schema: + type: object + description: Represents an Agent resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Agent + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: The user-provided name of the agent, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + maxLength: 100 + example: chat-listener-agent + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.AgentSpec' + status: + readOnly: true + type: object + description: The status of the Agent. + properties: + phase: + type: string + x-extensible-enum: + - READY + - RUNNING + description: | + Describes the status of the agent: + + READY: The Agent is created; + + RUNNING: The Agent is created and running in a query; + example: RUNNING + responses: + '200': + description: Agent has been updated. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.Agent' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Preview + operationId: deleteSqlv1Agent + summary: Delete an Agent + description: | + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91)](#section/Versioning/API-Lifecycle-Policy) + + Delete a specific Agent by name. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: kafka_cluster_id + required: true + schema: + type: string + description: The unique identifier for the database. + - name: agent_name + in: path + required: true + schema: + type: string + description: The unique identifier for the Agent + tags: + - Agents (sql/v1) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + description: A Agent has been deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools: + post: + x-lifecycle-stage: Preview + x-self-access: false + x-request-access-name: SQL API v1 + operationId: createSqlv1Tool + summary: Create a Tool + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a Tool. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: database_name + required: true + schema: + type: string + description: The name of the database. + tags: + - Tools (sql/v1) + security: + - resource-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `Tool` models a reusable tool resource backed by a connection that can be referenced + by agents to perform actions. + The API allows you to create your tools. + ## The Tools Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Tool + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: linear-mcp-tool + description: The user provided name of the tool, unique within this environment. + pattern: '[a-z0-9_]([-a-z0-9_]*[a-z0-9_])?' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ToolSpec' + status: + $ref: '#/components/schemas/sql.v1.ToolStatus' + required: + - name + - spec + responses: + '200': + description: A Tool has been successfully created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://flink.region.provider.confluent.cloud/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools/{name} + description: Tool resource uri + content: + application/json: + schema: + type: object + description: |- + `Tool` models a reusable tool resource backed by a connection that can be referenced + by agents to perform actions. + The API allows you to create your tools. + ## The Tools Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Tool + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: linear-mcp-tool + description: The user provided name of the tool, unique within this environment. + pattern: '[a-z0-9_]([-a-z0-9_]*[a-z0-9_])?' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ToolSpec' + status: + $ref: '#/components/schemas/sql.v1.ToolStatus' + required: + - name + - spec + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + get: + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + operationId: listSqlv1Tools + summary: List of Tools + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all Tools. + parameters: + - in: path + name: organization_id + required: true + schema: + type: string + format: uuid + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - in: path + name: database_name + required: true + schema: + type: string + description: The name of the database. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Tools (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Tools. + content: + application/json: + schema: + $ref: '#/components/schemas/sql.v1.ToolList' + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools/{tool_name}: + get: + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 + operationId: getSqlv1Tool + summary: Read a Tool + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a Tool. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: database_name + in: path + required: true + schema: + type: string + description: The name of the database. + - name: tool_name + in: path + required: true + schema: + type: string + description: The user provided name of the Tool. + tags: + - Tools (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Tool. + content: + application/json: + schema: + type: object + description: |- + `Tool` models a reusable tool resource backed by a connection that can be referenced + by agents to perform actions. + The API allows you to create your tools. + ## The Tools Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Tool + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: linear-mcp-tool + description: The user provided name of the tool, unique within this environment. + pattern: '[a-z0-9_]([-a-z0-9_]*[a-z0-9_])?' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ToolSpec' + status: + $ref: '#/components/schemas/sql.v1.ToolStatus' + required: + - api_version + - kind + - metadata + - name + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Preview + x-self-access: false + x-request-access-name: SQL API v1 + operationId: deleteSqlv1Tool + summary: Delete a Tool + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a Tool. + parameters: + - in: path + name: organization_id + schema: + type: string + format: uuid + required: true + description: The unique identifier for the organization. + - in: path + name: environment_id + required: true + schema: + type: string + description: The unique identifier for the environment. + - name: database_name + in: path + required: true + schema: + type: string + description: The name of the database. + - name: tool_name + in: path + required: true + schema: + type: string + description: The user provided name of the Tool. + tags: + - Tools (sql/v1) + security: + - resource-api-key: [] + responses: + '200': + description: A Tool has been deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + servers: + - url: https://flink.region.provider.confluent.cloud + description: Flink Compute Pool Endpoint + x-lifecycle-stage: Preview + x-self-access: true + x-request-access-name: SQL API v1 +components: + schemas: + sql.v1.ConnectionList: + type: object + description: |- + `Connection` models a reusable endpoint and auth token to authenticate the caller to + use that endpoint. + Only `OrgAdmins` and `EnvAdmins` will have the permissions to create, update and delete `Connections`. + `FlinkDevelopers` and `ModelResourceOwners` can later reference a `Connection` resource within their Model + creation statements. + The API allows you to list, create, read, and delete your connections. + ## The Connection Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - ConnectionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + self: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/connections + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Connection` models a reusable endpoint and auth token to authenticate the caller to + use that endpoint. + Only `OrganizationAdmins` and `EnvironmentAdmins` will have the permissions to create, update and delete `Connections`. + `FlinkDevelopers` and `ModelResourceOwners` can later reference a `Connection` resource within their Model + creation statements. + The API allows you to list, create, read, and delete your connections. + ## The Connections Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Connection + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: my-openai-connection + description: The user provided name of the resource, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ConnectionSpec' + status: + $ref: '#/components/schemas/sql.v1.ConnectionStatus' + required: + - api_version + - kind + - metadata + - spec + - status + - name + - organization_id + - environment_id + uniqueItems: true + sql.v1.Connection: + type: object + description: |- + `Connection` models a reusable endpoint and auth token to authenticate the caller to + use that endpoint. + Only `OrganizationAdmins` and `EnvironmentAdmins` will have the permissions to create, update and delete `Connections`. + `FlinkDevelopers` and `ModelResourceOwners` can later reference a `Connection` resource within their Model + creation statements. + The API allows you to list, create, read, and delete your connections. + ## The Connections Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Connection + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: my-openai-connection + description: The user provided name of the resource, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ConnectionSpec' + status: + $ref: '#/components/schemas/sql.v1.ConnectionStatus' + sql.v1.StatementResult: + type: object + description: |- + `Statement Result` represents a resource used to model results of SQL statements. + The API allows you to read your SQL statement result. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementResult + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements + next: + description: A URL that can be followed to get the next batch of results. + type: string + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + results: + type: object + description: A results property that contains a data property that contains an array of results. + properties: + data: + type: array + description: | + A data property that contains an array of results. Each entry in the array is a separate result. + + The value of `op` attribute (if present) represents the kind of change that a row can describe in a changelog: + + `0`: represents `INSERT` (`+I`), i.e. insertion operation; + + `1`: represents `UPDATE_BEFORE` (`-U`), i.e. update operation with the previous content of the updated row. + This kind should occur together with `UPDATE_AFTER` for modelling an update that needs to retract + the previous row first. It is useful in cases of a non-idempotent update, i.e., an update of a row that is not + uniquely identifiable by a key; + + `2`: represents `UPDATE_AFTER` (`+U`), i.e. update operation with new content of the updated row; + This kind CAN occur together with `UPDATE_BEFORE` for modelling an update that + needs to retract the previous row first or it describes an idempotent update, i.e., an + update of a row that is uniquely identifiable by a key; + + `3`: represents `DELETE` (`-D`), i.e. deletion operation; + + Defaults to `0`. + items: {} + example: + - op: 0 + row: + - '101' + - Jay + - - null + - abc + - - null + - '456' + - 1990-01-12 12:00.12 + - - - null + - Alice + - - '42' + - Bob + sql.v1.StatementList: + type: object + description: |- + `Statement` represents a core resource used to model SQL statements for execution. + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session + management or any higher-level functionality. + The API allows you to list, create, read, and delete your statements. + ## The Statements Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + self: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Statement` represents a core resource used to model SQL statements for execution. + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session + management or any higher-level functionality. + The API allows you to list, create, read, and delete your statements. + ## The Statements Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Statement + readOnly: true + metadata: + description: The metadata of the statement. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: A system generated globally unique identifier for this resource. + resource_version: + type: string + example: a23av + description: A system generated string that uniquely identifies the version of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + resource_name: + example: '' + readOnly: true + type: object + name: + type: string + example: sql123 + description: The user provided name of the resource, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + spec: + $ref: '#/components/schemas/sql.v1.StatementSpec' + status: + $ref: '#/components/schemas/sql.v1.StatementStatus' + result: + $ref: '#/components/schemas/sql.v1.StatementResult' + required: + - api_version + - kind + - metadata + - spec + - status + - name + - organization_id + - environment_id + uniqueItems: true + sql.v1.Statement: + type: object + description: |- + `Statement` represents a core resource used to model SQL statements for execution. + A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle session + management or any higher-level functionality. + The API allows you to list, create, read, and delete your statements. + ## The Statements Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Statement + readOnly: true + metadata: + description: The metadata of the statement. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: A system generated globally unique identifier for this resource. + resource_version: + type: string + example: a23av + description: A system generated string that uniquely identifies the version of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + resource_name: + example: '' + readOnly: true + type: object + name: + type: string + example: sql123 + description: The user provided name of the resource, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + x-immutable: true + maxLength: 100 + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + spec: + $ref: '#/components/schemas/sql.v1.StatementSpec' + status: + $ref: '#/components/schemas/sql.v1.StatementStatus' + result: + $ref: '#/components/schemas/sql.v1.StatementResult' + PatchRequest: + type: array + description: PatchRequest represent a json-patch request to be applied to the Statement. See https://tools.ietf.org/html/rfc6902 + items: + oneOf: + - $ref: '#/components/schemas/JsonPatchRequestAddReplace' + - $ref: '#/components/schemas/JsonPatchRequestRemove' + - $ref: '#/components/schemas/JsonPatchRequestMoveCopy' + sql.v1.StatementExceptionList: + type: object + description: |- + StatementExceptionList is a list of exceptions coming from FAILED or FAILING Statements created by + the SQL Statements API. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementExceptionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/sql123/exceptions + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + properties: + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementException + name: + type: string + description: Name of the SQL statement exception. + example: java.lang.RuntimeException + readOnly: true + message: + type: string + description: Error message of the statement exception. + example: 'java.lang.RuntimeException: An error occurred' + readOnly: true + timestamp: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: The date and time at which the exception occurred. It is represented in RFC3339 format and is in UTC. + readOnly: true + x-enable-objectmeta: true + sql.v1.MaterializedTableList: + type: object + description: A list of Materialized Table resources. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + readOnly: true + kind: + type: string + enum: + - MaterializedTableList + readOnly: true + metadata: + $ref: '#/components/schemas/ListMeta' + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTable' + uniqueItems: true + sql.v1.MaterializedTable: + type: object + description: Represents a Materialized Table resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - MaterializedTable + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: The user-provided name of the resource, unique within this environment. + pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$ + maxLength: 100 + example: high-value-orders + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.MaterializedTableSpec' + status: + readOnly: true + type: object + description: The status of the Materialized Table. + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - RUNNING + - COMPLETED + - DELETING + - FAILING + - FAILED + - CREATING + - ALTERING + - DEGRADED + - STOPPING + - STOPPED + description: The lifecycle phase of the materialized table. + example: RUNNING + detail: + type: string + description: Optional. Human-readable description of phase. + example: Materialized table is running. + warnings: + type: array + description: List of warnings encountered during materialized table execution. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTableWarning' + creation_statement: + type: string + description: Entire Materialized Table statement as submitted by user e.g CREATE OR ALTER MATERIALIZED TABLE ... + example: CREATE OR ALTER MATERIALIZED TABLE high-value-orders AS SELECT user_id, product_id, price, quantity FROM orders WHERE price > 1000; + scaling_status: + $ref: '#/components/schemas/sql.v1.ScalingStatus' + version: + type: integer + format: int32 + minimum: 1 + description: Represents the evolution history of the Materialized Table. The current value indicates the latest version. + example: 3 + latest_version: + type: integer + format: int32 + minimum: 1 + description: Represents the latest submitted version of the Materialized Table. When a query evolution is accepted, `latest_version` is incremented immediately and will be greater than `version` until the new query is fully activated. + example: 4 + sql.v1.MaterializedTableVersionList: + type: object + description: A list of Materialized Table Version resources. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + readOnly: true + kind: + type: string + enum: + - MaterializedTableVersionList + readOnly: true + metadata: + $ref: '#/components/schemas/ListMeta' + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTableVersion' + uniqueItems: true + sql.v1.MaterializedTableVersion: + type: object + description: Represents a specific version of a Materialized Table resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - MaterializedTableVersion + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + name: + type: string + description: | + The resource version name, unique within the Kafka cluster. + Name conforms to DNS Subdomain (RFC 1123). + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + maxLength: 100 + example: mt-123-v4 + readOnly: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.MaterializedTableVersionSpec' + sql.v1.AgentList: + type: object + description: A list of Agent resources. + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + readOnly: true + kind: + type: string + enum: + - AgentList + readOnly: true + metadata: + $ref: '#/components/schemas/ListMeta' + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + $ref: '#/components/schemas/sql.v1.Agent' + uniqueItems: true + sql.v1.Agent: + type: object + description: Represents an Agent resource. + required: + - api_version + - kind + - metadata + - name + - organization_id + - environment_id + - spec + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Agent + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + labels: + type: object + additionalProperties: + type: string + readOnly: true + type: object + name: + type: string + description: The user-provided name of the agent, unique within this environment. + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + maxLength: 100 + example: chat-listener-agent + x-immutable: true + organization_id: + type: string + format: uuid + description: The unique identifier for the organization. + x-immutable: true + readOnly: true + environment_id: + type: string + description: The unique identifier for the environment. + x-immutable: true + readOnly: true + spec: + $ref: '#/components/schemas/sql.v1.AgentSpec' + status: + readOnly: true + type: object + description: The status of the Agent. + properties: + phase: + type: string + x-extensible-enum: + - READY + - RUNNING + description: | + Describes the status of the agent: + + READY: The Agent is created; + + RUNNING: The Agent is created and running in a query; + example: RUNNING + sql.v1.Tool: + type: object + description: |- + `Tool` models a reusable tool resource backed by a connection that can be referenced + by agents to perform actions. + The API allows you to create your tools. + ## The Tools Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Tool + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: linear-mcp-tool + description: The user provided name of the tool, unique within this environment. + pattern: '[a-z0-9_]([-a-z0-9_]*[a-z0-9_])?' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ToolSpec' + status: + $ref: '#/components/schemas/sql.v1.ToolStatus' + sql.v1.ToolList: + type: object + description: |- + `Tool` models a reusable tool resource backed by a connection that can be referenced + by agents to perform actions. + The API allows you to create your tools. + ## The Tool Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - ToolList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + self: + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/organizations/org-abc/environments/env-123/databases/my-database/tools + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Tool` models a reusable tool resource backed by a connection that can be referenced + by agents to perform actions. + The API allows you to create your tools. + ## The Tools Model + + properties: + api_version: + type: string + enum: + - sql/v1 + description: APIVersion defines the schema version of this representation of a resource. + example: sql/v1 + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - Tool + readOnly: true + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + uid: + example: 12345678-1234-1234-1234-123456789012 + resource_version: + example: a23av + readOnly: true + type: object + name: + type: string + example: linear-mcp-tool + description: The user provided name of the tool, unique within this environment. + pattern: '[a-z0-9_]([-a-z0-9_]*[a-z0-9_])?' + x-immutable: true + maxLength: 100 + spec: + $ref: '#/components/schemas/sql.v1.ToolSpec' + status: + $ref: '#/components/schemas/sql.v1.ToolStatus' + required: + - api_version + - kind + - metadata + - name + - spec + - status + - organization_id + - environment_id + uniqueItems: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + sql.v1.ConnectionSpec: + type: object + description: Encapsulates the model provider access details + properties: + connection_type: + type: string + example: OPENAI + description: The type of this connection. + x-immutable: true + x-extensible-enum: + - AZUREML + - AZUREOPENAI + - A2A + - ANTHROPIC + - BEDROCK + - CONFLUENT_JDBC + - COSMOSDB + - COUCHBASE + - ELASTIC + - FIREWORKSAI + - GOOGLEAI + - MCP_SERVER + - MONGODB + - OPENAI + - PINECONE + - REST + - S3VECTORS + - SAGEMAKER + - VERTEXAI + endpoint: + type: string + example: https://api.openai.com/v1/chat/completions + description: The endpoint that is used to run model inferencing. + maxLength: 16384 + x-immutable: true + auth_data: + type: object + description: | + The vendor specific authentication token details + + The contents are stored as opaque bytes given in plaintext by an EnvAdmin. + In future, we would support more secure methods for distributing authentication tokens. + discriminator: + propertyName: kind + mapping: + PlaintextProvider: '#/components/schemas/sql.v1.PlaintextProvider' + x-immutable: false + properties: + kind: + description: | + Plaintext Provider Kind Type + type: string + enum: + - PlaintextProvider + x-immutable: true + data: + description: | + Authentication token in plaintext JSON string. + For composite tokens, provide them as JSON. + This is sensitive piece of information stored as opaque bytes in an encrypted form with single level of encryption. + + Scoped to an endpoint of a `Connection` resource. + type: string + format: byte + x-enable-listmeta: true + x-enable-objectmeta: true + sql.v1.ConnectionStatus: + type: object + required: + - phase + description: The status of the Connection + properties: + phase: + type: string + x-extensible-enum: + - ACTIVE + - UNREACHABLE + - INVALID_AUTH + description: | + Describes the status of the connection: + + READY: The Connection is usable; + + UNREACHABLE: The Connection endpoint is unreachable; + + INVALID_AUTH: The Connection auth token is invalid; + example: READY + readOnly: true + detail: + type: string + description: Details about why connection transitioned into a given status. + example: 'Lookup failed: ai.openai.com' + readOnly: true + readOnly: true + ResultListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements + next: + description: A URL that can be followed to get the next batch of results. + type: string + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-abc123/statements?page_token=UvmDWOB1iwfAIBPj6EYb + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + sql.v1.StatementResultResults: + type: object + description: A results property that contains a data property that contains an array of results. + properties: + data: + type: array + description: | + A data property that contains an array of results. Each entry in the array is a separate result. + + The value of `op` attribute (if present) represents the kind of change that a row can describe in a changelog: + + `0`: represents `INSERT` (`+I`), i.e. insertion operation; + + `1`: represents `UPDATE_BEFORE` (`-U`), i.e. update operation with the previous content of the updated row. + This kind should occur together with `UPDATE_AFTER` for modelling an update that needs to retract + the previous row first. It is useful in cases of a non-idempotent update, i.e., an update of a row that is not + uniquely identifiable by a key; + + `2`: represents `UPDATE_AFTER` (`+U`), i.e. update operation with new content of the updated row; + This kind CAN occur together with `UPDATE_BEFORE` for modelling an update that + needs to retract the previous row first or it describes an idempotent update, i.e., an + update of a row that is uniquely identifiable by a key; + + `3`: represents `DELETE` (`-D`), i.e. deletion operation; + + Defaults to `0`. + items: {} + example: + - op: 0 + row: + - '101' + - Jay + - - null + - abc + - - null + - '456' + - 1990-01-12 12:00.12 + - - - null + - Alice + - - '42' + - Bob + StatementObjectMeta: + description: The metadata of the statement. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/my-statement + created_at: + type: string + format: date-time + example: '1996-03-19T01:02:03-04:05' + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + uid: + type: string + example: 12345678-1234-1234-1234-123456789012 + description: A system generated globally unique identifier for this resource. + resource_version: + type: string + example: a23av + description: A system generated string that uniquely identifies the version of this resource. + labels: + type: object + description: A map of key-value pairs that describe the resource. + additionalProperties: + type: string + example: + user.confluent.io/hidden: 'true' + readOnly: true + type: object + sql.v1.StatementSpec: + type: object + description: The specs of the Statement + properties: + statement: + type: string + example: SELECT * FROM TABLE WHERE VALUE1 = VALUE2; + description: The raw SQL text statement. + x-immutable: true + maxLength: 131072 + properties: + type: object + example: + sql.current-catalog: my_environment + sql.current-database: my_kafka_cluster + description: A map (key-value pairs) of statement properties. + additionalProperties: + type: string + maxProperties: 8192 + compute_pool_id: + type: string + example: fcp-00000 + description: |- + The id associated with the compute pool in context. + If not specified, the statement will use the default compute pool. The default pool is automatically determined by the system. + maxLength: 255 + principal: + type: string + example: sa-abc123 + description: The id of a principal this statement runs as. + maxLength: 255 + x-immutable: true + stopped: + type: boolean + description: Indicates whether the statement should be stopped. + example: false + execution_mode: + type: string + example: streaming + description: | + The execution mode of the statement. + + Note - The attribute is in a [Early Access lifecycle](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + maxLength: 255 + readOnly: true + x-enable-listmeta: true + x-enable-objectmeta: true + sql.v1.StatementStatus: + type: object + required: + - phase + description: The status of the Statement + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - RUNNING + - COMPLETED + - DELETING + - FAILING + - FAILED + - STOPPING + - STOPPED + - DEGRADED + description: | + The lifecycle phase of the submitted SQL statement: + + PENDING: SQL statement is pending execution; + + RUNNING: SQL statement execution is in progress; + + COMPLETED: SQL statement is completed; + + DELETING: SQL statement deletion is in progress; + + FAILING: SQL statement is failing; + + FAILED: SQL statement execution has failed; + + STOPPING: SQL statement is being stopped; + + STOPPED: SQL statement execution has successfully been stopped; + + DEGRADED: SQL statement is experiencing reduced performance or partial failure; + example: RUNNING + readOnly: true + scaling_status: + $ref: '#/components/schemas/sql.v1.ScalingStatus' + state_limit_status: + $ref: '#/components/schemas/sql.v1.StateLimitStatus' + detail: + type: string + description: Details about the execution status of this statement. + example: Statement is running successfully + readOnly: true + warnings: + type: array + description: List of warnings encountered during statement execution. + items: + $ref: '#/components/schemas/sql.v1.StatementWarning' + readOnly: true + traits: + $ref: '#/components/schemas/sql.v1.StatementTraits' + network_kind: + type: string + x-extensible-enum: + - PUBLIC + - PRIVATE + description: | + The networking type used by the submitted SQL statement: + + PUBLIC: SQL statement is using public networking; + + PRIVATE: SQL statement is using private networking; + example: PUBLIC + readOnly: true + latest_offsets: + type: object + additionalProperties: + type: string + description: | + The last Kafka offsets that a statement has processed. Represented by a mapping from Kafka topic to a + string representation of partitions mapped to offsets. + example: + topic-1: partition:0,offset:100;partition:1,offset:200 + topic-2: partition:0,offset:50 + readOnly: true + latest_offsets_timestamp: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: The date and time at which the Kafka topic offsets were added to the statement status. It is represented in RFC3339 format and is in UTC. + readOnly: true + end_time: + type: string + format: date-time + example: '2025-03-19T01:02:03-04:05' + description: | + The date and time in UTC (represented as RFC3339 format) at which the statement reached its final terminal state. + This field is set when the Phase is COMPLETED, FAILED, or STOPPED. + + Note - The attribute is in a [Early Access lifecycle](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + duration: + type: string + format: duration + example: PT2H30M + description: | + The total elapsed time (represented as ISO 8601 format) from when the statement transitioned from + PENDING to RUNNING until it reached a final terminal state. This field is calculated and set when + the Phase is COMPLETED, FAILED, or STOPPED. + + Note - The attribute is in a [Early Access lifecycle](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + affected_resource: + type: object + description: | + A reference to the resource created by this statement, if any. This field is set when a statement + (e.g., CREATE MATERIALIZED TABLE) results in a new user-facing resource. + + Note - The attribute is in a [Early Access lifecycle](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) + required: + - kind + - environment_id + - resource_name + properties: + kind: + type: string + x-extensible-enum: + - MATERIALIZED_TABLE + description: The kind of resource that was created. + example: MATERIALIZED_TABLE + environment_id: + type: string + description: The unique identifier for the environment containing the resource. + example: env-abc + database_id: + type: string + description: | + The unique identifier for the database containing the resource. + Only present for resource kinds that are scoped to a database. + example: lkc-123 + resource_name: + type: string + description: The name of the created resource, unique within its scope. + example: my-materialized-table + readOnly: true + JsonPatchRequestAddReplace: + type: object + description: This option is used to add or replace a value for a field + additionalProperties: false + required: + - value + - op + - path + properties: + path: + description: A JSON Pointer path. + type: string + value: + description: The value to add, replace or test. + op: + description: The operation to perform. + type: string + enum: + - ADD + - REPLACE + - TEST + JsonPatchRequestRemove: + type: object + description: This option is used to remove a field + additionalProperties: false + required: + - op + - path + properties: + path: + description: A JSON Pointer path. + type: string + op: + description: The operation to perform. + type: string + enum: + - REMOVE + JsonPatchRequestMoveCopy: + type: object + description: This option is used to move or copy a field + additionalProperties: false + required: + - from + - op + - path + properties: + path: + description: A JSON Pointer path. + type: string + op: + description: The operation to perform. + type: string + enum: + - MOVE + - COPY + from: + description: A JSON Pointer path. + type: string + ExceptionListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + example: https://flink.us-west1.aws.confluent.cloud/sql/v1/environments/env-123/statements/sql123/exceptions + sql.v1.StatementException: + type: object + properties: + kind: + type: string + description: Kind defines the object this REST resource represents. + enum: + - StatementException + name: + type: string + description: Name of the SQL statement exception. + example: java.lang.RuntimeException + readOnly: true + message: + type: string + description: Error message of the statement exception. + example: 'java.lang.RuntimeException: An error occurred' + readOnly: true + timestamp: + type: string + format: date-time + example: '2025-11-10T16:20:00Z' + description: The date and time at which the exception occurred. It is represented in RFC3339 format and is in UTC. + readOnly: true + x-enable-objectmeta: true + sql.v1.MaterializedTableSpec: + type: object + description: The specifications of the Materialized Table. + properties: + kafka_cluster_id: + type: string + description: |- + The ID of the Kafka cluster hosting the Materialized Table's topic. + This value must match the `kafka_cluster_id` path parameter. + It is immutable after creation and is ignored or rejected on update if changed. + example: lkc-12345 + x-immutable: true + compute_pool_id: + type: string + description: |- + The id associated with the compute pool in context. + If not specified, the materialized table will use the default compute pool. The default pool is automatically determined by the system. + example: lfcp-123 + principal: + type: string + description: The id of a principal this Materialized Table query runs as. + example: sa-abc123 + maxLength: 255 + stopped: + type: boolean + description: Indicates whether the Materialized Table query should be stopped. + example: false + table_options: + type: object + description: Defines configuration properties for the table, equivalent to the SQL 'WITH' clause + additionalProperties: + type: string + maxProperties: 8192 + session_options: + type: object + description: Session configurations equivalent to the SQL 'SET' statement. Only applicable on creation; ignored on update. + additionalProperties: + type: string + maxProperties: 8192 + x-immutable: true + columns: + type: array + description: Details of each column in Materialized Table resource. If columns are not specified, we infer from query. If it's specified it must be compatible with the types in the query. + items: + $ref: '#/components/schemas/sql.v1.ColumnDetails' + watermark: + $ref: '#/components/schemas/sql.v1.Watermark' + constraints: + type: array + description: Specify table constraints. + items: + $ref: '#/components/schemas/sql.v1.Constraint' + distribution: + description: Only applicable on creation; ignored on update. + x-immutable: true + type: object + properties: + kind: + type: string + x-extensible-enum: + - HASH + description: The kind of distribution. + example: HASH + keys: + type: array + items: + type: string + example: + - user_id + bucket_count: + type: integer + format: int32 + minimum: 1 + default: 6 + description: The number of buckets. + example: 12 + query: + type: string + description: Contains the query section (usually starting with a SELECT) of the latest Materialized Table. + example: SELECT user_id, product_id, price, quantity FROM orders WHERE price > 1000; + maxLength: 131072 + sql.v1.MaterializedTableStatus: + type: object + description: The status of the Materialized Table. + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - RUNNING + - COMPLETED + - DELETING + - FAILING + - FAILED + - CREATING + - ALTERING + - DEGRADED + - STOPPING + - STOPPED + description: The lifecycle phase of the materialized table. + example: RUNNING + detail: + type: string + description: Optional. Human-readable description of phase. + example: Materialized table is running. + warnings: + type: array + description: List of warnings encountered during materialized table execution. + items: + $ref: '#/components/schemas/sql.v1.MaterializedTableWarning' + creation_statement: + type: string + description: Entire Materialized Table statement as submitted by user e.g CREATE OR ALTER MATERIALIZED TABLE ... + example: CREATE OR ALTER MATERIALIZED TABLE high-value-orders AS SELECT user_id, product_id, price, quantity FROM orders WHERE price > 1000; + scaling_status: + $ref: '#/components/schemas/sql.v1.ScalingStatus' + version: + type: integer + format: int32 + minimum: 1 + description: Represents the evolution history of the Materialized Table. The current value indicates the latest version. + example: 3 + latest_version: + type: integer + format: int32 + minimum: 1 + description: Represents the latest submitted version of the Materialized Table. When a query evolution is accepted, `latest_version` is incremented immediately and will be greater than `version` until the new query is fully activated. + example: 4 + sql.v1.MaterializedTableVersionSpec: + type: object + description: The specifications of the Materialized Table Version. + required: + - version + - statement + properties: + version: + type: integer + format: int32 + minimum: 1 + description: The version number of the Materialized Table. + example: 4 + readOnly: true + statement: + type: string + description: | + The full SQL statement for the materialized table as generated by SHOW CREATE MATERIALIZED TABLE at the time of the evolution. + example: CREATE OR ALTER MATERIALIZED TABLE orders AS SELECT user_id, product_id, price FROM orders; + readOnly: true + maxLength: 131072 + changes: + type: array + description: Changes affecting resources since the previous version. + items: + $ref: '#/components/schemas/sql.v1.ResourceChange' + readOnly: true + sql.v1.AgentSpec: + type: object + description: The specifications of the Agent. + properties: + description: + type: string + example: An agent that listens to chat messages and creates issues + description: The description of the agent. + model: + type: string + example: chat_listener + description: The name of the model the agent uses for inferencing. + prompt: + type: string + example: Create an issue from the content using bebb0fa3-e084-412d-a000-b02280558318 as the team ID + description: The instruction prompt that guides the agent's behavior. + maxLength: 65536 + tools: + type: array + description: The list of tools available to the agent. + items: + type: string + example: + - linear-mcp-tool + properties: + type: object + description: A set of key-value option pairs that configure the agent's behavior. + additionalProperties: + type: string + example: + max_iterations: '5' + sql.v1.AgentStatus: + type: object + description: The status of the Agent. + properties: + phase: + type: string + x-extensible-enum: + - READY + - RUNNING + description: | + Describes the status of the agent: + + READY: The Agent is created; + + RUNNING: The Agent is created and running in a query; + example: RUNNING + sql.v1.ToolSpec: + type: object + description: |- + The spec of the Tool. A tool must reference either a `connection` (for MCP or A2A tools) + or a `function` (for function-based tools), but not both. + properties: + connection: + type: string + example: linear-mcp-connection-streamable + description: The name of the connection this tool uses. Required for MCP and A2A tools. Mutually exclusive with function. + function: + type: string + example: convert_to_celsius + description: The name of the function this tool wraps. Required for function-based tools. Mutually exclusive with connection. + comment: + type: string + description: An optional comment describing the tool. + maxLength: 4096 + options: + type: object + description: |- + A set of key-value option pairs that configure the tool's behavior. + Supported options vary by tool type: + - MCP tools: type, allowed_tools, request_timeout, max_retries, headers + - A2A tools: type, agent_card_path, request_timeout, max_retries + - Function tools: type, description + additionalProperties: + type: string + example: + type: mcp + allowed_tools: create_issue, list_issues + request_timeout: '30' + x-enable-listmeta: true + x-enable-objectmeta: true + sql.v1.ToolStatus: + type: object + required: + - phase + description: The status of the Tool + properties: + phase: + type: string + x-extensible-enum: + - ACTIVE + - INACTIVE + - ERROR + description: | + Describes the status of the tool: + + ACTIVE: The Tool is usable; + + INACTIVE: The Tool is not currently active; + + ERROR: The Tool encountered an error; + example: ACTIVE + readOnly: true + detail: + type: string + description: Details about why the tool transitioned into a given status. + example: Tool is ready + readOnly: true + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + sql.v1.PlaintextProvider: + type: object + description: | + Describes a sensitive piece of information passed in plaintext. + + Confluent only accepts authentication tokens of supported model providers from OrgAdmins and EnvAdmins. + For now, only 'PlainText' provider is supported. It stores authentication token details as opaque bytes in an encrypted form. + This option offers limited security as it only provides a single level of encryption. + properties: + kind: + description: | + Plaintext Provider Kind Type + type: string + enum: + - PlaintextProvider + x-immutable: true + data: + description: | + Authentication token in plaintext JSON string. + For composite tokens, provide them as JSON. + This is sensitive piece of information stored as opaque bytes in an encrypted form with single level of encryption. + + Scoped to an endpoint of a `Connection` resource. + type: string + format: byte + sql.v1.ScalingStatus: + description: Scaling status for this statement. + type: object + properties: + scaling_state: + description: | + OK: The statement runs at the right scale. + + PENDING_SCALE_DOWN: The statement requires less resources, and will be scaled down in the near future. + + PENDING_SCALE_UP: The statement requires more resources, and will be scaled up in the near future. + + POOL_EXHAUSTED: The statement requires more resources, but not enough resources are available. + example: OK + readOnly: true + type: string + x-extensible-enum: + - OK + - PENDING_SCALE_DOWN + - PENDING_SCALE_UP + - POOL_EXHAUSTED + last_updated: + description: The last time the scaling status was updated. + example: '1996-03-19T05:07:03.000Z' + format: date-time + readOnly: true + type: string + readOnly: true + sql.v1.StateLimitStatus: + description: State limit status for this statement. + properties: + state_limit_state: + description: | + OK: The statement is within state limits. + + APPROACHING_SOFT_LIMIT: The statement is approaching soft state limits. + + EXCEEDING_SOFT_LIMIT: The statement is exceeding soft state limits. + + APPROACHING_HARD_LIMIT: The statement is approaching hard state limits. + + EXCEEDING_HARD_LIMIT: The statement is exceeding hard state limits. + example: OK + readOnly: true + type: string + x-extensible-enum: + - OK + - APPROACHING_SOFT_LIMIT + - EXCEEDING_SOFT_LIMIT + - APPROACHING_HARD_LIMIT + - EXCEEDING_HARD_LIMIT + last_updated: + description: The last time the state limit status was updated. + example: '1996-03-19T05:07:03.000Z' + format: date-time + readOnly: true + type: string + detail: + description: Details about why state limit status is in its current state. + example: The statement is within state limits. + type: string + readOnly: true + readOnly: true + type: object + sql.v1.StatementWarning: + type: object + description: Represents a non-fatal issue encountered during statement processing. + required: + - severity + - created_at + - reason + - message + properties: + severity: + $ref: '#/components/schemas/sql.v1.WarningSeverity' + created_at: + type: string + format: date-time + description: The timestamp when the warning was created. It is represented in RFC3339 format and is in UTC. + example: '2025-11-10T16:20:00Z' + readOnly: true + reason: + type: string + description: A machine-readable short, upper case summary delimited by underscore. + example: MISSING_WINDOW_START_END + message: + type: string + description: A human-readable string containing the description of the warning. + example: The statement is missing window start and end bounds which may lead to unbounded state growth. + sql.v1.StatementTraits: + type: object + description: StatementTraits contains detailed information about the properties of a Statement + properties: + sql_kind: + type: string + description: Categorizes the SQL statement. The result is Confluent-specific but inspired by SQL. It uses underscores for separating concepts e.g. "CREATE_TABLE". + example: SELECT + is_bounded: + type: boolean + description: Indicates the special case where results of a statement are bounded. + is_append_only: + type: boolean + description: Indicates the special case where results of a statement are insert/append only. + upsert_columns: + type: array + description: Defines the column indices clients can use as upsert keys. + items: + type: integer + schema: + $ref: '#/components/schemas/sql.v1.ResultSchema' + connection_refs: + type: array + description: The names of connections that the SQL statement references (e.g., in FROM clauses). + items: + type: string + example: + - my-postgres-connection + - my-kafka-connection + readOnly: true + sql.v1.ColumnDetails: + type: object + description: Details of a column in the Materialized Table. + discriminator: + propertyName: kind + mapping: + Physical: '#/components/schemas/sql.v1.PhysicalColumn' + Metadata: '#/components/schemas/sql.v1.MetadataColumn' + Computed: '#/components/schemas/sql.v1.ComputedColumn' + required: + - name + - type + - kind + - metadata_key + - expression + properties: + name: + type: string + description: The name of the column. + type: + $ref: '#/components/schemas/DataType' + comment: + type: string + description: A comment or description for the column. + kind: + type: string + description: The kind of column. + enum: + - Physical + example: Physical + metadata_key: + type: string + description: The system metadata key to reference. + example: offset + virtual: + type: boolean + description: Indicates if the metadata column is virtual. + default: false + example: true + expression: + type: string + description: The SQL expression used to compute the column value. + example: quantity * price + sql.v1.Watermark: + type: object + description: Watermark strategy for the Materialized Table resource. + properties: + column: + type: string + example: event_timestamp + expression: + type: string + example: event_timestamp - INTERVAL '5' SECOND + sql.v1.Constraint: + type: object + description: A constraint on the materialized table. + properties: + name: + type: string + example: pk_orders + type: + type: string + x-extensible-enum: + - PRIMARY_KEY + description: The type of constraint. + example: PRIMARY_KEY + columns: + type: array + items: + type: string + example: + - user_id + - product_id + enforced: + type: boolean + description: Whether the constraint is enforced. + default: false + sql.v1.Distribution: + type: object + description: Distribution (bucket by) strategy. + properties: + kind: + type: string + x-extensible-enum: + - HASH + description: The kind of distribution. + example: HASH + keys: + type: array + items: + type: string + example: + - user_id + bucket_count: + type: integer + format: int32 + minimum: 1 + default: 6 + description: The number of buckets. + example: 12 + sql.v1.MaterializedTableWarning: + type: object + description: Represents a non-fatal issue encountered during materialized table processing. + required: + - severity + - created_at + - reason + - message + properties: + severity: + $ref: '#/components/schemas/sql.v1.WarningSeverity' + created_at: + type: string + format: date-time + description: The timestamp when the warning was created. It is represented in RFC3339 format and is in UTC. + example: '2025-11-10T16:20:00Z' + readOnly: true + reason: + type: string + description: A machine-readable short, upper case summary delimited by underscore. + example: MISSING_WINDOW_START_END + message: + type: string + description: A human-readable string containing the description of the warning. + example: The statement is missing window start and end bounds which may lead to unbounded state growth. + sql.v1.ResourceChange: + type: object + description: Details of a change to a specific resource. + required: + - kind + - environment_locator + - database_locator + - name + - details + properties: + kind: + type: string + x-extensible-enum: + - MATERIALIZED_TABLE + - TABLE + - VIEW + - FUNCTION + description: The type of resource that was changed. + example: MATERIALIZED_TABLE + environment_locator: + type: string + description: The environment containing the resource. Can be either the environment name or ID, depending on how it is referenced in the SQL statement text. + example: env-abc + database_locator: + type: string + description: The database containing the resource. Can be either the database name or ID, depending on how it is referenced in the SQL statement text. + example: lkc-123 + name: + type: string + description: The name of the resource, unique within its scope (environment and database). + example: orders + details: + type: array + description: Human-readable descriptions of the changes made to this resource. + items: + type: string + example: + - 'Column ''product_name: VARCHAR'' added' + - 'Column ''product_id: BIGINT'' added' + readOnly: true + sql.v1.WarningSeverity: + type: string + x-extensible-enum: + - LOW + - MODERATE + - CRITICAL + description: | + Indicates the severity of the warning. + + LOW: Indicates a low severity warning and for informing the user. + + MODERATE: Indicates a moderate severity warning and may require user action. Could cause degraded statements if certain conditions apply. + + CRITICAL: Indicates a critical severity warning and requires user action. It will cause degraded statements eventually. + example: MODERATE + sql.v1.ResultSchema: + type: object + description: The table columns of the results schema. + properties: + columns: + type: array + description: The properties of each SQL column in the schema. + items: + $ref: '#/components/schemas/ColumnDetails' + sql.v1.PhysicalColumn: + description: Physical columns define the structure of the table and the data types of its fields. + type: object + required: + - name + - type + - kind + properties: + name: + type: string + description: The name of the column. + type: + $ref: '#/components/schemas/DataType' + comment: + type: string + description: A comment or description for the column. + kind: + type: string + description: The kind of column. + enum: + - Physical + example: Physical + sql.v1.MetadataColumn: + description: Metadata columns reference system properties. + type: object + required: + - name + - type + - kind + - metadata_key + properties: + name: + type: string + description: The name of the column. + type: + $ref: '#/components/schemas/DataType' + comment: + type: string + description: A comment or description for the column. + kind: + type: string + description: The kind of column. + enum: + - Metadata + example: Metadata + metadata_key: + type: string + description: The system metadata key to reference. + example: offset + virtual: + type: boolean + description: Indicates if the metadata column is virtual. + default: false + example: true + sql.v1.ComputedColumn: + description: Computed columns are generated via an expression. + type: object + required: + - name + - type + - kind + - expression + properties: + name: + type: string + description: The name of the column. + type: + $ref: '#/components/schemas/DataType' + comment: + type: string + description: A comment or description for the column. + kind: + type: string + description: The kind of column. + enum: + - Computed + example: Computed + expression: + type: string + description: The SQL expression used to compute the column value. + example: quantity * price + virtual: + type: boolean + description: Indicates if the computed column is virtual. + default: false + example: true + ColumnDetails: + type: object + description: A column in the results schema. + required: + - name + - type + properties: + name: + type: string + description: The name of the SQL table column. + example: Column_Name + type: + description: JSON object in TableSchema format; describes the data returned by the results serving API. + example: + type: CHAR + nullable: true + length: 8 + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + sql.v1.ColumnCommon: + type: object + required: + - name + - type + properties: + name: + type: string + description: The name of the column. + type: + $ref: '#/components/schemas/DataType' + comment: + type: string + description: A comment or description for the column. + DataType: + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + element_type: + description: The type of the element in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + RowFieldType: + type: object + properties: + name: + type: string + description: The name of the field. + field_type: + description: The data type of the field. + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + element_type: + description: The type of the element in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + type: object + properties: + type: + type: string + description: The data type of the column. + nullable: + type: boolean + description: Indicates whether values in this column can be null. + length: + type: integer + format: int32 + description: The length of the data type. + precision: + type: integer + format: int32 + description: The precision of the data type. + scale: + type: integer + format: int32 + description: The scale of the data type. + key_type: + description: The type of the key in the data type (if applicable). + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + value_type: + description: The type of the value in the data type (if applicable). + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + element_type: + description: The type of the element in the data type (if applicable). + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + fields: + type: array + items: + $ref: '#/components/schemas/RowFieldType' + description: The fields of the element in the data type (if applicable). + resolution: + type: string + description: The resolution of the data type (if applicable). + fractional_precision: + type: integer + format: int32 + description: The fractional precision of the data type (if applicable). + class_name: + type: string + description: The class name of the structured data type (if applicable). + required: + - type + - nullable + description: + type: string + description: The description of the field. + required: + - name + - field_type + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/stream_sharing.yaml b/provider-dev/source/stream_sharing.yaml new file mode 100644 index 0000000..fb70dec --- /dev/null +++ b/provider-dev/source/stream_sharing.yaml @@ -0,0 +1,6514 @@ +openapi: 3.0.0 +info: + title: stream_sharing API + description: confluent stream_sharing API + version: 1.0.0 +paths: + /cdx/v1/provider-shared-resources: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCdxV1ProviderSharedResources + summary: List of Provider Shared Resources + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all provider shared resources. + parameters: + - name: stream_share + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: ss-1234 + description: Filter the results by exact match for stream_share. + - name: crn + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + description: Filter the results by exact match for crn. + - name: include_deleted + in: query + required: false + schema: + $ref: '#/components/schemas/BooleanFilter' + description: Include deactivated shared resources + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Provider Shared Resource. + content: + application/json: + schema: + type: object + description: |- + `ProviderSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you have shared through Stream Sharing. + + + ## The Provider Shared Resources Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderSharedResourceList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ProviderSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you have shared through Stream Sharing. + + + ## The Provider Shared Resources Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderSharedResource + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + crn: + type: string + description: Deprecated please use resources attribute. + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic + x-immutable: true + resources: + type: array + minItems: 1 + description: List of resource crns that are shared together + items: + type: string + description: crn that specifies the shared resource + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + display_name: + type: string + description: Shared resource display name + example: Stock Trades + description: + type: string + description: Description of shared resource + example: This topic provides realtime data for the orders placed through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: List of schemas in JSON format. This field is work in progress and subject to changes. + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of contact person from the organization + logo_url: + type: string + format: uri + description: Resource logo url + example: https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo + readOnly: true + organization_name: + description: Organization to which the shared resource belongs. Deprecated + example: ABC Corp + x-immutable: true + readOnly: true + environment_name: + type: string + description: The environment name of the shared resource. Deprecated + example: Public Env + x-immutable: true + readOnly: true + cluster_name: + type: string + description: The cluster display name of the shared resource. Deprecated + example: Published Trades + x-immutable: true + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - display_name + - organization_name + - environment_name + - cluster_name + - cloud_cluster + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/provider-shared-resources/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCdxV1ProviderSharedResource + summary: Read a Provider Shared Resource + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a provider shared resource. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider shared resource. + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Provider Shared Resource. + content: + application/json: + schema: + type: object + description: |- + `ProviderSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you have shared through Stream Sharing. + + + ## The Provider Shared Resources Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderSharedResource + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + crn: + type: string + description: Deprecated please use resources attribute. + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic + x-immutable: true + resources: + type: array + minItems: 1 + description: List of resource crns that are shared together + items: + type: string + description: crn that specifies the shared resource + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + display_name: + type: string + description: Shared resource display name + example: Stock Trades + description: + type: string + description: Description of shared resource + example: This topic provides realtime data for the orders placed through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: List of schemas in JSON format. This field is work in progress and subject to changes. + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of contact person from the organization + logo_url: + type: string + format: uri + description: Resource logo url + example: https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo + readOnly: true + organization_name: + description: Organization to which the shared resource belongs. Deprecated + example: ABC Corp + x-immutable: true + readOnly: true + environment_name: + type: string + description: The environment name of the shared resource. Deprecated + example: Public Env + x-immutable: true + readOnly: true + cluster_name: + type: string + description: The cluster display name of the shared resource. Deprecated + example: Published Trades + x-immutable: true + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - display_name + - organization_name + - environment_name + - cluster_name + - cloud_cluster + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateCdxV1ProviderSharedResource + summary: Update a Provider Shared Resource + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a provider shared resource. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider shared resource. + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cdx.v1.ProviderSharedResource' + responses: + '200': + description: Provider Shared Resource. + content: + application/json: + schema: + type: object + description: |- + `ProviderSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you have shared through Stream Sharing. + + + ## The Provider Shared Resources Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderSharedResource + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + crn: + type: string + description: Deprecated please use resources attribute. + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic + x-immutable: true + resources: + type: array + minItems: 1 + description: List of resource crns that are shared together + items: + type: string + description: crn that specifies the shared resource + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + display_name: + type: string + description: Shared resource display name + example: Stock Trades + description: + type: string + description: Description of shared resource + example: This topic provides realtime data for the orders placed through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: List of schemas in JSON format. This field is work in progress and subject to changes. + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of contact person from the organization + logo_url: + type: string + format: uri + description: Resource logo url + example: https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo + readOnly: true + organization_name: + description: Organization to which the shared resource belongs. Deprecated + example: ABC Corp + x-immutable: true + readOnly: true + environment_name: + type: string + description: The environment name of the shared resource. Deprecated + example: Public Env + x-immutable: true + readOnly: true + cluster_name: + type: string + description: The cluster display name of the shared resource. Deprecated + example: Published Trades + x-immutable: true + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - display_name + - organization_name + - environment_name + - cluster_name + - cloud_cluster + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/provider-shared-resources/{id}/images/{file_name}: + post: + summary: Upload image for shared resource + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Upload the image file for the shared resource + requestBody: + content: + image/*: + schema: + type: string + format: base64 + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ProviderSharedResource + operationId: upload_imageCdxV1ProviderSharedResource + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider shared resource. + - name: file_name + in: path + required: true + schema: + type: string + description: The File Name + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '201': + description: image uploaded + headers: + Location: + schema: + type: string + format: uri + example: https://some-subdomain.confluent.cloud/path/to/resource + description: A URL that allows access to the image file + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + get: + summary: Get image for shared resource + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Returns the image file for the shared resource + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ProviderSharedResource + operationId: view_imageCdxV1ProviderSharedResource + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider shared resource. + - name: file_name + in: path + required: true + schema: + type: string + description: The File Name + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: returns the image file + content: + image/*: + schema: + type: string + format: binary + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + summary: Delete the shared resource's image + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Deletes the image file for the shared resource + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ProviderSharedResource + operationId: delete_imageCdxV1ProviderSharedResource + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider shared resource. + - name: file_name + in: path + required: true + schema: + type: string + description: The File Name + tags: + - Provider Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/provider-shares: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCdxV1ProviderShares + summary: List of Provider Shares + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all provider shares. + parameters: + - name: shared_resource + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: sr-1234 + description: Filter the results by exact match for shared_resource. + - name: crn + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + description: Filter the results by exact match for crn. + - name: include_deleted + in: query + required: false + schema: + $ref: '#/components/schemas/BooleanFilter' + description: Include deactivated shares + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Provider Shares (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Provider Share. + content: + application/json: + schema: + type: object + description: |- + `ProviderShare` object respresents the share that you have created through Stream Sharing. + + + Related guide: [Provider Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares). + + ## The Provider Shares Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderShareList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ProviderShare` object respresents the share that you have created through Stream Sharing. + + + Related guide: [Provider Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares). + + ## The Provider Shares Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderShare + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + consumer_user_name: + type: string + description: Name of the consumer + example: John Doe + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user. Deprecated + example: Jane Doe + readOnly: true + delivery_method: + description: Method by which the invite will be delivered + type: string + x-extensible-enum: + - EMAIL + example: EMAIL + x-immutable: true + consumer_restriction: + description: Restrictions on the consumer that can redeem this token + discriminator: + propertyName: kind + mapping: + Email: '#/components/schemas/cdx.v1.EmailConsumerRestriction' + x-immutable: true + type: object + required: + - kind + - email + properties: + kind: + description: The resource kind + type: string + enum: + - Email + email: + type: string + format: email + description: Email based matching for the consumers + invited_at: + type: string + format: date-time + description: The date and time at which consumer was invited + example: '2006-01-02T15:04:05-07:00' + readOnly: true + invite_expires_at: + type: string + format: date-time + description: The date and time at which the invitation will expire. Only for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + redeemed_at: + type: string + format: date-time + description: The date and time at which the invite was redeemed + example: '2006-01-02T15:04:05-07:00' + readOnly: true + provider_user: + description: The provider user/inviter + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + service_account: + description: The service account associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ProviderShareStatus' + required: + - id + - metadata + - provider_user_name + - delivery_method + - invited_at + - invite_expires_at + - provider_user + - cloud_cluster + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + summary: Create a provider share + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Creates a share based on delivery method. + requestBody: + content: + application/json: + schema: + type: object + description: Create share request + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CreateProviderShareRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + delivery_method: + type: string + description: Method by which the invite will be delivered + x-extensible-enum: + - EMAIL + example: EMAIL + consumer_restriction: + description: Restrictions on the consumer that can redeem this token + discriminator: + propertyName: kind + mapping: + Email: '#/components/schemas/cdx.v1.EmailConsumerRestriction' + type: object + required: + - kind + - email + properties: + kind: + description: The resource kind + type: string + enum: + - Email + email: + type: string + format: email + description: Email based matching for the consumers + resources: + type: array + minItems: 1 + description: List of resource crns to be shared + items: + type: string + description: crn that specifies the sharedresource + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + required: + - delivery_method + - consumer_restriction + - resources + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createCdxV1ProviderShare + tags: + - Provider Shares (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '201': + description: | + Response is the provider share + headers: + Location: + schema: + type: string + format: uri + example: https://some-subdomain.confluent.cloud/path/to/resource + description: A URL that allows access to the resourced named by the crn + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/cdx.v1.ProviderShare' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/provider-shares/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCdxV1ProviderShare + summary: Read a Provider Share + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a provider share. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider share. + tags: + - Provider Shares (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Provider Share. + content: + application/json: + schema: + type: object + description: |- + `ProviderShare` object respresents the share that you have created through Stream Sharing. + + + Related guide: [Provider Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares). + + ## The Provider Shares Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderShare + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + consumer_user_name: + type: string + description: Name of the consumer + example: John Doe + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user. Deprecated + example: Jane Doe + readOnly: true + delivery_method: + description: Method by which the invite will be delivered + type: string + x-extensible-enum: + - EMAIL + example: EMAIL + x-immutable: true + consumer_restriction: + description: Restrictions on the consumer that can redeem this token + discriminator: + propertyName: kind + mapping: + Email: '#/components/schemas/cdx.v1.EmailConsumerRestriction' + x-immutable: true + type: object + required: + - kind + - email + properties: + kind: + description: The resource kind + type: string + enum: + - Email + email: + type: string + format: email + description: Email based matching for the consumers + invited_at: + type: string + format: date-time + description: The date and time at which consumer was invited + example: '2006-01-02T15:04:05-07:00' + readOnly: true + invite_expires_at: + type: string + format: date-time + description: The date and time at which the invitation will expire. Only for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + redeemed_at: + type: string + format: date-time + description: The date and time at which the invite was redeemed + example: '2006-01-02T15:04:05-07:00' + readOnly: true + provider_user: + description: The provider user/inviter + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + service_account: + description: The service account associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ProviderShareStatus' + required: + - api_version + - kind + - id + - provider_user_name + - delivery_method + - invited_at + - invite_expires_at + - provider_user + - cloud_cluster + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteCdxV1ProviderShare + summary: Delete a Provider Share + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a provider share. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider share. + tags: + - Provider Shares (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Provider Share is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/provider-shares/{id}:resend: + post: + summary: Resend + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Resend provider share + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ProviderShare + operationId: resendCdxV1ProviderShare + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the provider share. + tags: + - Provider Shares (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/consumer-shared-resources: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCdxV1ConsumerSharedResources + summary: List of Consumer Shared Resources + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all consumer shared resources. + parameters: + - name: stream_share + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: ss-1234 + description: Filter the results by exact match for stream_share. + - name: include_deleted + in: query + required: false + schema: + $ref: '#/components/schemas/BooleanFilter' + description: Include deactivated shared resources + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Consumer Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Consumer Shared Resource. + content: + application/json: + schema: + type: object + description: |- + `ConsumerSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you received through Stream Sharing. + + + ## The Consumer Shared Resources Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerSharedResourceList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ConsumerSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you received through Stream Sharing. + + + ## The Consumer Shared Resources Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerSharedResource + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider of the provider shared cluster. + x-extensible-enum: + - AWS + - AZURE + - GCP + example: AWS + x-immutable: true + readOnly: true + network_connection_types: + type: array + description: | + The network connection types of the provider shared cluster. If the shared cluster is on public internet, + then the list will be empty + items: + $ref: '#/components/schemas/cdx.v1.ConnectionType' + uniqueItems: true + x-immutable: true + readOnly: true + display_name: + type: string + description: Consumer resource display name + example: Stock Trades + x-immutable: true + readOnly: true + description: + type: string + description: Description of consumer resource + example: This topic provides realtime data for the orders placed through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: List of schemas in JSON format. This field is work in progress and subject to changes. + x-immutable: true + readOnly: true + organization_name: + type: string + description: Shared resource's organization name + example: ABC Corp + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + x-immutable: true + readOnly: true + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of the shared resource's organization contact + x-immutable: true + readOnly: true + logo_url: + type: string + format: uri + description: Resource logo url + example: https://confluent.cloud/api/cdx/v1/consumer-shared-resources/sr-123/images/logo + x-immutable: true + readOnly: true + required: + - id + - metadata + - cloud + - display_name + - organization_name + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/consumer-shared-resources/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCdxV1ConsumerSharedResource + summary: Read a Consumer Shared Resource + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a consumer shared resource. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the consumer shared resource. + tags: + - Consumer Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Consumer Shared Resource. + content: + application/json: + schema: + type: object + description: |- + `ConsumerSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you received through Stream Sharing. + + + ## The Consumer Shared Resources Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerSharedResource + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider of the provider shared cluster. + x-extensible-enum: + - AWS + - AZURE + - GCP + example: AWS + x-immutable: true + readOnly: true + network_connection_types: + type: array + description: | + The network connection types of the provider shared cluster. If the shared cluster is on public internet, + then the list will be empty + items: + $ref: '#/components/schemas/cdx.v1.ConnectionType' + uniqueItems: true + x-immutable: true + readOnly: true + display_name: + type: string + description: Consumer resource display name + example: Stock Trades + x-immutable: true + readOnly: true + description: + type: string + description: Description of consumer resource + example: This topic provides realtime data for the orders placed through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: List of schemas in JSON format. This field is work in progress and subject to changes. + x-immutable: true + readOnly: true + organization_name: + type: string + description: Shared resource's organization name + example: ABC Corp + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + x-immutable: true + readOnly: true + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of the shared resource's organization contact + x-immutable: true + readOnly: true + logo_url: + type: string + format: uri + description: Resource logo url + example: https://confluent.cloud/api/cdx/v1/consumer-shared-resources/sr-123/images/logo + x-immutable: true + readOnly: true + required: + - api_version + - kind + - id + - cloud + - display_name + - organization_name + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/consumer-shared-resources/{id}/images/{file_name}: + get: + summary: Get image for shared resource + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Returns the image file for the shared resource + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ConsumerSharedResource + operationId: imageCdxV1ConsumerSharedResource + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the consumer shared resource. + - name: file_name + in: path + required: true + schema: + type: string + description: The File Name + tags: + - Consumer Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Returns the image file's binary content + content: + image/*: + schema: + type: string + format: binary + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/consumer-shared-resources/{id}:network: + get: + summary: Get shared resource's network configuration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Returns network information of the shared resource + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.ConsumerSharedResource + operationId: networkCdxV1ConsumerSharedResource + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the consumer shared resource. + tags: + - Consumer Shared Resources (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: The network information of the shared resource + content: + application/json: + schema: + $ref: '#/components/schemas/cdx.v1.Network' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/consumer-shares: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listCdxV1ConsumerShares + summary: List of Consumer Shares + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all consumer shares. + parameters: + - name: shared_resource + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: sr-1234 + description: Filter the results by exact match for shared_resource. + - name: include_deleted + in: query + required: false + schema: + $ref: '#/components/schemas/BooleanFilter' + description: Include deactivated shares + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Consumer Shares (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Consumer Share. + content: + application/json: + schema: + type: object + description: |- + `ConsumerShare` object respresents the share that you received through Stream Sharing. + + + Related guide: [Consumer Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html). + + ## The Consumer Shares Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerShareList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ConsumerShare` object respresents the share that you received through Stream Sharing. + + + Related guide: [Consumer Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html). + + ## The Consumer Shares Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerShare + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + provider_organization_name: + type: string + description: Provider organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user + example: Jane Doe + readOnly: true + invite_expires_at: + type: string + format: date-time + description: The date and time at which the invitation will expire. Only for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name. Deprecated + example: Nasdaq + readOnly: true + consumer_user_name: + type: string + description: Name of the consumer. Deprecated + example: John Doe + readOnly: true + consumer_user: + description: The consumer user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ConsumerShareStatus' + required: + - id + - metadata + - provider_organization_name + - provider_user_name + - consumer_user + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/consumer-shares/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCdxV1ConsumerShare + summary: Read a Consumer Share + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a consumer share. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the consumer share. + tags: + - Consumer Shares (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: Consumer Share. + content: + application/json: + schema: + type: object + description: |- + `ConsumerShare` object respresents the share that you received through Stream Sharing. + + + Related guide: [Consumer Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html). + + ## The Consumer Shares Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerShare + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + provider_organization_name: + type: string + description: Provider organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user + example: Jane Doe + readOnly: true + invite_expires_at: + type: string + format: date-time + description: The date and time at which the invitation will expire. Only for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name. Deprecated + example: Nasdaq + readOnly: true + consumer_user_name: + type: string + description: Name of the consumer. Deprecated + example: John Doe + readOnly: true + consumer_user: + description: The consumer user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ConsumerShareStatus' + required: + - api_version + - kind + - id + - provider_organization_name + - provider_user_name + - consumer_user + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteCdxV1ConsumerShare + summary: Delete a Consumer Share + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a consumer share. + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the consumer share. + tags: + - Consumer Shares (cdx/v1) + security: + - cloud-api-key: [] + responses: + '204': + description: A Consumer Share is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/shared-tokens:resources: + post: + summary: Validate token to view shared resources + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Validate and decrypt the shared token and view token's shared resources + requestBody: + content: + application/json: + schema: + type: object + description: |- + Encrypted Token shared with consumer + + + ## The Shared Tokens Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - SharedToken + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + token: + type: string + description: The encrypted token + required: + - token + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.SharedToken + operationId: resourcesCdxV1SharedToken + tags: + - Shared Tokens (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: | + Consumer validates share token and view consumer resources before redeeming in the workflow + content: + application/json: + schema: + type: object + properties: + consumer_shared_resources: + type: array + items: + $ref: '#/components/schemas/cdx.v1.ConsumerSharedResource' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/shared-tokens:redeem: + post: + summary: Redeem token + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Redeem the shared token for shared topic and cluster access information + requestBody: + content: + application/json: + schema: + type: object + description: Redeem share with token request parameters + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RedeemTokenRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + token: + type: string + description: The encrypted token + aws_account: + type: string + description: Consumer's AWS account ID for PrivateLink access. + example: '000000000000' + azure_subscription: + type: string + description: Consumer's Azure subscription ID for PrivateLink access. + example: 00000000-0000-0000-0000-000000000000 + gcp_project: + type: string + minLength: 1 + description: Consumer's GCP project ID for Private Service Connect access. + required: + - token + x-lifecycle-stage: General Availability + x-self-access: true + x-name: cdx.v1.SharedToken + operationId: redeemCdxV1SharedToken + tags: + - Shared Tokens (cdx/v1) + security: + - cloud-api-key: [] + responses: + '200': + description: | + Consumer redeems shared token + content: + application/json: + schema: + $ref: '#/components/schemas/cdx.v1.RedeemTokenResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /cdx/v1/opt-in: + get: + summary: Read the organization's stream sharing opt-in settings + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Returns the organization's stream sharing opt-in settings. + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getCdxV1OptIn + tags: + - Opt Ins (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Opt In. + content: + application/json: + schema: + type: object + description: |- + Stream sharing opt in options + + ## The Opt Ins Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OptIn + stream_share_enabled: + type: boolean + description: Enable stream sharing for the organization + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + summary: Set the organization's stream sharing opt-in settings + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Updates the organization's stream sharing opt-in settings. + + + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateCdxV1OptIn + tags: + - Opt Ins (cdx/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cdx.v1.OptIn' + responses: + '200': + description: Opt In. + content: + application/json: + schema: + type: object + description: |- + Stream sharing opt in options + + ## The Opt Ins Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OptIn + stream_share_enabled: + type: boolean + description: Enable stream sharing for the organization + required: + - api_version + - kind + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + BooleanFilter: + type: boolean + description: Filter for whether this value is true or false. + cdx.v1.ProviderSharedResourceList: + type: object + description: |- + `ProviderSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you have shared through Stream Sharing. + + + ## The Provider Shared Resources Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderSharedResourceList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ProviderSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you have shared through Stream Sharing. + + + ## The Provider Shared Resources Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderSharedResource + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + crn: + type: string + description: Deprecated please use resources attribute. + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic + x-immutable: true + resources: + type: array + minItems: 1 + description: List of resource crns that are shared together + items: + type: string + description: crn that specifies the shared resource + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + display_name: + type: string + description: Shared resource display name + example: Stock Trades + description: + type: string + description: Description of shared resource + example: This topic provides realtime data for the orders placed through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: List of schemas in JSON format. This field is work in progress and subject to changes. + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of contact person from the organization + logo_url: + type: string + format: uri + description: Resource logo url + example: https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo + readOnly: true + organization_name: + description: Organization to which the shared resource belongs. Deprecated + example: ABC Corp + x-immutable: true + readOnly: true + environment_name: + type: string + description: The environment name of the shared resource. Deprecated + example: Public Env + x-immutable: true + readOnly: true + cluster_name: + type: string + description: The cluster display name of the shared resource. Deprecated + example: Published Trades + x-immutable: true + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - metadata + - display_name + - organization_name + - environment_name + - cluster_name + - cloud_cluster + uniqueItems: true + cdx.v1.ProviderSharedResource: + type: object + description: |- + `ProviderSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you have shared through Stream Sharing. + + + ## The Provider Shared Resources Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderSharedResource + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + crn: + type: string + description: Deprecated please use resources attribute. + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic + x-immutable: true + resources: + type: array + minItems: 1 + description: List of resource crns that are shared together + items: + type: string + description: crn that specifies the shared resource + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + display_name: + type: string + description: Shared resource display name + example: Stock Trades + description: + type: string + description: Description of shared resource + example: This topic provides realtime data for the orders placed through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: List of schemas in JSON format. This field is work in progress and subject to changes. + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of contact person from the organization + logo_url: + type: string + format: uri + description: Resource logo url + example: https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo + readOnly: true + organization_name: + description: Organization to which the shared resource belongs. Deprecated + example: ABC Corp + x-immutable: true + readOnly: true + environment_name: + type: string + description: The environment name of the shared resource. Deprecated + example: Public Env + x-immutable: true + readOnly: true + cluster_name: + type: string + description: The cluster display name of the shared resource. Deprecated + example: Published Trades + x-immutable: true + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cdx.v1.ProviderShareList: + type: object + description: |- + `ProviderShare` object respresents the share that you have created through Stream Sharing. + + + Related guide: [Provider Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares). + + ## The Provider Shares Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderShareList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ProviderShare` object respresents the share that you have created through Stream Sharing. + + + Related guide: [Provider Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares). + + ## The Provider Shares Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderShare + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + consumer_user_name: + type: string + description: Name of the consumer + example: John Doe + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user. Deprecated + example: Jane Doe + readOnly: true + delivery_method: + description: Method by which the invite will be delivered + type: string + x-extensible-enum: + - EMAIL + example: EMAIL + x-immutable: true + consumer_restriction: + description: Restrictions on the consumer that can redeem this token + discriminator: + propertyName: kind + mapping: + Email: '#/components/schemas/cdx.v1.EmailConsumerRestriction' + x-immutable: true + type: object + required: + - kind + - email + properties: + kind: + description: The resource kind + type: string + enum: + - Email + email: + type: string + format: email + description: Email based matching for the consumers + invited_at: + type: string + format: date-time + description: The date and time at which consumer was invited + example: '2006-01-02T15:04:05-07:00' + readOnly: true + invite_expires_at: + type: string + format: date-time + description: The date and time at which the invitation will expire. Only for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + redeemed_at: + type: string + format: date-time + description: The date and time at which the invite was redeemed + example: '2006-01-02T15:04:05-07:00' + readOnly: true + provider_user: + description: The provider user/inviter + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + service_account: + description: The service account associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ProviderShareStatus' + required: + - id + - metadata + - provider_user_name + - delivery_method + - invited_at + - invite_expires_at + - provider_user + - cloud_cluster + - status + uniqueItems: true + cdx.v1.CreateProviderShareRequest: + type: object + description: Create share request + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CreateProviderShareRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + delivery_method: + type: string + description: Method by which the invite will be delivered + x-extensible-enum: + - EMAIL + example: EMAIL + consumer_restriction: + description: Restrictions on the consumer that can redeem this token + discriminator: + propertyName: kind + mapping: + Email: '#/components/schemas/cdx.v1.EmailConsumerRestriction' + type: object + required: + - kind + - email + properties: + kind: + description: The resource kind + type: string + enum: + - Email + email: + type: string + format: email + description: Email based matching for the consumers + resources: + type: array + minItems: 1 + description: List of resource crns to be shared + items: + type: string + description: crn that specifies the sharedresource + format: uri + pattern: ^crn://.+$ + example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic + cdx.v1.ProviderShare: + type: object + description: |- + `ProviderShare` object respresents the share that you have created through Stream Sharing. + + + Related guide: [Provider Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/produce-shared-data.html#stream-shares). + + ## The Provider Shares Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ProviderShare + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + consumer_user_name: + type: string + description: Name of the consumer + example: John Doe + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user. Deprecated + example: Jane Doe + readOnly: true + delivery_method: + description: Method by which the invite will be delivered + type: string + x-extensible-enum: + - EMAIL + example: EMAIL + x-immutable: true + consumer_restriction: + description: Restrictions on the consumer that can redeem this token + discriminator: + propertyName: kind + mapping: + Email: '#/components/schemas/cdx.v1.EmailConsumerRestriction' + x-immutable: true + type: object + required: + - kind + - email + properties: + kind: + description: The resource kind + type: string + enum: + - Email + email: + type: string + format: email + description: Email based matching for the consumers + invited_at: + type: string + format: date-time + description: The date and time at which consumer was invited + example: '2006-01-02T15:04:05-07:00' + readOnly: true + invite_expires_at: + type: string + format: date-time + description: The date and time at which the invitation will expire. Only for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + redeemed_at: + type: string + format: date-time + description: The date and time at which the invite was redeemed + example: '2006-01-02T15:04:05-07:00' + readOnly: true + provider_user: + description: The provider user/inviter + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + service_account: + description: The service account associated with this object. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cloud_cluster: + description: The cloud cluster to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ProviderShareStatus' + cdx.v1.ConsumerSharedResourceList: + type: object + description: |- + `ConsumerSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you received through Stream Sharing. + + + ## The Consumer Shared Resources Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerSharedResourceList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ConsumerSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you received through Stream Sharing. + + + ## The Consumer Shared Resources Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerSharedResource + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider of the provider shared cluster. + x-extensible-enum: + - AWS + - AZURE + - GCP + example: AWS + x-immutable: true + readOnly: true + network_connection_types: + type: array + description: | + The network connection types of the provider shared cluster. If the shared cluster is on public internet, + then the list will be empty + items: + $ref: '#/components/schemas/cdx.v1.ConnectionType' + uniqueItems: true + x-immutable: true + readOnly: true + display_name: + type: string + description: Consumer resource display name + example: Stock Trades + x-immutable: true + readOnly: true + description: + type: string + description: Description of consumer resource + example: This topic provides realtime data for the orders placed through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: List of schemas in JSON format. This field is work in progress and subject to changes. + x-immutable: true + readOnly: true + organization_name: + type: string + description: Shared resource's organization name + example: ABC Corp + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + x-immutable: true + readOnly: true + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of the shared resource's organization contact + x-immutable: true + readOnly: true + logo_url: + type: string + format: uri + description: Resource logo url + example: https://confluent.cloud/api/cdx/v1/consumer-shared-resources/sr-123/images/logo + x-immutable: true + readOnly: true + required: + - id + - metadata + - cloud + - display_name + - organization_name + uniqueItems: true + cdx.v1.ConsumerSharedResource: + type: object + description: |- + `ConsumerSharedResource` object contains details of the data stream + (topic, schema registry subjects, sharing metadata) that you received through Stream Sharing. + + + ## The Consumer Shared Resources Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerSharedResource + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider of the provider shared cluster. + x-extensible-enum: + - AWS + - AZURE + - GCP + example: AWS + x-immutable: true + readOnly: true + network_connection_types: + type: array + description: | + The network connection types of the provider shared cluster. If the shared cluster is on public internet, + then the list will be empty + items: + $ref: '#/components/schemas/cdx.v1.ConnectionType' + uniqueItems: true + x-immutable: true + readOnly: true + display_name: + type: string + description: Consumer resource display name + example: Stock Trades + x-immutable: true + readOnly: true + description: + type: string + description: Description of consumer resource + example: This topic provides realtime data for the orders placed through the website + x-immutable: true + readOnly: true + tags: + type: array + items: + type: string + description: list of tags + example: + - recent + - pending + x-immutable: true + readOnly: true + schemas: + type: array + items: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + description: List of schemas in JSON format. This field is work in progress and subject to changes. + x-immutable: true + readOnly: true + organization_name: + type: string + description: Shared resource's organization name + example: ABC Corp + x-immutable: true + readOnly: true + organization_description: + type: string + description: Shared resource's organization description + example: ABC Corp is the biggest online retailer + x-immutable: true + readOnly: true + organization_contact: + type: string + format: email + example: jane.doe@example.com + description: Email of the shared resource's organization contact + x-immutable: true + readOnly: true + logo_url: + type: string + format: uri + description: Resource logo url + example: https://confluent.cloud/api/cdx/v1/consumer-shared-resources/sr-123/images/logo + x-immutable: true + readOnly: true + cdx.v1.Network: + type: object + description: The shared cluster's network configurations for consumer to setup private link + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Network + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + kafka_bootstrap_url: + type: string + format: uri + description: The kafka cluster bootstrap url + example: SASL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + x-immutable: true + readOnly: true + zones: + type: array + items: + type: string + uniqueItems: true + minItems: 3 + maxItems: 3 + description: | + The 3 availability zones for this network. They can optionally be specified for AWS networks + used with PrivateLink. Otherwise, they are automatically chosen by Confluent Cloud. + + On AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) + (e.g. use1-az3) + + On GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones) + (e.g. us-central1-c). + + On Azure, zones are Confluent-chosen names (e.g. 1, 2, 3) since Azure does not + have universal zone identifiers. + example: + - use1-az1 + - use1-az2 + - use1-az3 + x-immutable: true + dns_domain: + type: string + description: The root DNS domain for the network if applicable. + example: 00000.us-east-1.aws.glb.confluent.cloud + readOnly: true + zonal_subdomains: + type: object + additionalProperties: + type: string + description: | + The DNS subdomain for each zone. Present on networks that support PrivateLink. Keys are zones and + values are DNS domains. + example: + use1-az1: use1-az1.00000.us-east-1.aws.confluent.cloud + use1-az4: use1-az4.00000.us-east-1.aws.confluent.cloud + use1-az5: use1-az5.00000.us-east-1.aws.confluent.cloud + readOnly: true + cloud: + description: The cloud-specific network details. These will be populated when the network reaches the READY state. + discriminator: + propertyName: kind + mapping: + AwsNetwork: '#/components/schemas/cdx.v1.AwsNetwork' + AzureNetwork: '#/components/schemas/cdx.v1.AzureNetwork' + GcpNetwork: '#/components/schemas/cdx.v1.GcpNetwork' + readOnly: true + type: object + required: + - kind + properties: + kind: + description: Network kind type. + type: string + enum: + - AwsNetwork + private_link_endpoint_service: + type: string + description: The AWS VPC endpoint service for the network (used for PrivateLink) if available. + example: com.amazonaws.vpce.eu-west-3.vpce-00000000000000000 + readOnly: true + private_link_service_aliases: + type: object + description: | + The mapping of zones to PrivateLink Service Aliases if available. Keys are zones + and values are [Azure PrivateLink Service + Aliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service) + additionalProperties: + type: string + example: + '1': 0-00000-privatelink-1.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '2': 0-00000-privatelink-2.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '3': 0-00000-privatelink-3.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + readOnly: true + private_service_connect_service_attachments: + type: object + description: | + The mapping of zones to Private Service Connect Service + Attachments if available. Keys are zones and values are + [GCP Private Service Connect Service + Attachment](https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#api_7) + additionalProperties: + type: string + example: + us-central1-a: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-a + us-central1-b: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-b + us-central1-c: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-c + readOnly: true + cdx.v1.ConsumerShareList: + type: object + description: |- + `ConsumerShare` object respresents the share that you received through Stream Sharing. + + + Related guide: [Consumer Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html). + + ## The Consumer Shares Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerShareList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ConsumerShare` object respresents the share that you received through Stream Sharing. + + + Related guide: [Consumer Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html). + + ## The Consumer Shares Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerShare + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + provider_organization_name: + type: string + description: Provider organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user + example: Jane Doe + readOnly: true + invite_expires_at: + type: string + format: date-time + description: The date and time at which the invitation will expire. Only for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name. Deprecated + example: Nasdaq + readOnly: true + consumer_user_name: + type: string + description: Name of the consumer. Deprecated + example: John Doe + readOnly: true + consumer_user: + description: The consumer user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ConsumerShareStatus' + required: + - id + - metadata + - provider_organization_name + - provider_user_name + - consumer_user + - status + uniqueItems: true + cdx.v1.ConsumerShare: + type: object + description: |- + `ConsumerShare` object respresents the share that you received through Stream Sharing. + + + Related guide: [Consumer Stream Shares in Confluent Cloud](https://docs.confluent.io/cloud/current/stream-sharing/consume-shared-data.html). + + ## The Consumer Shares Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConsumerShare + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + provider_organization_name: + type: string + description: Provider organization name + example: Nasdaq + readOnly: true + provider_user_name: + type: string + description: Name or email of the provider user + example: Jane Doe + readOnly: true + invite_expires_at: + type: string + format: date-time + description: The date and time at which the invitation will expire. Only for invited shares + example: '2006-01-02T15:04:05-07:00' + readOnly: true + consumer_organization_name: + type: string + description: Consumer organization name. Deprecated + example: Nasdaq + readOnly: true + consumer_user_name: + type: string + description: Name of the consumer. Deprecated + example: John Doe + readOnly: true + consumer_user: + description: The consumer user/invitee + readOnly: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + status: + $ref: '#/components/schemas/cdx.v1.ConsumerShareStatus' + cdx.v1.SharedToken: + type: object + description: |- + Encrypted Token shared with consumer + + + ## The Shared Tokens Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - SharedToken + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + token: + type: string + description: The encrypted token + cdx.v1.RedeemTokenRequest: + type: object + description: Redeem share with token request parameters + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RedeemTokenRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + token: + type: string + description: The encrypted token + aws_account: + type: string + description: Consumer's AWS account ID for PrivateLink access. + example: '000000000000' + azure_subscription: + type: string + description: Consumer's Azure subscription ID for PrivateLink access. + example: 00000000-0000-0000-0000-000000000000 + gcp_project: + type: string + minLength: 1 + description: Consumer's GCP project ID for Private Service Connect access. + cdx.v1.RedeemTokenResponse: + type: object + description: Share details for the consumer org or user + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RedeemTokenResponse + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + api_key: + type: string + description: The api key + readOnly: true + secret: + type: string + description: The api key secret + x-redact: true + readOnly: true + kafka_bootstrap_url: + type: string + format: uri + description: The kafka cluster bootstrap url + example: SASL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092 + x-immutable: true + readOnly: true + schema_registry_api_key: + type: string + description: The api key for schema registry + readOnly: true + schema_registry_secret: + type: string + description: The api key secret for schema registry + x-redact: true + readOnly: true + schema_registry_url: + type: string + format: uri + description: The schema registry endpoint url + example: https://psrc-xxxxx.us-west-2.aws.confluent.cloud + x-immutable: true + readOnly: true + resources: + type: array + minItems: 1 + description: List of shared resources + items: + type: object + discriminator: + propertyName: kind + mapping: + Topic: '#/components/schemas/cdx.v1.SharedTopic' + Group: '#/components/schemas/cdx.v1.SharedGroup' + Subject: '#/components/schemas/cdx.v1.SharedSubject' + oneOf: + - $ref: '#/components/schemas/cdx.v1.SharedTopic' + - $ref: '#/components/schemas/cdx.v1.SharedGroup' + - $ref: '#/components/schemas/cdx.v1.SharedSubject' + cdx.v1.OptIn: + type: object + description: |- + Stream sharing opt in options + + ## The Opt Ins Model + + properties: + api_version: + type: string + enum: + - cdx/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - OptIn + stream_share_enabled: + type: boolean + description: Enable stream sharing for the organization + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cdx.v1.Schema: + type: object + properties: + subject: + type: string + description: Name of the subject + example: User + version: + type: integer + description: Version number + format: int32 + example: 1 + id: + type: integer + description: Globally unique identifier of the schema + format: int32 + example: 100001 + schema_type: + type: string + description: Schema type + example: AVRO + schema: + type: string + description: Schema definition string + example: '{"schema": "{"type": "string"}"}' + description: Schema + EnvScopedObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cdx.v1.EmailConsumerRestriction: + type: object + description: Consumer restrictions limits by authenticated user's email + required: + - kind + - email + properties: + kind: + description: The resource kind + type: string + enum: + - Email + email: + type: string + format: email + description: Email based matching for the consumers + GlobalObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + cdx.v1.ProviderShareStatus: + type: object + required: + - phase + description: The status of the Provider Share + properties: + phase: + type: string + x-extensible-enum: + - INVITED + - EXPIRED + - ACTIVE + - DEACTIVATED + description: Status of share + example: ACTIVE + readOnly: true + readOnly: true + cdx.v1.ConnectionType: + type: string + description: Network connection type. + x-extensible-enum: + - PRIVATELINK + example: PRIVATELINK + cdx.v1.AwsNetwork: + type: object + description: The AWS network details. + required: + - kind + properties: + kind: + description: Network kind type. + type: string + enum: + - AwsNetwork + private_link_endpoint_service: + type: string + description: The AWS VPC endpoint service for the network (used for PrivateLink) if available. + example: com.amazonaws.vpce.eu-west-3.vpce-00000000000000000 + readOnly: true + cdx.v1.AzureNetwork: + type: object + description: The Azure network details. + required: + - kind + properties: + kind: + description: Network kind type. + type: string + enum: + - AzureNetwork + private_link_service_aliases: + type: object + description: | + The mapping of zones to PrivateLink Service Aliases if available. Keys are zones + and values are [Azure PrivateLink Service + Aliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service) + additionalProperties: + type: string + example: + '1': 0-00000-privatelink-1.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '2': 0-00000-privatelink-2.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + '3': 0-00000-privatelink-3.00000000-0000-0000-0000-000000000000.westeurope.azure.privatelinkservice + readOnly: true + cdx.v1.GcpNetwork: + type: object + description: The GCP network details. + required: + - kind + properties: + kind: + description: Network kind type. + type: string + enum: + - GcpNetwork + private_service_connect_service_attachments: + type: object + description: | + The mapping of zones to Private Service Connect Service + Attachments if available. Keys are zones and values are + [GCP Private Service Connect Service + Attachment](https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#api_7) + additionalProperties: + type: string + example: + us-central1-a: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-a + us-central1-b: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-b + us-central1-c: projects/cc-prod/regions/us-central1/serviceAttachments/s-7jjm9-service-attachment-us-central1-c + readOnly: true + cdx.v1.ConsumerShareStatus: + type: object + required: + - phase + description: The status of the Consumer Share + properties: + phase: + type: string + description: Status of share + x-extensible-enum: + - INVITED + - EXPIRED + - ACTIVE + - DEACTIVATED + example: ACTIVE + readOnly: true + readOnly: true + cdx.v1.SharedTopic: + type: object + description: The shared resource details + required: + - kind + - topic + properties: + kind: + description: The shared resource kind + type: string + enum: + - Topic + topic: + type: string + description: The topic name + cdx.v1.SharedGroup: + type: object + description: The shared consumer group + required: + - kind + - group_prefix + properties: + kind: + description: The resource kind + type: string + enum: + - Group + group_prefix: + type: string + description: The consumer group prefix + cdx.v1.SharedSubject: + type: object + description: The shared resource details + required: + - kind + - subject + properties: + kind: + description: The shared resource kind + type: string + enum: + - Subject + subject: + type: string + description: The subject name + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/streams_group.yaml b/provider-dev/source/streams_group.yaml new file mode 100644 index 0000000..c375198 --- /dev/null +++ b/provider-dev/source/streams_group.yaml @@ -0,0 +1,1067 @@ +openapi: 3.0.0 +info: + title: streams_group API + description: confluent streams_group API + version: 1.0.0 +paths: + /kafka/v3/clusters/{cluster_id}/streams-groups: + get: + summary: List Streams Groups + operationId: listKafkaStreamsGroups + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the list of streams groups that belong to the specified Kafka cluster + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListStreamsGroupsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}: + get: + summary: Get Streams Group + operationId: getKafkaStreamsGroup + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the streams group specified by the ``group_id``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsGroupResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/subtopologies: + get: + summary: List Streams Group Subtopologies + operationId: listKafkaStreamsGroupSubtopologies + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return a list of subtopologies that belong to the specified streams group. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListStreamsGroupSubtopologiesResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/subtopologies/{subtopology_id}: + get: + summary: Get Streams Group Subtopology + operationId: getKafkaStreamsGroupSubtopology + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the subtopology specified by the ``subtopology_id``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsGroupSubtopologyResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/SubtopologyId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members: + get: + summary: List Streams Group Members + operationId: listKafkaStreamsGroupMembers + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return a list of members that belong to the specified streams group. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListStreamsGroupMembersResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}: + get: + summary: Get Streams Group Member + operationId: getKafkaStreamsGroupMember + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the members specified by the ``member_id``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsGroupMemberResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments: + get: + summary: Get Streams Group Member Assignments + operationId: getKafkaStreamsGroupMemberAssignments + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the assignments of the member specified by the ``member_id``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsGroupMemberAssignmentsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments: + get: + summary: Get Streams Group Member Target Assignments + operationId: getKafkaStreamsGroupMemberTargetAssignments + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the target assignments of the member specified by the ``member_id``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsGroupMemberAssignmentsResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}: + get: + summary: List Streams Group Assignments of a Specific Type + operationId: listKafkaStreamsGroupMemberAssignmentTasks + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the tasks of the member specified by the ``member_id``, and the type ``assignments_type``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListStreamsTasksResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}: + get: + summary: List Streams Group Target Assignments of a Specific Type + operationId: listKafkaStreamsGroupMemberTargetAssignmentTasks + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the target tasks of the member specified by the ``member_id``, and the type ``assignments_type``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/ListStreamsTasksResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}/subtopologies/{subtopology_id}: + get: + summary: List Streams Group Assignments Task Partitions of a Specific Type and Subtopology + operationId: getKafkaStreamsGroupMemberAssignmentTaskPartitions + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the tasks of the member specified by the ``member_id``, and the type ``assignments_type``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsTaskResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + - $ref: '#/components/parameters/SubtopologyId' + /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}/subtopologies/{subtopology_id}: + get: + summary: List Streams Group Target Assignments Task Partitions of a Specific Type and Subtopology + operationId: getKafkaStreamsGroupMemberTargetAssignmentTaskPartitions + description: |- + [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the tasks of the member specified by the ``member_id``, and the type ``assignments_type``. + tags: + - Streams Group (v3) + security: + - resource-api-key: [] + - external-access-token: [] + responses: + '200': + $ref: '#/components/responses/GetStreamsTaskResponse' + '400': + $ref: '#/components/responses/BadRequestErrorResponse' + '401': + $ref: '#/components/responses/UnauthorizedErrorResponse' + '403': + $ref: '#/components/responses/ForbiddenErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequestsErrorResponse' + 5XX: + $ref: '#/components/responses/ServerErrorResponse' + servers: + - url: https://pkc-00000.region.provider.confluent.cloud + x-audience: business-unit-internal + description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + - $ref: '#/components/parameters/SubtopologyId' +components: + schemas: + StreamsGroupDataList: + description: The list of Streams groups. + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + description: The array of Streams group details. + items: + $ref: '#/components/schemas/StreamsGroupData' + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + StreamsGroupData: + description: The details of a Streams group. + type: object + required: + - kind + - metadata + - cluster_id + - group_id + - state + - member_count + - subtopology_count + - group_epoch + - topology_epoch + - target_assignment_epoch + - members + - subtopologies + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + description: The unique identifier of the Kafka cluster. + group_id: + type: string + description: The unique identifier of the Streams group. + state: + $ref: '#/components/schemas/StreamsGroupState' + member_count: + type: integer + description: The number of members in the Streams group. + subtopology_count: + type: integer + description: The number of subtopologies in the Streams group. + group_epoch: + type: integer + description: The epoch of the Streams group. + topology_epoch: + type: integer + description: The epoch of the Streams topology. + target_assignment_epoch: + type: integer + description: The epoch of the target assignment. + members: + $ref: '#/components/schemas/Relationship' + subtopologies: + $ref: '#/components/schemas/Relationship' + StreamsGroupSubtopologyDataList: + description: The list of Streams group subtopologies. + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + description: The array of Streams group subtopology details. + items: + $ref: '#/components/schemas/StreamsGroupSubtopologyData' + StreamsGroupSubtopologyData: + description: The details of a Streams group subtopology. + type: object + required: + - kind + - metadata + - cluster_id + - group_id + - subtopology_id + - source_topics + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + description: The unique identifier of the Kafka cluster. + group_id: + type: string + description: The unique identifier of the Streams group. + subtopology_id: + type: string + description: The unique identifier of the Streams subtopology. + source_topics: + type: array + description: The list of source topics for the subtopology. + items: + type: string + description: The name of a source topic. + StreamsGroupMemberDataList: + description: The list of Streams group members. + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + description: The array of Streams group member details. + items: + $ref: '#/components/schemas/StreamsGroupMemberData' + StreamsGroupMemberData: + description: The details of a Streams group member. + type: object + required: + - kind + - metadata + - cluster_id + - group_id + - member_id + - process_id + - client_id + - instance_id + - member_epoch + - topology_epoch + - is_classic + - assignments + - target_assignment + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + description: The unique identifier of the Kafka cluster. + group_id: + type: string + description: The unique identifier of the Streams group. + member_id: + type: string + description: The unique identifier of the Streams group member. + process_id: + type: string + description: The process identifier of the Streams group member. + client_id: + type: string + description: The client identifier of the Streams group member. + instance_id: + type: string + description: The instance identifier of the Streams group member. + member_epoch: + type: integer + description: The epoch of the Streams group member. + topology_epoch: + type: integer + description: The epoch of the Streams topology for the member. + is_classic: + type: boolean + description: The flag indicating if the member is a classic consumer. + assignments: + $ref: '#/components/schemas/Relationship' + target_assignment: + $ref: '#/components/schemas/Relationship' + StreamsGroupMemberAssignmentData: + description: The assignment details of a Streams group member. + type: object + required: + - kind + - metadata + - cluster_id + - group_id + - member_id + - active_tasks + - standby_tasks + - warmup_tasks + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + cluster_id: + type: string + description: The unique identifier of the Kafka cluster. + group_id: + type: string + description: The unique identifier of the Streams group. + member_id: + type: string + description: The unique identifier of the Streams group member. + active_tasks: + $ref: '#/components/schemas/Relationship' + standby_tasks: + $ref: '#/components/schemas/Relationship' + warmup_tasks: + $ref: '#/components/schemas/Relationship' + AssignmentsType: + description: The type of the Streams task assignments. + type: string + x-extensible-enum: + - ACTIVE + - STANDBY + - WARMUP + StreamsTaskDataList: + description: The list of Streams tasks. + type: object + required: + - kind + - metadata + - data + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + data: + type: array + description: The array of Streams task details. + items: + $ref: '#/components/schemas/StreamsTaskData' + StreamsTaskData: + description: The details of a Streams task. + type: object + required: + - kind + - metadata + - subtopology_id + - partition_ids + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + subtopology_id: + type: string + description: The unique identifier of the Streams subtopology. + partition_ids: + type: array + description: The list of partition IDs assigned to the Streams task. + items: + type: integer + description: The partition ID. + ResourceCollection: + type: object + required: + - kind + - metadata + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceCollectionMetadata' + Resource: + type: object + required: + - kind + - metadata + properties: + kind: + type: string + metadata: + $ref: '#/components/schemas/ResourceMetadata' + StreamsGroupState: + description: The state of the Streams group. + type: string + x-extensible-enum: + - UNKNOWN + - PREPARING_REBALANCE + - COMPLETING_REBALANCE + - STABLE + - DEAD + - EMPTY + - ASSIGNING + - RECONCILING + - NOT_READY + Relationship: + type: object + required: + - related + properties: + related: + type: string + ResourceCollectionMetadata: + type: object + required: + - self + properties: + self: + type: string + next: + type: string + nullable: true + ResourceMetadata: + type: object + required: + - self + properties: + self: + type: string + resource_name: + type: string + nullable: true + responses: + ListStreamsGroupsResponse: + description: The list of streams groups. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupDataList' + example: + kind: KafkaStreamsGroupList + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups + next: null + data: + - kind: KafkaStreamsGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1 + cluster_id: cluster-1 + group_id: streams-group-1 + group_epoch: 1 + target_assignment_epoch: 1 + topology_epoch: 1 + state: STABLE + member_count: 2 + subtopology_count: 1 + members: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members + subtopologies: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/subtopologies + BadRequestErrorResponse: + description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + bad_request_cannot_deserialize: + description: Thrown when trying to deserialize an integer from non-integer data. + value: + error_code: 400 + message: 'Cannot deserialize value of type `java.lang.Integer` from String "A": not a valid `java.lang.Integer` value' + unsupported_version_exception: + description: Thrown when the version of this API is not supported in the underlying Kafka cluster. + value: + error_code: 40035 + message: The version of this API is not supported in the underlying Kafka cluster. + UnauthorizedErrorResponse: + description: Indicates a client authentication error. Kafka authentication failures will contain error code 40101 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + kafka_authentication_failed: + description: Thrown when using Basic authentication with wrong Kafka credentials. + value: + error_code: 40101 + message: Authentication failed + ForbiddenErrorResponse: + description: Indicates a client authorization error. Kafka authorization failures will contain error code 40301 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + kafka_authorization_failed: + description: Thrown when the caller is not authorized to perform the underlying operation. + value: + error_code: 40301 + message: Request is not authorized + TooManyRequestsErrorResponse: + description: Indicates that a rate limit threshold has been reached, and the client should retry again later. + content: + text/html: + schema: + type: string + example: + description: A sample response from Jetty's DoSFilter. + value: Error 429 Too Many Requests

HTTP ERROR 429 Too Many Requests

URI: /v3/clusters/my-cluster
STATUS: 429
MESSAGE: Too Many Requests
SERVLET: default
+ ServerErrorResponse: + description: A server-side problem that might not be addressable from the client side. Retriable Kafka errors will contain error code 50003 in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + generic_internal_server_error: + description: Thrown for generic HTTP 500 errors. + value: + error_code: 500 + message: Internal Server Error + GetStreamsGroupResponse: + description: The streams group. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupData' + example: + kind: KafkaStreamsGroup + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1 + cluster_id: cluster-1 + group_id: streams-group-1 + group_epoch: 1 + target_assignment_epoch: 1 + topology_epoch: 1 + state: STABLE + member_count: 2 + subtopology_count: 1 + members: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members + subtopologies: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/subtopologies + ListStreamsGroupSubtopologiesResponse: + description: The list of subtoplogies of the streams group + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupSubtopologyDataList' + example: + kind: KafkaStreamsGroupSubtopologyList + metadata: + self: http://localhost:8082/v3/clusters/cluster-1/streams-groups/streams-group-1/subtopologies + data: + - kind: KafkaStreamsSubtopology + metadata: + self: http://localhost:8082/v3/clusters/cluster-1/streams-groups/streams-group-1/subtopologies/subtopology-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/subtopology=subtopology-1 + cluster_id: cluster-1 + group_id: streams-group-1 + subtopology_id: subtopology-1 + source_topics: + - topic-1 + - topic-2 + GetStreamsGroupSubtopologyResponse: + description: The streams group subtopology. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupSubtopologyData' + example: + kind: KafkaStreamsGroupSubtopology + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/subtopologies/subtopology-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/subtopology=subtopology-1 + cluster_id: cluster-1 + group_id: streams-group-1 + subtopology_id: subtopology-1 + source_topics: + - topic-1 + - topic-2 + ListStreamsGroupMembersResponse: + description: The list of members of the streams group + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupMemberDataList' + example: + kind: KafkaStreamsGroupMemberList + metadata: + self: http://localhost:8082/v3/clusters/cluster-1/streams-groups/streams-group-1/members + data: + - kind: KafkaStreamsMember + metadata: + self: http://localhost:8082/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1 + cluster_id: cluster-1 + group_id: streams-group-1 + member_id: member-1 + process_id: process-1 + client_id: client-1 + instance_id: instance-1 + member_epoch: 2 + topology_epoch: 1 + is_classic: false + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments + target_assignment: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/target-assignment + GetStreamsGroupMemberResponse: + description: The streams group member. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupMemberData' + example: + kind: KafkaStreamsGroupMember + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1 + cluster_id: cluster-1 + group_id: streams-group-1 + member_id: member-1 + process_id: process-1 + client_id: client-1 + instance_id: instance-1 + member_epoch: 2 + topology_epoch: 1 + is_classic: false + assignments: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments + target_assignment: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/target-assignment + GetStreamsGroupMemberAssignmentsResponse: + description: The streams group member assignments. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsGroupMemberAssignmentData' + example: + kind: KafkaStreamsGroupMemberAssignments + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1/assignments + cluster_id: cluster-1 + group_id: streams-group-1 + member_id: member-1 + active_tasks: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments/active + standby_tasks: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignment/standby + warmup_tasks: + related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignment/warmup + ListStreamsTasksResponse: + description: The streams group member assignments of specific type. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsTaskDataList' + example: + kind: KafkaStreamsGroupMemberAssignments + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments/active/subtopologies/subtopology-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1/assignments=active/subtopology=subtopology-1 + data: + - kind: GetStreamsTaskResponse + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments/active/subtopologies/subtopology-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1/assignments=active/subtopology=subtopology-1 + subtopology_id: subtopology-1 + partition_ids: + - 0 + - 1 + - 2 + GetStreamsTaskResponse: + description: The partitions of a streams member task. + content: + application/json: + schema: + $ref: '#/components/schemas/StreamsTaskData' + example: + kind: KafkaStreamsGroupMemberAssignments + metadata: + self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/streams-groups/streams-group-1/members/member-1/assignments/active/subtopologies/subtopology-1 + resource_name: crn:///kafka=cluster-1/streams-group=streams-group-1/member=member-1/assignments=active/subtopology=subtopology-1 + subtopology_id: subtopology-1 + partition_ids: + - 0 + - 1 + - 2 + parameters: + ClusterId: + name: cluster_id + description: The Kafka cluster ID. + in: path + required: true + schema: + type: string + example: cluster-1 + GroupId: + name: group_id + description: The group ID. + in: path + required: true + schema: + type: string + example: group-1 + SubtopologyId: + name: subtopology_id + description: The streams subtopology ID. + in: path + required: true + schema: + type: string + example: subtopology-1 + MemberId: + name: member_id + description: The streams member ID. + in: path + required: true + schema: + type: string + example: member-1 + AssignmentsType: + name: assignments_type + description: The streams member Assignment type. + in: path + required: true + schema: + $ref: '#/components/schemas/AssignmentsType' + example: active +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/sts.yaml b/provider-dev/source/sts.yaml new file mode 100644 index 0000000..8e6c448 --- /dev/null +++ b/provider-dev/source/sts.yaml @@ -0,0 +1,431 @@ +openapi: 3.0.0 +info: + title: sts API + description: confluent sts API + version: 1.0.0 +paths: + /sts/v1/oauth2/token: + post: + description: | + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Use this operation to exchange an access token (JWT) issued by an external identity provider for + an access token (JWT) issued by Confluent.This enables the use of external identities + to access Confluent Cloud APIs. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + description: token exchange request parameters + properties: + api_version: + type: string + enum: + - sts/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TokenExchangeRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + grant_type: + type: string + x-extensible-enum: + - urn:ietf:params:oauth:grant-type:token-exchange + description: | + The grant type. Must be urn:ietf:params:oauth:grant-type:token-exchange, which indicates a token exchange. + example: urn:ietf:params:oauth:grant-type:token-exchange + subject_token: + type: string + description: Confluent Cloud only accepts JSON Web Token (JWT) access tokens from customer identity provider + example: test_jwt_token + identity_pool_id: + type: string + description: | + Identity pool is a group of external identities that are assigned a certain level of access based on policy + example: pool_1 + subject_token_type: + type: string + x-extensible-enum: + - urn:ietf:params:oauth:token-type:jwt + description: | + An identifier for the type of requested security token. Supported values + is urn:ietf:params:oauth:token-type:jwt. + example: urn:ietf:params:oauth:token-type:jwt + requested_token_type: + type: string + x-extensible-enum: + - urn:ietf:params:oauth:token-type:access_token + description: | + An identifier for the type of requested security token. + Supported values is urn:ietf:params:oauth:token-type:access_token. + example: urn:ietf:params:oauth:token-type:access_token + expires_in: + type: integer + format: int32 + description: | + The amount of time, in seconds, between the time when the access token was issued + and the time when the access token will expire + default: 900 + maximum: 900 + required: + - subject_token + - grant_type + - identity_pool_id + - subject_token_type + - requested_token_type + x-lifecycle-stage: General Availability + x-self-access: true + x-name: sts.v1.OauthToken + operationId: exchangeStsV1OauthToken + summary: Exchange an OAuth Token + tags: + - OAuth Tokens (sts/v1) + responses: + '200': + description: | + access token used to access public control plane api + content: + application/json: + schema: + $ref: '#/components/schemas/sts.v1.TokenExchangeReply' + '400': + $ref: '#/components/responses/BadRequestError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + sts.v1.TokenExchangeRequest: + type: object + description: token exchange request parameters + properties: + api_version: + type: string + enum: + - sts/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TokenExchangeRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + grant_type: + type: string + x-extensible-enum: + - urn:ietf:params:oauth:grant-type:token-exchange + description: | + The grant type. Must be urn:ietf:params:oauth:grant-type:token-exchange, which indicates a token exchange. + example: urn:ietf:params:oauth:grant-type:token-exchange + subject_token: + type: string + description: Confluent Cloud only accepts JSON Web Token (JWT) access tokens from customer identity provider + example: test_jwt_token + identity_pool_id: + type: string + description: | + Identity pool is a group of external identities that are assigned a certain level of access based on policy + example: pool_1 + subject_token_type: + type: string + x-extensible-enum: + - urn:ietf:params:oauth:token-type:jwt + description: | + An identifier for the type of requested security token. Supported values + is urn:ietf:params:oauth:token-type:jwt. + example: urn:ietf:params:oauth:token-type:jwt + requested_token_type: + type: string + x-extensible-enum: + - urn:ietf:params:oauth:token-type:access_token + description: | + An identifier for the type of requested security token. + Supported values is urn:ietf:params:oauth:token-type:access_token. + example: urn:ietf:params:oauth:token-type:access_token + expires_in: + type: integer + format: int32 + description: | + The amount of time, in seconds, between the time when the access token was issued + and the time when the access token will expire + default: 900 + maximum: 900 + sts.v1.TokenExchangeReply: + type: object + description: token exchange response + required: + - access_token + - issued_token_type + - token_type + - expires_in + properties: + access_token: + type: string + description: | + An JWT access token, issued by Confluent, in response to the token exchange request. + Client application could use the access token to access confluent public api + issued_token_type: + type: string + x-extensible-enum: + - urn:ietf:params:oauth:token-type:access_token + description: The token type. Always matches the value of requested_token_type from the request. + example: urn:ietf:params:oauth:token-type:access_token + token_type: + type: string + x-extensible-enum: + - Bearer + description: Indicates the token type value. The only type that Confluent supports is Bearer + example: Bearer + expires_in: + type: integer + format: int32 + description: The length of time, in seconds, that the access token is valid. + example: 3600 + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/tableflow.yaml b/provider-dev/source/tableflow.yaml new file mode 100644 index 0000000..42a1e1e --- /dev/null +++ b/provider-dev/source/tableflow.yaml @@ -0,0 +1,4216 @@ +openapi: 3.0.0 +info: + title: tableflow API + description: confluent tableflow API + version: 1.0.0 +paths: + /tableflow/v1/regions: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listTableflowV1Regions + summary: List of Regions + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all regions. + parameters: + - name: cloud + in: query + required: false + schema: + $ref: '#/components/schemas/SearchFilter' + example: AWS + description: Filter the results by exact match for cloud. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Regions (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Region. + content: + application/json: + schema: + type: object + description: |- + `Region` objects represent cloud provider regions where Tableflow can be enabled. + This API allows you to list all supported Tableflow regions. + + + ## The Regions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RegionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Region` objects represent cloud provider regions where Tableflow can be enabled. + This API allows you to list all supported Tableflow regions. + + + ## The Regions Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: + - AWS + example: AWS + x-immutable: true + readOnly: true + region: + type: string + description: The cloud service provider region. + example: us-east-2 + x-immutable: true + readOnly: true + required: + - id + - metadata + - cloud + - region + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /tableflow/v1/tableflow-topics: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listTableflowV1TableflowTopics + summary: List of Tableflow Topics + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all tableflow topics. + parameters: + - name: spec.table_formats + in: query + required: false + schema: + $ref: '#/components/schemas/MultipleSearchFilter' + example: + - DELTA + - ICEBERG + description: Filter the results by exact match for spec.table_formats. Pass multiple times to see results matching any of the values. + style: form + explode: true + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Filter the results by exact match for spec.kafka_cluster. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Tableflow Topics (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Tableflow Topic. + content: + application/json: + schema: + type: object + description: |- + A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic + + + ## The Tableflow Topics Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopicList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic + + + ## The Tableflow Topics Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + required: + - metadata + - spec + - status + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createTableflowV1TableflowTopic + summary: Create a Tableflow Topic + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a tableflow topic. + tags: + - Tableflow Topics (tableflow/v1) + security: + - resource-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic + + + ## The Tableflow Topics Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + required: + - spec + responses: + '202': + description: A Tableflow Topic is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/tableflow/v1/tableflow-topics/{id} + description: TableflowTopic resource uri + content: + application/json: + schema: + type: object + description: |- + A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic + + + ## The Tableflow Topics Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + required: + - spec + - status + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /tableflow/v1/tableflow-topics/{display_name}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getTableflowV1TableflowTopic + summary: Read a Tableflow Topic + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a tableflow topic. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Scope the operation to the given spec.kafka_cluster. + - name: display_name + in: path + required: true + schema: + type: string + description: The name of the Kafka topic for which Tableflow is enabled. + tags: + - Tableflow Topics (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Tableflow Topic. + content: + application/json: + schema: + type: object + description: |- + A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic + + + ## The Tableflow Topics Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + required: + - api_version + - kind + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateTableflowV1TableflowTopic + summary: Update a Tableflow Topic + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a tableflow topic. + + parameters: + - name: display_name + in: path + required: true + schema: + type: string + description: The name of the Kafka topic for which Tableflow is enabled. + tags: + - Tableflow Topics (tableflow/v1) + security: + - resource-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic + + + ## The Tableflow Topics Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + required: + - spec + responses: + '200': + description: Tableflow Topic. + content: + application/json: + schema: + type: object + description: |- + A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic + + + ## The Tableflow Topics Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + required: + - api_version + - kind + - spec + - status + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteTableflowV1TableflowTopic + summary: Delete a Tableflow Topic + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a tableflow topic. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Scope the operation to the given spec.kafka_cluster. + - name: display_name + in: path + required: true + schema: + type: string + description: The name of the Kafka topic for which Tableflow is enabled. + tags: + - Tableflow Topics (tableflow/v1) + security: + - resource-api-key: [] + responses: + '204': + description: A Tableflow Topic is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /tableflow/v1/catalog-integrations: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: listTableflowV1CatalogIntegrations + summary: List of Catalog Integrations + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all catalog integrations. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Filter the results by exact match for spec.kafka_cluster. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Catalog Integrations (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Catalog Integration. + content: + application/json: + schema: + type: object + description: |- + A Catalog Integration represents configuration related to a catalog integration + + + ## The Catalog Integrations Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegrationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + A Catalog Integration represents configuration related to a catalog integration + + + ## The Catalog Integrations Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSpec' + status: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationStatus' + required: + - id + - metadata + - spec + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: createTableflowV1CatalogIntegration + summary: Create a Catalog Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a catalog integration. + tags: + - Catalog Integrations (tableflow/v1) + security: + - resource-api-key: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + A Catalog Integration represents configuration related to a catalog integration + + + ## The Catalog Integrations Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSpec' + status: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationStatus' + required: + - spec + responses: + '202': + description: A Catalog Integration is being created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/tableflow/v1/catalog-integrations/{id} + description: CatalogIntegration resource uri + content: + application/json: + schema: + type: object + description: |- + A Catalog Integration represents configuration related to a catalog integration + + + ## The Catalog Integrations Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSpec' + status: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationStatus' + required: + - spec + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true + /tableflow/v1/catalog-integrations/{id}: + get: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: getTableflowV1CatalogIntegration + summary: Read a Catalog Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a catalog integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Scope the operation to the given spec.kafka_cluster. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the catalog integration. + tags: + - Catalog Integrations (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Catalog Integration. + content: + application/json: + schema: + type: object + description: |- + A Catalog Integration represents configuration related to a catalog integration + + + ## The Catalog Integrations Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSpec' + status: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationStatus' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + patch: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationUpdateRequest' + x-lifecycle-stage: General Availability + x-self-access: true + operationId: updateTableflowV1CatalogIntegration + summary: Update a Catalog Integration + description: |+ + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to update a catalog integration. + + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the catalog integration. + tags: + - Catalog Integrations (tableflow/v1) + security: + - resource-api-key: [] + responses: + '200': + description: Catalog Integration. + content: + application/json: + schema: + type: object + description: |- + A Catalog Integration represents configuration related to a catalog integration + + + ## The Catalog Integrations Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSpec' + status: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationStatus' + required: + - api_version + - kind + - id + - spec + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: General Availability + x-self-access: true + operationId: deleteTableflowV1CatalogIntegration + summary: Delete a Catalog Integration + description: |- + [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a catalog integration. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: spec.kafka_cluster + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: lkc-00000 + description: Scope the operation to the given spec.kafka_cluster. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the catalog integration. + tags: + - Catalog Integrations (tableflow/v1) + security: + - resource-api-key: [] + responses: + '204': + description: A Catalog Integration is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: General Availability + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + tableflow.v1.RegionList: + type: object + description: |- + `Region` objects represent cloud provider regions where Tableflow can be enabled. + This API allows you to list all supported Tableflow regions. + + + ## The Regions Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - RegionList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `Region` objects represent cloud provider regions where Tableflow can be enabled. + This API allows you to list all supported Tableflow regions. + + + ## The Regions Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: + - AWS + example: AWS + x-immutable: true + readOnly: true + region: + type: string + description: The cloud service provider region. + example: us-east-2 + x-immutable: true + readOnly: true + required: + - id + - metadata + - cloud + - region + uniqueItems: true + MultipleSearchFilter: + description: Filter a collection by a string search for one or more values + type: array + items: + type: string + tableflow.v1.TableflowTopicList: + type: object + description: |- + A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic + + + ## The Tableflow Topics Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopicList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic + + + ## The Tableflow Topics Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + required: + - metadata + - spec + - status + uniqueItems: true + tableflow.v1.TableflowTopic: + type: object + description: |- + A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic + + + ## The Tableflow Topics Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - TableflowTopic + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicSpec' + status: + $ref: '#/components/schemas/tableflow.v1.TableflowTopicStatus' + tableflow.v1.CatalogIntegrationList: + type: object + description: |- + A Catalog Integration represents configuration related to a catalog integration + + + ## The Catalog Integrations Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegrationList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + A Catalog Integration represents configuration related to a catalog integration + + + ## The Catalog Integrations Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSpec' + status: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationStatus' + required: + - id + - metadata + - spec + uniqueItems: true + tableflow.v1.CatalogIntegration: + type: object + description: |- + A Catalog Integration represents configuration related to a catalog integration + + + ## The Catalog Integrations Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegration + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationSpec' + status: + $ref: '#/components/schemas/tableflow.v1.CatalogIntegrationStatus' + tableflow.v1.CatalogIntegrationUpdateRequest: + type: object + description: The desired state of the Catalog Integration + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - CatalogIntegrationUpdateRequest + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + spec: + type: object + description: The desired state of the Catalog Integration + required: + - environment + - kafka_cluster + properties: + display_name: + type: string + description: The name of the catalog integration + example: catalog_integration_1 + suspended: + type: boolean + description: Indicates whether the Catalog Integration should be suspended. + example: false + config: + type: object + description: The integration config + discriminator: + propertyName: kind + mapping: + AwsGlue: '#/components/schemas/tableflow.v1.CatalogIntegrationAwsGlueUpdateSpec' + Snowflake: '#/components/schemas/tableflow.v1.CatalogIntegrationSnowflakeUpdateSpec' + Unity: '#/components/schemas/tableflow.v1.CatalogIntegrationUnityUpdateSpec' + required: + - kind + properties: + kind: + type: string + enum: + - AwsGlue + description: The type of the catalog integration. + x-immutable: true + endpoint: + description: The catalog integration connection endpoint for Snowflake Open Catalog. + type: string + example: https://vuser1_polaris.snowflakecomputing.com/ + client_id: + description: The client ID of the catalog integration. + type: string + client_secret: + description: The client secret of the catalog integration. + type: string + warehouse: + description: Warehouse name of the Snowflake Open Catalog. + type: string + allowed_scope: + description: Allowed scope of the Snowflake Open Catalog. + type: string + workspace_endpoint: + type: string + description: The Databricks workspace URL associated with the Unity Catalog. + example: https://user1.cloud.databricks.com + catalog_name: + type: string + description: The name of the catalog within Unity Catalog. + environment: + description: The environment to which the target Kafka cluster belongs. + example: + id: env-00000 + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + description: The kafka cluster of the topic for which Tableflow is enabled + example: + id: lkc-00000 + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + tableflow.v1.Region: + type: object + description: |- + `Region` objects represent cloud provider regions where Tableflow can be enabled. + This API allows you to list all supported Tableflow regions. + + + ## The Regions Model + + properties: + api_version: + type: string + enum: + - tableflow/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - Region + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + metadata: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + cloud: + type: string + description: The cloud service provider that hosts the region. + x-extensible-enum: + - AWS + example: AWS + x-immutable: true + readOnly: true + region: + type: string + description: The cloud service provider region. + example: us-east-2 + x-immutable: true + readOnly: true + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + ObjectMeta: + description: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + required: + - self + properties: + self: + description: Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time + type: string + format: uri + readOnly: true + example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de + resource_name: + description: Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name + type: string + format: uri + readOnly: true + example: crn://confluent.cloud/kafka=lkc-f3a90de + created_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. + updated_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. + deleted_at: + type: string + format: date-time + example: '2006-01-02T15:04:05-07:00' + readOnly: true + description: The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. + readOnly: true + type: object + tableflow.v1.TableflowTopicSpec: + type: object + description: The desired state of the Tableflow Topic + properties: + display_name: + type: string + description: The name of the Kafka topic for which Tableflow is enabled. + example: topic_1 + x-immutable: true + suspended: + type: boolean + description: Indicates whether the Tableflow should be suspended. The API allows setting it only to `false` i.e., to resume the Tableflow. Pausing the Tableflow on-demand is not currently supported. + example: false + config: + type: object + description: The config for the Tableflow enabled topic + properties: + enable_compaction: + description: This flag determines whether to enable compaction for the Tableflow enabled topic. + type: boolean + example: true + x-immutable: true + readOnly: true + enable_partitioning: + description: This flag determines whether to enable partitioning for the Tableflow enabled topic. + type: boolean + example: true + x-immutable: true + readOnly: true + retention_ms: + description: | + The maximum age, in milliseconds, of snapshots (for Iceberg) or versions (for Delta) + to retain in the table for the Tableflow-enabled topic (snapshot/version expiration). + + The default value is "604800000" milliseconds (equivalent to 7 days). + + The minimum allowed value is "86400000" milliseconds (equivalent to 24 hours). + type: string + format: int64 + example: '7776000000' + data_retention_ms: + description: | + The maximum age, in milliseconds, of data to retain in the table for the Tableflow-enabled topic. + + The minimum allowed non-zero value is "2592000000" milliseconds (equivalent to 30 days). + + Set to "0" to disable data retention (keep all data indefinitely). + type: string + format: int64 + example: '2592000000' + record_failure_strategy: + description: | + The strategy to handle record failures in the Tableflow enabled topic during materialization. + + For `SKIP`, we skip the bad records and move to the next record, + + and for `SUSPEND`, we suspend the materialization of the topic. + type: string + x-extensible-enum: + - SUSPEND + - SKIP + default: SUSPEND + deprecated: true + error_handling: + type: object + description: | + The error mode to handle record failures in the Tableflow enabled topic during materialization. + + for `SKIP`, we skip the bad records and move to the next record, + + for `SUSPEND`, we suspend the materialization of the topic, + + and for `LOG`, we log the bad records to the DLQ and continue processing the rest of the records. + discriminator: + propertyName: mode + mapping: + SUSPEND: '#/components/schemas/tableflow.v1.ErrorHandlingSuspend' + SKIP: '#/components/schemas/tableflow.v1.ErrorHandlingSkip' + LOG: '#/components/schemas/tableflow.v1.ErrorHandlingLog' + properties: + mode: + type: string + enum: + - SUSPEND + description: | + The error handling mode for the Tableflow enabled topic. + + In this mode, the materialization of the topic is suspended in case of record failures. + target: + type: string + description: | + The topic to which the bad records will be logged in case of `LOG` error handling mode. + + Creates the topic if it doesn't already exist; otherwise, the operation is idempotent and no action is taken. + + Default topic is `error_log`. + default: error_log + required: + - mode + storage: + type: object + description: The storage config + discriminator: + propertyName: kind + mapping: + ByobAws: '#/components/schemas/tableflow.v1.ByobAwsSpec' + Managed: '#/components/schemas/tableflow.v1.ManagedStorageSpec' + AzureDataLakeStorageGen2: '#/components/schemas/tableflow.v1.AzureAdlsSpec' + x-immutable: true + required: + - kind + - bucket_name + - provider_integration_id + - storage_account_name + - container_name + properties: + kind: + type: string + enum: + - ByobAws + description: | + The storage type + x-immutable: true + bucket_name: + description: Bucket name + type: string + example: bucket_1 + x-immutable: true + bucket_region: + description: Bucket region + type: string + example: us-east-1 + x-immutable: true + readOnly: true + provider_integration_id: + type: string + description: The provider integration id + example: cspi-stgce89r7 + x-immutable: true + table_path: + type: string + description: The current storage path where the data and metadata is stored for this table + example: s3://dummy-bucket-name-1/10011010/11101100/org-1/env-2/lkc-3/v1/tableId + readOnly: true + storage_account_name: + description: Storage Account Name + type: string + example: confluentstorage1 + x-immutable: true + container_name: + description: Container name + type: string + example: container-tableflow + x-immutable: true + storage_region: + description: Storage account region + type: string + example: centralus + readOnly: true + table_formats: + type: array + description: | + The supported table formats for the Tableflow-enabled topic. + items: + type: string + x-extensible-enum: + - DELTA + - ICEBERG + minItems: 1 + uniqueItems: true + example: + - DELTA + default: + - ICEBERG + environment: + description: The environment to which the target Kafka cluster belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + description: The kafka cluster of the topic for which Tableflow is enabled + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: false + x-enable-listmeta: true + x-enable-objectmeta: true + tableflow.v1.TableflowTopicStatus: + type: object + required: + - write_mode + description: The status of the Tableflow Topic + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - RUNNING + - FAILED + description: | + The lifecycle phase of the Tableflow: + + PENDING: Tableflow setup is pending; + + RUNNING: Tableflow is currently running; + + FAILED: Tableflow failed + example: PENDING + readOnly: true + error_message: + type: string + description: Displayable error message if Tableflow topic is in an error state + example: Could not enable catalog integration + readOnly: true + catalog_sync_statuses: + type: array + description: | + List of associated catalogs and their synchronization statuses for this Tableflow topic. + items: + $ref: '#/components/schemas/tableflow.v1.CatalogSyncStatus' + readOnly: true + failing_table_formats: + type: array + items: + type: object + properties: + format: + type: string + description: The name of the table format (e.g., DELTA, ICEBERG). + x-extensible-enum: + - DELTA + - ICEBERG + error_message: + type: string + description: The error message for the failing table format. + required: + - format + - error_message + description: | + List of failing table formats for the Tableflow-enabled topic, including error details. + example: + - format: ICEBERG + error_message: Schema validation failed + - format: DELTA + error_message: Connection timeout + readOnly: true + write_mode: + type: string + description: | + The write mode for the Tableflow-enabled topic, determining how data is written to the table. + x-extensible-enum: + - APPEND + - UPSERT + - UPSERT_HISTORY + example: APPEND + readOnly: true + readOnly: true + tableflow.v1.CatalogIntegrationSpec: + type: object + description: The desired state of the Catalog Integration + properties: + display_name: + type: string + description: The name of the catalog integration + example: catalog_integration_1 + suspended: + type: boolean + description: Indicates whether the Catalog Integration should be suspended. The API allows setting it only to `false` i.e., to resume the Catalog Integration. Pausing the Catalog Integration on-demand is not currently supported. + example: false + config: + type: object + description: The integration config + discriminator: + propertyName: kind + mapping: + AwsGlue: '#/components/schemas/tableflow.v1.CatalogIntegrationAwsGlueSpec' + Snowflake: '#/components/schemas/tableflow.v1.CatalogIntegrationSnowflakeSpec' + Unity: '#/components/schemas/tableflow.v1.CatalogIntegrationUnitySpec' + required: + - kind + - provider_integration_id + - endpoint + - client_id + - client_secret + - warehouse + - allowed_scope + - workspace_endpoint + - catalog_name + properties: + kind: + type: string + enum: + - AwsGlue + description: The type of the catalog integration. + x-immutable: true + provider_integration_id: + type: string + description: The provider integration id. + example: cspi-stgce89r7 + x-immutable: true + endpoint: + description: | + The catalog integration connection endpoint for Snowflake Open Catalog. + type: string + example: https://vuser1_polaris.snowflakecomputing.com/ + client_id: + description: The client ID of the catalog integration. + type: string + client_secret: + description: The client secret of the catalog integration. + type: string + warehouse: + description: Warehouse name of the Snowflake Open Catalog. + type: string + allowed_scope: + description: Allowed scope of the Snowflake Open Catalog. + type: string + workspace_endpoint: + type: string + description: The Databricks workspace URL associated with the Unity Catalog. + example: https://user1.cloud.databricks.com + catalog_name: + type: string + description: The name of the catalog within Unity Catalog. + environment: + description: The environment to which the target Kafka cluster belongs. + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + description: The kafka cluster of the topic for which Tableflow is enabled + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + x-enable-id: true + x-enable-listmeta: true + x-enable-objectmeta: true + tableflow.v1.CatalogIntegrationStatus: + description: The status of the Catalog Integration + type: object + properties: + phase: + type: string + x-extensible-enum: + - PENDING + - CONNECTED + - FAILED + description: | + The lifecycle phase of the catalog integration: + + PENDING: sync to catalog integration is pending; + + CONNECTED: catalog integration is connected and syncing; + + FAILED: catalog integration failed. + example: CONNECTED + readOnly: true + error_message: + type: string + description: Displayable error message if catalog integration is in a failed state. + example: Could not enable catalog integration + readOnly: true + last_sync_at: + type: string + description: | + The date and time at which the catalog was last synced. It is represented in RFC3339 format and is in UTC. + readOnly: true + readOnly: true + tableflow.v1.CatalogIntegrationUpdateSpec: + type: object + description: The desired state of the Catalog Integration + required: + - environment + - kafka_cluster + properties: + display_name: + type: string + description: The name of the catalog integration + example: catalog_integration_1 + suspended: + type: boolean + description: Indicates whether the Catalog Integration should be suspended. + example: false + config: + type: object + description: The integration config + discriminator: + propertyName: kind + mapping: + AwsGlue: '#/components/schemas/tableflow.v1.CatalogIntegrationAwsGlueUpdateSpec' + Snowflake: '#/components/schemas/tableflow.v1.CatalogIntegrationSnowflakeUpdateSpec' + Unity: '#/components/schemas/tableflow.v1.CatalogIntegrationUnityUpdateSpec' + required: + - kind + properties: + kind: + type: string + enum: + - AwsGlue + description: The type of the catalog integration. + x-immutable: true + endpoint: + description: The catalog integration connection endpoint for Snowflake Open Catalog. + type: string + example: https://vuser1_polaris.snowflakecomputing.com/ + client_id: + description: The client ID of the catalog integration. + type: string + client_secret: + description: The client secret of the catalog integration. + type: string + warehouse: + description: Warehouse name of the Snowflake Open Catalog. + type: string + allowed_scope: + description: Allowed scope of the Snowflake Open Catalog. + type: string + workspace_endpoint: + type: string + description: The Databricks workspace URL associated with the Unity Catalog. + example: https://user1.cloud.databricks.com + catalog_name: + type: string + description: The name of the catalog within Unity Catalog. + environment: + description: The environment to which the target Kafka cluster belongs. + example: + id: env-00000 + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + kafka_cluster: + description: The kafka cluster of the topic for which Tableflow is enabled + example: + id: lkc-00000 + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + tableflow.v1.TableFlowTopicConfigsSpec: + type: object + description: The configs for the Tableflow enabled topic + properties: + enable_compaction: + description: This flag determines whether to enable compaction for the Tableflow enabled topic. + type: boolean + example: true + x-immutable: true + readOnly: true + enable_partitioning: + description: This flag determines whether to enable partitioning for the Tableflow enabled topic. + type: boolean + example: true + x-immutable: true + readOnly: true + retention_ms: + description: | + The maximum age, in milliseconds, of snapshots (for Iceberg) or versions (for Delta) + to retain in the table for the Tableflow-enabled topic (snapshot/version expiration). + + The default value is "604800000" milliseconds (equivalent to 7 days). + + The minimum allowed value is "86400000" milliseconds (equivalent to 24 hours). + type: string + format: int64 + example: '7776000000' + data_retention_ms: + description: | + The maximum age, in milliseconds, of data to retain in the table for the Tableflow-enabled topic. + + The minimum allowed non-zero value is "2592000000" milliseconds (equivalent to 30 days). + + Set to "0" to disable data retention (keep all data indefinitely). + type: string + format: int64 + example: '2592000000' + record_failure_strategy: + description: | + The strategy to handle record failures in the Tableflow enabled topic during materialization. + + For `SKIP`, we skip the bad records and move to the next record, + + and for `SUSPEND`, we suspend the materialization of the topic. + type: string + x-extensible-enum: + - SUSPEND + - SKIP + default: SUSPEND + deprecated: true + error_handling: + type: object + description: | + The error mode to handle record failures in the Tableflow enabled topic during materialization. + + for `SKIP`, we skip the bad records and move to the next record, + + for `SUSPEND`, we suspend the materialization of the topic, + + and for `LOG`, we log the bad records to the DLQ and continue processing the rest of the records. + discriminator: + propertyName: mode + mapping: + SUSPEND: '#/components/schemas/tableflow.v1.ErrorHandlingSuspend' + SKIP: '#/components/schemas/tableflow.v1.ErrorHandlingSkip' + LOG: '#/components/schemas/tableflow.v1.ErrorHandlingLog' + properties: + mode: + type: string + enum: + - SUSPEND + description: | + The error handling mode for the Tableflow enabled topic. + + In this mode, the materialization of the topic is suspended in case of record failures. + target: + type: string + description: | + The topic to which the bad records will be logged in case of `LOG` error handling mode. + + Creates the topic if it doesn't already exist; otherwise, the operation is idempotent and no action is taken. + + Default topic is `error_log`. + default: error_log + required: + - mode + tableflow.v1.ByobAwsSpec: + type: object + description: The Tableflow storage config for BYOB enabled topic in AWS + required: + - kind + - bucket_name + - provider_integration_id + properties: + kind: + type: string + enum: + - ByobAws + description: | + The storage type + x-immutable: true + bucket_name: + description: Bucket name + type: string + example: bucket_1 + x-immutable: true + bucket_region: + description: Bucket region + type: string + example: us-east-1 + x-immutable: true + readOnly: true + provider_integration_id: + type: string + description: The provider integration id + example: cspi-stgce89r7 + x-immutable: true + table_path: + type: string + description: The current storage path where the data and metadata is stored for this table + example: s3://dummy-bucket-name-1/10011010/11101100/org-1/env-2/lkc-3/v1/tableId + readOnly: true + tableflow.v1.ManagedStorageSpec: + type: object + description: The storage config for confluent managed Tableflow enabled topic. + required: + - kind + properties: + kind: + type: string + enum: + - Managed + description: | + The storage type. + x-immutable: true + table_path: + type: string + description: The current storage path where the data and metadata is stored for this table + example: s3://dummy-bucket-name-1/10011010/11101100/org-1/env-2/lkc-3/v1/tableId + readOnly: true + tableflow.v1.AzureAdlsSpec: + type: object + description: The Tableflow storage config for customer-owned Azure Data Lake Storage Gen2 + required: + - kind + - storage_account_name + - container_name + - provider_integration_id + properties: + kind: + type: string + enum: + - AzureDataLakeStorageGen2 + description: | + The storage type. + x-immutable: true + storage_account_name: + description: Storage Account Name + type: string + example: confluentstorage1 + x-immutable: true + container_name: + description: Container name + type: string + example: container-tableflow + x-immutable: true + storage_region: + description: Storage account region + type: string + example: centralus + readOnly: true + provider_integration_id: + type: string + description: The provider integration id + example: cspi-6nxn5 + x-immutable: true + table_path: + type: string + description: The current storage path where the data and metadata is stored for this table + example: abfss://container@account.dfs.core.windows.net/10011010/11101100/org/env/lkc/v1/tableId + readOnly: true + GlobalObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + EnvScopedObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + tableflow.v1.CatalogSyncStatus: + type: object + description: The synchronization status of an external catalog for a Tableflow topic + properties: + catalog_integration_id: + type: string + description: The ID of the catalog integration + example: tci-12345 + catalog_type: + type: string + description: The type of the external catalog + x-extensible-enum: + - AWS_GLUE + - SNOWFLAKE + - UNITY + example: AWS_GLUE + sync_status: + type: string + description: | + The current synchronization status: + + PENDING: sync is pending; + + SYNCED: successfully synced; + + FAILED: sync failed; + + DISCONNECTED: catalog integration is disconnected. + x-extensible-enum: + - PENDING + - SYNCED + - FAILED + - DISCONNECTED + example: SYNCED + error_message: + type: string + nullable: true + description: | + Error message if the sync failed. This field is only present when `sync_status` is `FAILED`. + example: 'Failed to connect to catalog: authentication error' + tableflow.v1.CatalogIntegrationAwsGlueSpec: + type: object + description: The catalog integration Glue connection config. + required: + - kind + - provider_integration_id + properties: + kind: + type: string + enum: + - AwsGlue + description: The type of the catalog integration. + x-immutable: true + provider_integration_id: + type: string + description: The provider integration id. + example: cspi-stgce89r7 + x-immutable: true + tableflow.v1.CatalogIntegrationSnowflakeSpec: + type: object + description: The catalog integration connection config for Snowflake Open Catalog. + required: + - kind + - endpoint + - client_id + - client_secret + - warehouse + - allowed_scope + properties: + kind: + type: string + enum: + - Snowflake + description: The type of the catalog integration. + endpoint: + description: | + The catalog integration connection endpoint for Snowflake Open Catalog. + type: string + example: https://vuser1_polaris.snowflakecomputing.com/ + client_id: + description: The client ID of the catalog integration. + type: string + client_secret: + description: The client secret of the catalog integration. + type: string + warehouse: + description: Warehouse name of the Snowflake Open Catalog. + type: string + allowed_scope: + description: Allowed scope of the Snowflake Open Catalog. + type: string + tableflow.v1.CatalogIntegrationUnitySpec: + type: object + description: The catalog integration connection config for Unity Catalog. + required: + - kind + - workspace_endpoint + - catalog_name + - client_id + - client_secret + properties: + kind: + type: string + enum: + - Unity + description: The type of the catalog integration. + workspace_endpoint: + type: string + description: The Databricks workspace URL associated with the Unity Catalog. + example: https://user1.cloud.databricks.com + catalog_name: + type: string + description: The name of the catalog within Unity Catalog. + client_id: + type: string + description: The OAuth client ID used to authenticate with the Unity Catalog. + client_secret: + type: string + description: The OAuth client secret used for authentication with the Unity Catalog. + tableflow.v1.CatalogIntegrationAwsGlueUpdateSpec: + type: object + description: The catalog integration Glue connection config for update operations. + required: + - kind + properties: + kind: + type: string + enum: + - AwsGlue + description: The type of the catalog integration. + x-immutable: true + tableflow.v1.CatalogIntegrationSnowflakeUpdateSpec: + type: object + description: The catalog integration connection config for Snowflake Open Catalog (update operations). + required: + - kind + properties: + kind: + type: string + enum: + - Snowflake + description: The type of the catalog integration. + endpoint: + description: The catalog integration connection endpoint for Snowflake Open Catalog. + type: string + example: https://vuser1_polaris.snowflakecomputing.com/ + client_id: + description: The client ID of the catalog integration. + type: string + client_secret: + description: The client secret of the catalog integration. + type: string + warehouse: + description: Warehouse name of the Snowflake Open Catalog. + type: string + allowed_scope: + description: Allowed scope of the Snowflake Open Catalog. + type: string + tableflow.v1.CatalogIntegrationUnityUpdateSpec: + type: object + description: The catalog integration connection config for Unity Catalog. + required: + - kind + properties: + kind: + type: string + enum: + - Unity + description: The type of the catalog integration. + workspace_endpoint: + type: string + description: The Databricks workspace URL associated with the Unity Catalog. + example: https://user1.cloud.databricks.com + catalog_name: + type: string + description: The name of the catalog within Unity Catalog. + client_id: + type: string + description: The OAuth client ID used to authenticate with the Unity Catalog. + client_secret: + type: string + description: The OAuth client secret used for authentication with the Unity Catalog. + tableflow.v1.ErrorHandlingSuspend: + type: object + description: | + Configuration for the `SUSPEND` error handling mode. + properties: + mode: + type: string + enum: + - SUSPEND + description: | + The error handling mode for the Tableflow enabled topic. + + In this mode, the materialization of the topic is suspended in case of record failures. + required: + - mode + tableflow.v1.ErrorHandlingSkip: + type: object + description: | + Configuration for the `SKIP` error handling mode. + properties: + mode: + type: string + enum: + - SKIP + description: | + The error handling mode for the Tableflow enabled topic. + + In this mode, the bad records are skipped and the materialization continues with the next record. + required: + - mode + tableflow.v1.ErrorHandlingLog: + type: object + description: | + Configuration for the `LOG` error handling mode. + properties: + mode: + type: string + enum: + - LOG + description: | + The error handling mode for the Tableflow enabled topic. + + In this mode, the bad records are logged to a dead-letter queue (DLQ) topic and the + + materialization continues with the next record. + target: + type: string + description: | + The topic to which the bad records will be logged in case of `LOG` error handling mode. + + Creates the topic if it doesn't already exist; otherwise, the operation is idempotent and no action is taken. + + Default topic is `error_log`. + default: error_log + required: + - mode + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/provider-dev/source/usm.yaml b/provider-dev/source/usm.yaml new file mode 100644 index 0000000..548e643 --- /dev/null +++ b/provider-dev/source/usm.yaml @@ -0,0 +1,2445 @@ +openapi: 3.0.0 +info: + title: usm API + description: confluent usm API + version: 1.0.0 +paths: + /usm/v1/kafka-clusters: + get: + x-lifecycle-stage: Preview + x-self-access: true + operationId: listUsmV1KafkaClusters + summary: List of Kafka Clusters + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all kafka clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Kafka Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Kafka Cluster. + content: + application/json: + schema: + type: object + description: |- + `KafkaCluster` object represent Confluent Platform Kafka clusters registered with Confluent Cloud. + The API allows you to create and delete KafkaCluster. + + + ## The Kafka Clusters Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `KafkaCluster` object represent Confluent Platform Kafka clusters registered with Confluent Cloud. + The API allows you to create and delete KafkaCluster. + + + ## The Kafka Clusters Model + + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaCluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + description: A human-readable name for the Confluent Platform Kafka cluster. + example: My-Prod-CP-Cluster + confluent_platform_kafka_cluster_id: + type: string + description: The unique identifier of the Kafka cluster within the Confluent Platform environment. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: The cloud service provider where the metadata for the Kafka Cluster should be stored. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: The home region of the Confluent Platform Kafka cluster where the metadata should be stored. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - display_name + - confluent_platform_kafka_cluster_id + - cloud + - region + - environment + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Preview + x-self-access: true + operationId: createUsmV1KafkaCluster + summary: Create a Kafka Cluster + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a kafka cluster. + tags: + - Kafka Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `KafkaCluster` object represent Confluent Platform Kafka clusters registered with Confluent Cloud. + The API allows you to create and delete KafkaCluster. + + + ## The Kafka Clusters Model + + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaCluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + description: A human-readable name for the Confluent Platform Kafka cluster. + example: My-Prod-CP-Cluster + confluent_platform_kafka_cluster_id: + type: string + description: The unique identifier of the Kafka cluster within the Confluent Platform environment. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: The cloud service provider where the metadata for the Kafka Cluster should be stored. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: The home region of the Confluent Platform Kafka cluster where the metadata should be stored. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - display_name + - confluent_platform_kafka_cluster_id + - cloud + - region + - environment + responses: + '201': + description: A Kafka Cluster was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/usm/v1/kafka-clusters/{id} + description: KafkaCluster resource uri + content: + application/json: + schema: + type: object + description: |- + `KafkaCluster` object represent Confluent Platform Kafka clusters registered with Confluent Cloud. + The API allows you to create and delete KafkaCluster. + + + ## The Kafka Clusters Model + + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaCluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + description: A human-readable name for the Confluent Platform Kafka cluster. + example: My-Prod-CP-Cluster + confluent_platform_kafka_cluster_id: + type: string + description: The unique identifier of the Kafka cluster within the Confluent Platform environment. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: The cloud service provider where the metadata for the Kafka Cluster should be stored. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: The home region of the Confluent Platform Kafka cluster where the metadata should be stored. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - display_name + - confluent_platform_kafka_cluster_id + - cloud + - region + - environment + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Preview + x-self-access: true + /usm/v1/kafka-clusters/{id}: + get: + x-lifecycle-stage: Preview + x-self-access: true + operationId: getUsmV1KafkaCluster + summary: Read a Kafka Cluster + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a kafka cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the kafka cluster. + tags: + - Kafka Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Kafka Cluster. + content: + application/json: + schema: + type: object + description: |- + `KafkaCluster` object represent Confluent Platform Kafka clusters registered with Confluent Cloud. + The API allows you to create and delete KafkaCluster. + + + ## The Kafka Clusters Model + + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaCluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + description: A human-readable name for the Confluent Platform Kafka cluster. + example: My-Prod-CP-Cluster + confluent_platform_kafka_cluster_id: + type: string + description: The unique identifier of the Kafka cluster within the Confluent Platform environment. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: The cloud service provider where the metadata for the Kafka Cluster should be stored. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: The home region of the Confluent Platform Kafka cluster where the metadata should be stored. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - display_name + - confluent_platform_kafka_cluster_id + - cloud + - region + - environment + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Preview + x-self-access: true + operationId: deleteUsmV1KafkaCluster + summary: Delete a Kafka Cluster + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a kafka cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the kafka cluster. + tags: + - Kafka Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Kafka Cluster is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Preview + x-self-access: true + /usm/v1/connect-clusters: + get: + x-lifecycle-stage: Preview + x-self-access: true + operationId: listUsmV1ConnectClusters + summary: List of Connect Clusters + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Retrieve a sorted, filtered, paginated list of all connect clusters. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Filter the results by exact match for environment. + - name: page_size + in: query + required: false + schema: + type: integer + default: 10 + maximum: 100 + x-max-page-items: 500 + description: A pagination size for collection requests. + - name: page_token + in: query + required: false + schema: + type: string + maxLength: 255 + description: An opaque pagination token for collection requests. + tags: + - Connect Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connect Cluster. + content: + application/json: + schema: + type: object + description: |- + `ConnectCluster` object represent Confluent Platform Connect clusters registered with Confluent Cloud. + The API allows you to create and delete ConnectCluster. + + + ## The Connect Clusters Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ConnectCluster` object represent Confluent Platform Connect clusters registered with Confluent Cloud. + The API allows you to create and delete ConnectCluster. + + + ## The Connect Clusters Model + + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectCluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + confluent_platform_connect_cluster_id: + type: string + description: The unique identifier of the Connect cluster within the Confluent Platform environment. + example: connect-group-xyz123 + x-immutable: true + kafka_cluster_id: + type: string + description: | + The unique identifier of the metadata Kafka cluster for the Connect Cluster. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: | + The cloud service provider where the metadata for the Connect Cluster should be stored. + This field is optional. If provided, 'region' must also be provided. + If neither 'cloud' nor 'region' are provided, the cloud provider of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: | + The home region of the Confluent Platform Connect cluster where the metadata should be stored. + This field is optional. If provided, 'cloud' must also be provided. + If neither 'cloud' nor 'region' are provided, the home region of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - confluent_platform_connect_cluster_id + - kafka_cluster_id + - environment + uniqueItems: true + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + post: + x-lifecycle-stage: Preview + x-self-access: true + operationId: createUsmV1ConnectCluster + summary: Create a Connect Cluster + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to create a connect cluster. + tags: + - Connect Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + requestBody: + content: + application/json: + schema: + type: object + description: |- + `ConnectCluster` object represent Confluent Platform Connect clusters registered with Confluent Cloud. + The API allows you to create and delete ConnectCluster. + + + ## The Connect Clusters Model + + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectCluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + confluent_platform_connect_cluster_id: + type: string + description: The unique identifier of the Connect cluster within the Confluent Platform environment. + example: connect-group-xyz123 + x-immutable: true + kafka_cluster_id: + type: string + description: | + The unique identifier of the metadata Kafka cluster for the Connect Cluster. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: | + The cloud service provider where the metadata for the Connect Cluster should be stored. + This field is optional. If provided, 'region' must also be provided. + If neither 'cloud' nor 'region' are provided, the cloud provider of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: | + The home region of the Confluent Platform Connect cluster where the metadata should be stored. + This field is optional. If provided, 'cloud' must also be provided. + If neither 'cloud' nor 'region' are provided, the home region of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - confluent_platform_connect_cluster_id + - kafka_cluster_id + - environment + responses: + '201': + description: A Connect Cluster was created. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/usm/v1/connect-clusters/{id} + description: ConnectCluster resource uri + content: + application/json: + schema: + type: object + description: |- + `ConnectCluster` object represent Confluent Platform Connect clusters registered with Confluent Cloud. + The API allows you to create and delete ConnectCluster. + + + ## The Connect Clusters Model + + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectCluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + confluent_platform_connect_cluster_id: + type: string + description: The unique identifier of the Connect cluster within the Confluent Platform environment. + example: connect-group-xyz123 + x-immutable: true + kafka_cluster_id: + type: string + description: | + The unique identifier of the metadata Kafka cluster for the Connect Cluster. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: | + The cloud service provider where the metadata for the Connect Cluster should be stored. + This field is optional. If provided, 'region' must also be provided. + If neither 'cloud' nor 'region' are provided, the cloud provider of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: | + The home region of the Confluent Platform Connect cluster where the metadata should be stored. + This field is optional. If provided, 'cloud' must also be provided. + If neither 'cloud' nor 'region' are provided, the home region of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - confluent_platform_connect_cluster_id + - kafka_cluster_id + - environment + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '409': + $ref: '#/components/responses/ConflictError' + '422': + $ref: '#/components/responses/ValidationError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Preview + x-self-access: true + /usm/v1/connect-clusters/{id}: + get: + x-lifecycle-stage: Preview + x-self-access: true + operationId: getUsmV1ConnectCluster + summary: Read a Connect Cluster + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to read a connect cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the connect cluster. + tags: + - Connect Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '200': + description: Connect Cluster. + content: + application/json: + schema: + type: object + description: |- + `ConnectCluster` object represent Confluent Platform Connect clusters registered with Confluent Cloud. + The API allows you to create and delete ConnectCluster. + + + ## The Connect Clusters Model + + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectCluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + confluent_platform_connect_cluster_id: + type: string + description: The unique identifier of the Connect cluster within the Confluent Platform environment. + example: connect-group-xyz123 + x-immutable: true + kafka_cluster_id: + type: string + description: | + The unique identifier of the metadata Kafka cluster for the Connect Cluster. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: | + The cloud service provider where the metadata for the Connect Cluster should be stored. + This field is optional. If provided, 'region' must also be provided. + If neither 'cloud' nor 'region' are provided, the cloud provider of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: | + The home region of the Confluent Platform Connect cluster where the metadata should be stored. + This field is optional. If provided, 'cloud' must also be provided. + If neither 'cloud' nor 'region' are provided, the home region of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - api_version + - kind + - id + - confluent_platform_connect_cluster_id + - kafka_cluster_id + - environment + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + delete: + x-lifecycle-stage: Preview + x-self-access: true + operationId: deleteUsmV1ConnectCluster + summary: Delete a Connect Cluster + description: |- + [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) + + Make a request to delete a connect cluster. + parameters: + - name: environment + in: query + required: true + schema: + $ref: '#/components/schemas/SearchFilter' + example: env-00000 + description: Scope the operation to the given environment. + - name: id + in: path + required: true + schema: + type: string + description: The unique identifier for the connect cluster. + tags: + - Connect Clusters (usm/v1) + security: + - cloud-api-key: [] + - confluent-sts-access-token: [] + responses: + '204': + description: A Connect Cluster is being deleted. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/UnauthorizedError' + '404': + $ref: '#/components/responses/NotFoundError' + '429': + $ref: '#/components/responses/RateLimitError' + '500': + $ref: '#/components/responses/DefaultSystemError' + x-lifecycle-stage: Preview + x-self-access: true +components: + schemas: + SearchFilter: + description: Filter a collection by a string search + type: string + usm.v1.KafkaClusterList: + type: object + description: |- + `KafkaCluster` object represent Confluent Platform Kafka clusters registered with Confluent Cloud. + The API allows you to create and delete KafkaCluster. + + + ## The Kafka Clusters Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `KafkaCluster` object represent Confluent Platform Kafka clusters registered with Confluent Cloud. + The API allows you to create and delete KafkaCluster. + + + ## The Kafka Clusters Model + + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaCluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + description: A human-readable name for the Confluent Platform Kafka cluster. + example: My-Prod-CP-Cluster + confluent_platform_kafka_cluster_id: + type: string + description: The unique identifier of the Kafka cluster within the Confluent Platform environment. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: The cloud service provider where the metadata for the Kafka Cluster should be stored. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: The home region of the Confluent Platform Kafka cluster where the metadata should be stored. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - display_name + - confluent_platform_kafka_cluster_id + - cloud + - region + - environment + uniqueItems: true + usm.v1.KafkaCluster: + type: object + description: |- + `KafkaCluster` object represent Confluent Platform Kafka clusters registered with Confluent Cloud. + The API allows you to create and delete KafkaCluster. + + + ## The Kafka Clusters Model + + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - KafkaCluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + display_name: + type: string + description: A human-readable name for the Confluent Platform Kafka cluster. + example: My-Prod-CP-Cluster + confluent_platform_kafka_cluster_id: + type: string + description: The unique identifier of the Kafka cluster within the Confluent Platform environment. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: The cloud service provider where the metadata for the Kafka Cluster should be stored. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: The home region of the Confluent Platform Kafka cluster where the metadata should be stored. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + usm.v1.ConnectClusterList: + type: object + description: |- + `ConnectCluster` object represent Confluent Platform Connect clusters registered with Confluent Cloud. + The API allows you to create and delete ConnectCluster. + + + ## The Connect Clusters Model + + required: + - api_version + - kind + - metadata + - data + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectClusterList + metadata: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + data: + type: array + description: A data property that contains an array of resource items. Each entry in the array is a separate resource. + items: + type: object + description: |- + `ConnectCluster` object represent Confluent Platform Connect clusters registered with Confluent Cloud. + The API allows you to create and delete ConnectCluster. + + + ## The Connect Clusters Model + + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectCluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + confluent_platform_connect_cluster_id: + type: string + description: The unique identifier of the Connect cluster within the Confluent Platform environment. + example: connect-group-xyz123 + x-immutable: true + kafka_cluster_id: + type: string + description: | + The unique identifier of the metadata Kafka cluster for the Connect Cluster. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: | + The cloud service provider where the metadata for the Connect Cluster should be stored. + This field is optional. If provided, 'region' must also be provided. + If neither 'cloud' nor 'region' are provided, the cloud provider of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: | + The home region of the Confluent Platform Connect cluster where the metadata should be stored. + This field is optional. If provided, 'cloud' must also be provided. + If neither 'cloud' nor 'region' are provided, the home region of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + required: + - id + - confluent_platform_connect_cluster_id + - kafka_cluster_id + - environment + uniqueItems: true + usm.v1.ConnectCluster: + type: object + description: |- + `ConnectCluster` object represent Confluent Platform Connect clusters registered with Confluent Cloud. + The API allows you to create and delete ConnectCluster. + + + ## The Connect Clusters Model + + properties: + api_version: + type: string + enum: + - usm/v1 + description: APIVersion defines the schema version of this representation of a resource. + readOnly: true + kind: + type: string + description: Kind defines the object this REST resource represents. + readOnly: true + enum: + - ConnectCluster + id: + description: ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). + type: string + maxLength: 255 + readOnly: true + example: dlz-f3a90de + confluent_platform_connect_cluster_id: + type: string + description: The unique identifier of the Connect cluster within the Confluent Platform environment. + example: connect-group-xyz123 + x-immutable: true + kafka_cluster_id: + type: string + description: | + The unique identifier of the metadata Kafka cluster for the Connect Cluster. + example: 4k0R9d1GTS5tI9f4Y2xZ0Q + x-immutable: true + cloud: + type: string + description: | + The cloud service provider where the metadata for the Connect Cluster should be stored. + This field is optional. If provided, 'region' must also be provided. + If neither 'cloud' nor 'region' are provided, the cloud provider of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + x-extensible-enum: + - AWS + - GCP + - AZURE + example: AWS + x-immutable: true + region: + type: string + description: | + The home region of the Confluent Platform Connect cluster where the metadata should be stored. + This field is optional. If provided, 'cloud' must also be provided. + If neither 'cloud' nor 'region' are provided, the home region of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + example: us-east-1 + x-immutable: true + environment: + description: The environment to which this belongs. + x-immutable: true + type: object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + ListMeta: + type: object + description: ListMeta describes metadata that resource collections may have + properties: + first: + description: A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds + last: + description: A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=bcAOehAY8F16YD84Z1wT + prev: + description: A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=YIXRY97wWYmwzrax4dld + next: + description: A link to the next page of results. If a response does not contain a next link, then there is no more data available. + type: string + format: uri + nullable: true + example: https://api.confluent.cloud/v2/resourcekinds?page_token=UvmDWOB1iwfAIBPj6EYb + total_size: + description: Number of records in the full result set. This response may be paginated and have a smaller number of records. + type: integer + format: int32 + minimum: 0 + example: 123 + Failure: + type: object + description: Provides information about problems encountered while performing an operation. + required: + - errors + properties: + errors: + description: List of errors which caused this operation to fail + type: array + items: + $ref: '#/components/schemas/Error' + uniqueItems: true + EnvScopedObjectReference: + type: object + description: ObjectReference provides information for you to locate the referred object + required: + - id + - related + - resource_name + properties: + id: + type: string + description: ID of the referred resource + minLength: 1 + maxLength: 255 + environment: + type: string + description: Environment of the referred resource, if env-scoped + minLength: 1 + maxLength: 255 + related: + type: string + format: uri + description: API URL for accessing or modifying the referred object + minLength: 1 + readOnly: true + resource_name: + type: string + format: uri + description: CRN reference to the referred resource + minLength: 1 + readOnly: true + Error: + type: object + description: Describes a particular error encountered while performing an operation. + properties: + id: + description: A unique identifier for this particular occurrence of the problem. + type: string + maxLength: 255 + status: + description: The HTTP status code applicable to this problem, expressed as a string value. + type: string + code: + description: An application-specific error code, expressed as a string value. + type: string + title: + description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization. + type: string + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + source: + type: object + description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it. + properties: + pointer: + description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field]. + type: string + parameter: + description: A string indicating which query parameter caused the error. + type: string + error_code: + type: integer + format: int32 + message: + type: string + nullable: true + additionalProperties: false + responses: + BadRequestError: + description: Bad Request + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '400' + code: invalid_filter + title: Invalid Filter + detail: The 'delorean' resource can't be filtered by 'num_doors' + source: + parameter: num_doors + UnauthenticatedError: + x-summary: Unauthorized + description: The request lacks valid authentication credentials for this resource. + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + WWW-Authenticate: + schema: + type: string + description: The unique identifier for the API request. + example: Basic error="invalid_key", error_description="The API Key is invalid" + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '401' + code: user_unauthenticated + title: Authentication Required + detail: Valid authentication credentials must be provided + UnauthorizedError: + x-summary: Forbidden + description: The access credentials were considered insufficient to grant access + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '403' + code: user_unauthorized + title: User Access Unauthorized + detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the 'plutonium' role. + RateLimitError: + description: Rate Limit Exceeded + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests you're permitted to make per time period. + X-RateLimit-Remaining: + schema: + type: integer + description: The number of requests remaining in the current rate limit window. + X-RateLimit-Reset: + schema: + type: integer + description: |- + The relative time in seconds until the current rate-limit window resets. + + **Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues. + Retry-After: + schema: + type: integer + description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. + DefaultSystemError: + description: Oops, something went wrong! + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '500' + code: out_of_gas + title: DeLorean Out Of Gas + detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap + ConflictError: + x-summary: Conflict + description: The request is in conflict with the current server state + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + Location: + schema: + type: string + format: uri + example: https://api.confluent.cloud/{object}/{id} + description: Resource URI of conflicting resource + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '409' + code: resource_already_exists + title: Resource Already exists + detail: The entitlement '91e3e86f-fca6-4f14-98f5-a48e64113ce2' already exists. + ValidationError: + description: Validation Failed + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + - status: '422' + code: invalid_configuration + id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + title: Validation Failed + detail: 'The property ''/cluster/storage_size'' of type string did not match the following type: integer' + source: + pointer: /cluster/storage_size + NotFoundError: + description: Not Found + headers: + X-Request-Id: + schema: + type: string + description: The unique identifier for the API request. + content: + application/json: + schema: + $ref: '#/components/schemas/Failure' + example: + errors: + - id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d + status: '404' + title: Not Found +servers: + - url: https://api.confluent.cloud + description: Confluent Cloud API diff --git a/website/docs/index.md b/website/docs/index.md index 9ff3606..82d382f 100644 --- a/website/docs/index.md +++ b/website/docs/index.md @@ -1,108 +1,110 @@ ---- -title: confluent -hide_title: false -hide_table_of_contents: false -keywords: - - confluent - - kafka - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Confluent Cloud resources using SQL -custom_edit_url: null -image: /img/stackql-confluent-provider-featured-image.png -id: 'provider-intro' ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - -Confluent Cloud for managing Kafka clusters, topics, and streaming services in a scalable cloud environment. - - -:::info Provider Summary - -
-
-total services: 22
-total resources: 132
-
-
- -::: - -See also: -[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry) -* * * - -## Installation - -To pull the latest version of the `confluent` provider, run the following command: - -```bash -REGISTRY PULL confluent; -``` -> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry). - -## Authentication - -The following system environment variables are used for authentication by default: - -- - Confluent Cloud API key (see Confluent Cloud API Keys) -- - Confluent Cloud API secret (see Confluent Cloud API Keys) - -These variables are sourced at runtime (from the local machine or as CI variables/secrets). - -
- -Using different environment variables - -To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example: - -```bash - -AUTH='{ "confluent": { "type": "basic", "username_var": "MY_CONFLUENT_CLOUD_API_KEY_VAR", "password_var": "MY_CONFLUENT_CLOUD_API_SECRET_VAR" }}' -stackql shell --auth="${AUTH}" - -``` - -or using PowerShell: - -```powershell - -$Auth = "{ 'confluent': { 'type': 'basic', 'username_var': 'MY_CONFLUENT_CLOUD_API_KEY_VAR', 'password_var': 'MY_CONFLUENT_CLOUD_API_SECRET_VAR' }}" -stackql.exe shell --auth=$Auth - -``` -
- - -## Services -
-
-billing
-catalog
-connect
-encryption_keys
-flink_artifacts
-flink_compute_pools
-iam
-kafka
-ksqldb_clusters
-managed_kafka_clusters
-networking
-
-
-notifications
-org
-partner
-pipelines
-provider_integrations
-quotas
-schema_registry
-schema_registry_clusters
-sql
-stream_sharing
-sts
-
-
+--- +title: confluent +hide_title: false +hide_table_of_contents: false +keywords: + - confluent + - kafka + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Confluent Cloud resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +id: 'provider-intro' +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + +Confluent Cloud for managing Kafka clusters, topics, and streaming services in a scalable cloud environment. + + +:::info[Provider Summary] + +total services: __28__ +total resources: __170__ + +::: + +See also: +[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry) +* * * + +## Installation + +To pull the latest version of the `confluent` provider, run the following command: + +```bash +REGISTRY PULL confluent; +``` +> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry). + +## Authentication + +The following system environment variables are used for authentication by default: + +- - Confluent Cloud API key (see Confluent Cloud API Keys) +- - Confluent Cloud API secret (see Confluent Cloud API Keys) + +These variables are sourced at runtime (from the local machine or as CI variables/secrets). + +
+ +Using different environment variables + +To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example: + +```bash + +AUTH='{ "confluent": { "type": "basic", "username_var": "MY_CONFLUENT_CLOUD_API_KEY_VAR", "password_var": "MY_CONFLUENT_CLOUD_API_SECRET_VAR" }}' +stackql shell --auth="${AUTH}" + +``` + +or using PowerShell: + +```powershell + +$Auth = "{ 'confluent': { 'type': 'basic', 'username_var': 'MY_CONFLUENT_CLOUD_API_KEY_VAR', 'password_var': 'MY_CONFLUENT_CLOUD_API_SECRET_VAR' }}" +stackql.exe shell --auth=$Auth + +``` +
+ + +## Services +
+
+billing
+catalog
+ccl
+ccpm
+connect
+encryption_keys
+endpoints
+flink_artifacts
+flink_compute_pools
+iam
+kafka
+ksqldb_clusters
+managed_kafka_clusters
+networking
+
+
+notifications
+org
+partner
+provider_integrations
+quotas
+schema_registry
+schema_registry_clusters
+share_group
+sql
+stream_sharing
+streams_group
+sts
+tableflow
+usm
+
+
diff --git a/website/docs/services/billing/costs/index.md b/website/docs/services/billing/costs/index.md index 6940d5e..484a8ea 100644 --- a/website/docs/services/billing/costs/index.md +++ b/website/docs/services/billing/costs/index.md @@ -1,4 +1,4 @@ ---- +--- title: costs hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,46 +23,208 @@ Creates, updates, deletes, gets or lists a costs resource. ## Overview - +
Namecosts
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `number` | Final amount after deducting discounts. | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `number` | Amount discounted from the original amount in dollars. | -| | `string` | End date of time period (exclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. | -| | `string` | Granularity at which each line item is aggregated. | -| | `string` | Kind defines the object this REST resource represents. | -| | `string` | Type of the line item. | -| | `string` | Network access type for the cluster. | -| | `number` | Original amount accrued for this line item. | -| | `number` | Price for the line item in dollars. | -| | `string` | Product name. | -| | `number` | Quantity of the line item. | -| | `object` | The resource for a given object | -| | `string` | Start date of time period (inclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. | -| | `string` | Unit of the line item. | + +The following fields are returned by `SELECT` queries: + + + + +Cost. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
number (double)Final amount after deducting discounts.
stringAPIVersion defines the schema version of this representation of a resource. (billing/v1)
stringAdditional details about promotional offers/credits. (example: KAFKA101)
number (double)Amount discounted from the original amount in dollars.
string (date)End date of time period (exclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. (example: 2022-10-15)
stringGranularity at which each line item is aggregated. (default: DAILY)
stringKind defines the object this REST resource represents. (Cost)
stringType of the line item. (example: KAFKA_NUM_CKUS)
stringNetwork access type for the cluster. (example: INTERNET)
number (double)Original amount accrued for this line item.
number (double)Price for the line item in dollars.
stringProduct name. (example: KAFKA)
number (double)Quantity of the line item.
objectThe resource for a given object
string (date)Start date of time period (inclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. (example: 2022-10-12)
objectTier dimensions which exist for tiered pricing cost items only. (x-go-type: map[string]string)
stringUnit of the line item. (example: GB)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all costs. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
start_date, end_datepage_size, page_tokenRetrieve a sorted, filtered, paginated list of all costs.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringFilter the results by exact match for end_date. (example: 2022-10-15)
stringFilter the results by exact match for start_date. (example: 2022-10-12)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all costs. + + +Retrieve a sorted, filtered, paginated list of all costs. ```sql SELECT id, amount, api_version, +description, discount_amount, end_date, granularity, @@ -74,8 +237,14 @@ product, quantity, resource, start_date, +tier_dimensions, unit FROM confluent.billing.costs -WHERE end_date = '{{ end_date }}' -AND start_date = '{{ start_date }}'; -``` \ No newline at end of file +WHERE start_date = '{{ start_date }}' -- required +AND end_date = '{{ end_date }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + diff --git a/website/docs/services/billing/index.md b/website/docs/services/billing/index.md index 2974773..c0409b8 100644 --- a/website/docs/services/billing/index.md +++ b/website/docs/services/billing/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png billing service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 1
-
-
+total resources: __1__ ::: diff --git a/website/docs/services/catalog/business_metadata/index.md b/website/docs/services/catalog/business_metadata/index.md index 19536a4..a7d00c2 100644 --- a/website/docs/services/catalog/business_metadata/index.md +++ b/website/docs/services/catalog/business_metadata/index.md @@ -1,4 +1,4 @@ ---- +--- title: business_metadata hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,32 +23,152 @@ Creates, updates, deletes, gets or lists a business_metadata resour ## Overview - +
Namebusiness_metadata
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | The business metadata attributes | -| | `string` | The qualified name of the entity | -| | `string` | The entity type | -| | `object` | Error message of this operation | -| | `string` | The business metadata name | + +The following fields are returned by `SELECT` queries: + + + + +The business metadata + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe business metadata attributes (opaque JSON object)
stringThe qualified name of the entity
stringThe entity type
objectError message of this operation
stringThe business metadata name
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Gets the list of business metadata for a given entity represented by a qualified name. | -| | `INSERT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk API to create multiple business metadata. | -| | `DELETE` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Delete a business metadata on an entity. | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk API to update multiple business metadata. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
typeName, qualifiedNameGets the list of business metadata for a given entity represented
by a qualified name.
Bulk API to create multiple business metadata.
Bulk API to update multiple business metadata.
typeName, qualifiedName, bmNameDelete a business metadata on an entity.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the business metadata
stringThe qualified name of the entity
stringThe type of the entity
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Gets the list of business metadata for a given entity represented by a qualified name. + + +Gets the list of business metadata for a given entity represented
by a qualified name. ```sql SELECT @@ -57,52 +178,98 @@ entityType, error, typeName FROM confluent.catalog.business_metadata -WHERE qualifiedName = '{{ qualifiedName }}' -AND typeName = '{{ typeName }}'; +WHERE typeName = '{{ typeName }}' -- required +AND qualifiedName = '{{ qualifiedName }}' -- required +; ``` -## `INSERT` example + + + -Use the following StackQL query and manifest file to create a new business_metadata resource. +## `INSERT` examples - + { label: 'create_business_metadata', value: 'create_business_metadata' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Bulk API to create multiple business metadata. ```sql -/*+ create */ INSERT INTO confluent.catalog.business_metadata ( ) SELECT +RETURNING +attributes, +entityName, +entityType, +error, +typeName ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: business_metadata - props: [] + props: +`} + + + + + +## `REPLACE` examples + + + + +Bulk API to update multiple business metadata. +```sql +REPLACE confluent.catalog.business_metadata +SET +-- No updatable properties +RETURNING +attributes, +entityName, +entityType, +error, +typeName; ``` -## `DELETE` example -Deletes the specified business_metadata resource. +## `DELETE` examples + + + + +Delete a business metadata on an entity. ```sql -/*+ delete */ DELETE FROM confluent.catalog.business_metadata -WHERE bmName = '{{ bmName }}' -AND qualifiedName = '{{ qualifiedName }}' -AND typeName = '{{ typeName }}'; +WHERE typeName = '{{ typeName }}' --required +AND qualifiedName = '{{ qualifiedName }}' --required +AND bmName = '{{ bmName }}' --required +; ``` + + diff --git a/website/docs/services/catalog/business_metadata_defs/index.md b/website/docs/services/catalog/business_metadata_defs/index.md index bb26bd4..cdac5b8 100644 --- a/website/docs/services/catalog/business_metadata_defs/index.md +++ b/website/docs/services/catalog/business_metadata_defs/index.md @@ -1,4 +1,4 @@ ---- +--- title: business_metadata_defs hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,50 +23,316 @@ Creates, updates, deletes, gets or lists a business_metadata_defs r ## Overview - +
Namebusiness_metadata_defs
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The name | -| | `string` | The description | -| | `array` | The attribute definitions | -| | `string` | The category | -| | `integer` | The create time | -| | `string` | The creator | -| | `string` | The internal guid | -| | `object` | The options | -| | `string` | The service type | -| | `string` | The type version | -| | `integer` | The update time | -| | `string` | The updater | -| | `integer` | The version | + +The following fields are returned by `SELECT` queries: + + + + +The business metadata definition + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name
arrayThe attribute definitions
stringThe category (PRIMITIVE, OBJECT_ID_TYPE, ENUM, STRUCT, CLASSIFICATION, ENTITY, ARRAY, MAP, RELATIONSHIP, BUSINESS_METADATA)
integer (int64)The create time
stringThe creator
stringThe description
stringThe internal guid
objectThe options
stringThe service type
stringThe type version
integer (int64)The update time
stringThe updater
integer (int32)The version
+ + + +The business metadata definitions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name
arrayThe attribute definitions
stringThe category (PRIMITIVE, OBJECT_ID_TYPE, ENUM, STRUCT, CLASSIFICATION, ENTITY, ARRAY, MAP, RELATIONSHIP, BUSINESS_METADATA)
integer (int64)The create time
stringThe creator
stringThe description
objectError message of this operation
stringThe internal guid
objectThe options
stringThe service type
stringThe type version
integer (int64)The update time
stringThe updater
integer (int32)The version
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk retrieval API for retrieving business metadata definitions. | -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Get the business metadata definition with the given name. | -| | `INSERT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk create API for business metadata definitions. | -| | `DELETE` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Delete API for business metadata definition identified by its name. | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk update API for business metadata definitions. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
bmNameGet the business metadata definition with the given name.
prefixBulk retrieval API for retrieving business metadata definitions.
Bulk create API for business metadata definitions.
Bulk update API for business metadata definitions.
bmNameDelete API for business metadata definition identified by its name.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the business metadata definition
stringThe prefix of a business metadata definition name
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk retrieval API for retrieving business metadata definitions. + + +Get the business metadata definition with the given name. ```sql SELECT name, +attributeDefs, +category, +createTime, +createdBy, description, +guid, +options, +serviceType, +typeVersion, +updateTime, +updatedBy, +version +FROM confluent.catalog.business_metadata_defs +WHERE bmName = '{{ bmName }}' -- required +; +``` + + + +Bulk retrieval API for retrieving business metadata definitions. + +```sql +SELECT +name, attributeDefs, category, createTime, createdBy, +description, +error, guid, options, serviceType, @@ -74,49 +341,113 @@ updateTime, updatedBy, version FROM confluent.catalog.business_metadata_defs +WHERE prefix = '{{ prefix }}' ; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new business_metadata_defs resource. + +## `INSERT` examples - + { label: 'create_business_metadata_defs', value: 'create_business_metadata_defs' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Bulk create API for business metadata definitions. ```sql -/*+ create */ INSERT INTO confluent.catalog.business_metadata_defs ( ) SELECT +RETURNING +name, +attributeDefs, +category, +createTime, +createdBy, +description, +error, +guid, +options, +serviceType, +typeVersion, +updateTime, +updatedBy, +version ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: business_metadata_defs - props: [] + props: +`} + + + + + +## `REPLACE` examples + + + +Bulk update API for business metadata definitions. + +```sql +REPLACE confluent.catalog.business_metadata_defs +SET +-- No updatable properties +RETURNING +name, +attributeDefs, +category, +createTime, +createdBy, +description, +error, +guid, +options, +serviceType, +typeVersion, +updateTime, +updatedBy, +version; ``` -## `DELETE` example -Deletes the specified business_metadata_defs resource. +## `DELETE` examples + + + + +Delete API for business metadata definition identified by its name. ```sql -/*+ delete */ DELETE FROM confluent.catalog.business_metadata_defs -WHERE bmName = '{{ bmName }}'; +WHERE bmName = '{{ bmName }}' --required +; ``` + + diff --git a/website/docs/services/catalog/entities/index.md b/website/docs/services/catalog/entities/index.md index 6115b14..da28c15 100644 --- a/website/docs/services/catalog/entities/index.md +++ b/website/docs/services/catalog/entities/index.md @@ -1,4 +1,4 @@ ---- +--- title: entities hide_title: false hide_table_of_contents: false @@ -15,40 +15,289 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a entities resource. +Creates, updates, deletes, gets or lists an entities resource. ## Overview - +
Nameentities
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | The entity | -| | `object` | The referred entities | + +The following fields are returned by `SELECT` queries: + + + + +The entity + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe entity
objectThe referred entities
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Fetch complete definition of an entity given its type and unique attribute. | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Partially update an entity attribute. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
typeName, qualifiedNameminExtInfo, ignoreRelationshipsFetch complete definition of an entity given its type and unique attribute.
Partially update an entity attribute.
type, attr, attrName, attrValuePrefix, tag, sortBy, sortOrder, deleted, limit, offsetRetrieve data for the specified attribute search query.
query, type, attr, tag, sortBy, sortOrder, deleted, limit, offsetRetrieve data for the specified fulltext query.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe qualified name of the entity
stringThe type of the entity
arrayOne of more additional attributes to return in the response
arrayThe attribute to search
arrayThe prefix for the attribute value to search
booleanWhether to include deleted entities
booleanWhether to ignore relationships
integer (int32)Limit the result set to only include the specified number of entries
booleanWhether to populate on header and schema attributes
integer (int32)Start offset of the result set (useful for pagination)
stringThe full-text query
stringAn attribute to sort by
stringSort order, either ASCENDING (default) or DESCENDING
stringLimit the result to only entities tagged with the given tag
arrayLimit the result to only entities of specified types
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Fetch complete definition of an entity given its type and unique attribute. + + +Fetch complete definition of an entity given its type and unique attribute. ```sql SELECT entity, referredEntities FROM confluent.catalog.entities -WHERE qualifiedName = '{{ qualifiedName }}' -AND typeName = '{{ typeName }}'; -``` \ No newline at end of file +WHERE typeName = '{{ typeName }}' -- required +AND qualifiedName = '{{ qualifiedName }}' -- required +AND minExtInfo = '{{ minExtInfo }}' +AND ignoreRelationships = '{{ ignoreRelationships }}' +; +``` + + + + +## `REPLACE` examples + + + + +Partially update an entity attribute. + +```sql +REPLACE confluent.catalog.entities +SET +referredEntities = '{{ referredEntities }}', +entity = '{{ entity }}' +RETURNING +mutatedEntities; +``` + + + + +## Lifecycle Methods + + + + +Retrieve data for the specified attribute search query. + +```sql +EXEC confluent.catalog.entities.search_using_attribute +@type='{{ type }}', +@attr='{{ attr }}', +@attrName='{{ attrName }}', +@attrValuePrefix='{{ attrValuePrefix }}', +@tag='{{ tag }}', +@sortBy='{{ sortBy }}', +@sortOrder='{{ sortOrder }}', +@deleted={{ deleted }}, +@limit='{{ limit }}', +@offset='{{ offset }}' +; +``` + + + +Retrieve data for the specified fulltext query. + +```sql +EXEC confluent.catalog.entities.search_using_basic +@query='{{ query }}', +@type='{{ type }}', +@attr='{{ attr }}', +@tag='{{ tag }}', +@sortBy='{{ sortBy }}', +@sortOrder='{{ sortOrder }}', +@deleted={{ deleted }}, +@limit='{{ limit }}', +@offset='{{ offset }}' +; +``` + + diff --git a/website/docs/services/catalog/index.md b/website/docs/services/catalog/index.md index e9a4ff2..cab4a3f 100644 --- a/website/docs/services/catalog/index.md +++ b/website/docs/services/catalog/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png catalog service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 6
-
-
+total resources: __5__ ::: @@ -34,7 +30,6 @@ catalog service documentation. entities
-searches
tag_defs
tags
diff --git a/website/docs/services/catalog/searches/index.md b/website/docs/services/catalog/searches/index.md deleted file mode 100644 index 9cc9267..0000000 --- a/website/docs/services/catalog/searches/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: searches -hide_title: false -hide_table_of_contents: false -keywords: - - searches - - catalog - - confluent - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage confluent resources using SQL -custom_edit_url: null -image: /img/stackql-confluent-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a searches resource. - -## Overview - - - - -
Namesearches
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `array` | The entities | -| | `object` | The referred entities | -| | `object` | Search paramas to filter results | -| | `array` | The types | - -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve data for the specified attribute search query. | -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve data for the specified fulltext query. | - -## `SELECT` examples - -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve data for the specified attribute search query. - - -```sql -SELECT -entities, -referredEntities, -searchParameters, -types -FROM confluent.catalog.searches -; -``` \ No newline at end of file diff --git a/website/docs/services/catalog/tag_defs/index.md b/website/docs/services/catalog/tag_defs/index.md index a81fc44..303885a 100644 --- a/website/docs/services/catalog/tag_defs/index.md +++ b/website/docs/services/catalog/tag_defs/index.md @@ -1,4 +1,4 @@ ---- +--- title: tag_defs hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,54 +23,350 @@ Creates, updates, deletes, gets or lists a tag_defs resource. ## Overview - +
Nametag_defs
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The name | -| | `string` | The description | -| | `array` | The attribute definitions | -| | `string` | The category | -| | `integer` | The create time | -| | `string` | The creator | -| | `array` | The entity types | -| | `string` | The internal guid | -| | `object` | The options | -| | `string` | The service type | -| | `array` | The subtypes | -| | `array` | The supertypes | -| | `string` | The type version | -| | `integer` | The update time | -| | `string` | The updater | -| | `integer` | The version | + +The following fields are returned by `SELECT` queries: + + + + +The tag definition + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name
arrayThe attribute definitions
stringThe category (PRIMITIVE, OBJECT_ID_TYPE, ENUM, STRUCT, CLASSIFICATION, ENTITY, ARRAY, MAP, RELATIONSHIP, BUSINESS_METADATA)
integer (int64)The create time
stringThe creator
stringThe description
arrayThe entity types
stringThe internal guid
objectThe options
stringThe service type
arrayThe subtypes
arrayThe supertypes
stringThe type version
integer (int64)The update time
stringThe updater
integer (int32)The version
+ + + +The tag definitions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name
arrayThe attribute definitions
stringThe category (PRIMITIVE, OBJECT_ID_TYPE, ENUM, STRUCT, CLASSIFICATION, ENTITY, ARRAY, MAP, RELATIONSHIP, BUSINESS_METADATA)
integer (int64)The create time
stringThe creator
stringThe description
arrayThe entity types
objectError message of this operation
stringThe internal guid
objectThe options
stringThe service type
arrayThe subtypes
arrayThe supertypes
stringThe type version
integer (int64)The update time
stringThe updater
integer (int32)The version
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk retrieval API for retrieving tag definitions. | -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Get the tag definition with the given name. | -| | `INSERT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk create API for tag definitions. | -| | `DELETE` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Delete API for tag definition identified by its name. | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk update API for tag definitions. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
tagNameGet the tag definition with the given name.
prefixBulk retrieval API for retrieving tag definitions.
Bulk create API for tag definitions.
Bulk update API for tag definitions.
tagNameDelete API for tag definition identified by its name.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the tag definition
stringThe prefix of a tag definition name
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk retrieval API for retrieving tag definitions. + + +Get the tag definition with the given name. ```sql SELECT name, +attributeDefs, +category, +createTime, +createdBy, description, +entityTypes, +guid, +options, +serviceType, +subTypes, +superTypes, +typeVersion, +updateTime, +updatedBy, +version +FROM confluent.catalog.tag_defs +WHERE tagName = '{{ tagName }}' -- required +; +``` + + + +Bulk retrieval API for retrieving tag definitions. + +```sql +SELECT +name, attributeDefs, category, createTime, createdBy, +description, entityTypes, +error, guid, options, serviceType, @@ -80,49 +377,119 @@ updateTime, updatedBy, version FROM confluent.catalog.tag_defs +WHERE prefix = '{{ prefix }}' ; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new tag_defs resource. + +## `INSERT` examples - + { label: 'create_tag_defs', value: 'create_tag_defs' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Bulk create API for tag definitions. ```sql -/*+ create */ INSERT INTO confluent.catalog.tag_defs ( ) SELECT +RETURNING +name, +attributeDefs, +category, +createTime, +createdBy, +description, +entityTypes, +error, +guid, +options, +serviceType, +subTypes, +superTypes, +typeVersion, +updateTime, +updatedBy, +version ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: tag_defs - props: [] + props: +`} + + + + + +## `REPLACE` examples + + + +Bulk update API for tag definitions. + +```sql +REPLACE confluent.catalog.tag_defs +SET +-- No updatable properties +RETURNING +name, +attributeDefs, +category, +createTime, +createdBy, +description, +entityTypes, +error, +guid, +options, +serviceType, +subTypes, +superTypes, +typeVersion, +updateTime, +updatedBy, +version; ``` -## `DELETE` example -Deletes the specified tag_defs resource. +## `DELETE` examples + + + + +Delete API for tag definition identified by its name. ```sql -/*+ delete */ DELETE FROM confluent.catalog.tag_defs -WHERE tagName = '{{ tagName }}'; +WHERE tagName = '{{ tagName }}' --required +; ``` + + diff --git a/website/docs/services/catalog/tags/index.md b/website/docs/services/catalog/tags/index.md index 7915056..3a2af6c 100644 --- a/website/docs/services/catalog/tags/index.md +++ b/website/docs/services/catalog/tags/index.md @@ -1,4 +1,4 @@ ---- +--- title: tags hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,37 +23,177 @@ Creates, updates, deletes, gets or lists a tags resource. ## Overview - +
Nametags
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | The tag attributes | -| | `string` | The internal entity guid | -| | `string` | The qualified name of the entity | -| | `string` | The entity status | -| | `string` | The entity type | -| | `object` | Error message of this operation | -| | `boolean` | Whether to propagate the tag | -| | `boolean` | Whether to remove propagations on entity delete | -| | `string` | The tag name | -| | `array` | The validity periods | + +The following fields are returned by `SELECT` queries: + + + + +The tags + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe tag attributes (opaque JSON object)
stringThe internal entity guid
stringThe qualified name of the entity
stringThe entity status (ACTIVE, DELETED, PURGED)
stringThe entity type
objectError message of this operation
booleanWhether to propagate the tag
booleanWhether to remove propagations on entity delete
stringThe tag name
arrayThe validity periods
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Gets the list of tags for a given entity represented by a qualified name. | -| | `INSERT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk API to create multiple tags. | -| | `DELETE` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Delete a tag for an entity. | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk API to update multiple tags. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
typeName, qualifiedNameGets the list of tags for a given entity represented by a qualified name.
Bulk API to create multiple tags.
Bulk API to update multiple tags.
typeName, qualifiedName, tagNameDelete a tag for an entity.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe qualified name of the entity
stringThe name of the tag
stringThe type of the entity
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Gets the list of tags for a given entity represented by a qualified name. + + +Gets the list of tags for a given entity represented by a qualified name. ```sql SELECT @@ -67,52 +208,108 @@ removePropagationsOnEntityDelete, typeName, validityPeriods FROM confluent.catalog.tags -WHERE qualifiedName = '{{ qualifiedName }}' -AND typeName = '{{ typeName }}'; +WHERE typeName = '{{ typeName }}' -- required +AND qualifiedName = '{{ qualifiedName }}' -- required +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new tags resource. + +## `INSERT` examples - + { label: 'create_tags', value: 'create_tags' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Bulk API to create multiple tags. ```sql -/*+ create */ INSERT INTO confluent.catalog.tags ( ) SELECT +RETURNING +attributes, +entityGuid, +entityName, +entityStatus, +entityType, +error, +propagate, +removePropagationsOnEntityDelete, +typeName, +validityPeriods ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: tags - props: [] + props: +`} + + + + + +## `REPLACE` examples + + + +Bulk API to update multiple tags. + +```sql +REPLACE confluent.catalog.tags +SET +-- No updatable properties +RETURNING +attributes, +entityGuid, +entityName, +entityStatus, +entityType, +error, +propagate, +removePropagationsOnEntityDelete, +typeName, +validityPeriods; ``` -## `DELETE` example -Deletes the specified tags resource. +## `DELETE` examples + + + + +Delete a tag for an entity. ```sql -/*+ delete */ DELETE FROM confluent.catalog.tags -WHERE qualifiedName = '{{ qualifiedName }}' -AND tagName = '{{ tagName }}' -AND typeName = '{{ typeName }}'; +WHERE typeName = '{{ typeName }}' --required +AND qualifiedName = '{{ qualifiedName }}' --required +AND tagName = '{{ tagName }}' --required +; ``` + + diff --git a/website/docs/services/ccl/custom_code_loggings/index.md b/website/docs/services/ccl/custom_code_loggings/index.md new file mode 100644 index 0000000..6690db4 --- /dev/null +++ b/website/docs/services/ccl/custom_code_loggings/index.md @@ -0,0 +1,426 @@ +--- +title: custom_code_loggings +hide_title: false +hide_table_of_contents: false +keywords: + - custom_code_loggings + - ccl + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a custom_code_loggings resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Custom Code Logging. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (ccl/v1)
stringCloud provider where the Custom Code Logging is sent. (example: AWS)
objectDestination Settings of the Custom Code Logging.
objectThe environment to which this belongs.
stringKind defines the object this REST resource represents. (CustomCodeLogging)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe Cloud provider region the Custom Code Logging is sent. (example: us-west-2)
+ + + +Custom Code Logging. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (ccl/v1)
stringCloud provider where the Custom Code Logging is sent. (example: AWS)
objectDestination Settings of the Custom Code Logging.
objectThe environment to which this belongs.
stringKind defines the object this REST resource represents. (CustomCodeLogging)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe Cloud provider region the Custom Code Logging is sent. (example: us-west-2)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, id Make a request to read a custom code logging.
environmentpage_size, page_token Retrieve a sorted, filtered, paginated list of all custom code loggings.
cloud, region, destination_settings, environment Make a request to create a custom code logging.
environment, id, environment Make a request to update a custom code logging.

environment, id Make a request to delete a custom code logging.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the custom code logging.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
+ +## `SELECT` examples + + + + + Make a request to read a custom code logging. + +```sql +SELECT +id, +api_version, +cloud, +destination_settings, +environment, +kind, +metadata, +region +FROM confluent.ccl.custom_code_loggings +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + + + Retrieve a sorted, filtered, paginated list of all custom code loggings. + +```sql +SELECT +id, +api_version, +cloud, +destination_settings, +environment, +kind, +metadata, +region +FROM confluent.ccl.custom_code_loggings +WHERE environment = '{{ environment }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples + + + + + Make a request to create a custom code logging. + +```sql +INSERT INTO confluent.ccl.custom_code_loggings ( +cloud, +region, +destination_settings, +environment +) +SELECT +'{{ cloud }}' /* required */, +'{{ region }}' /* required */, +'{{ destination_settings }}' /* required */, +'{{ environment }}' /* required */ +RETURNING +id, +api_version, +cloud, +destination_settings, +environment, +kind, +metadata, +region +; +``` + + + +{`# Description fields are for documentation purposes +- name: custom_code_loggings + props: + - name: cloud + value: "{{ cloud }}" + description: | + Cloud provider where the Custom Code Logging is sent. + - name: region + value: "{{ region }}" + description: | + The Cloud provider region the Custom Code Logging is sent. + - name: destination_settings + description: | + Destination Settings of the Custom Code Logging. + value: + kind: "{{ kind }}" + cluster_id: "{{ cluster_id }}" + topic: "{{ topic }}" + log_level: "{{ log_level }}" + - name: environment + description: | + The environment to which this belongs. + value: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} + + + + + +## `UPDATE` examples + + + + + Make a request to update a custom code logging.

+ +```sql +UPDATE confluent.ccl.custom_code_loggings +SET +cloud = '{{ cloud }}', +region = '{{ region }}', +destination_settings = '{{ destination_settings }}', +environment = '{{ environment }}' +WHERE +environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +AND environment = '{{ environment }}' --required +RETURNING +id, +api_version, +cloud, +destination_settings, +environment, +kind, +metadata, +region; +``` + + + + +## `DELETE` examples + + + + + Make a request to delete a custom code logging. + +```sql +DELETE FROM confluent.ccl.custom_code_loggings +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; +``` + + diff --git a/website/docs/services/pipelines/index.md b/website/docs/services/ccl/index.md similarity index 63% rename from website/docs/services/pipelines/index.md rename to website/docs/services/ccl/index.md index 157cd1c..34a29f4 100644 --- a/website/docs/services/pipelines/index.md +++ b/website/docs/services/ccl/index.md @@ -1,9 +1,9 @@ --- -title: pipelines +title: ccl hide_title: false hide_table_of_contents: false keywords: - - pipelines + - ccl - confluent - stackql - infrastructure-as-code @@ -14,22 +14,18 @@ custom_edit_url: null image: /img/stackql-confluent-provider-featured-image.png --- -pipelines service documentation. +ccl service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 1
-
-
+total resources: __1__ ::: ## Resources
-pipelines +custom_code_loggings
diff --git a/website/docs/services/ccpm/custom_connect_plugin_versions/index.md b/website/docs/services/ccpm/custom_connect_plugin_versions/index.md new file mode 100644 index 0000000..9160514 --- /dev/null +++ b/website/docs/services/ccpm/custom_connect_plugin_versions/index.md @@ -0,0 +1,347 @@ +--- +title: custom_connect_plugin_versions +hide_title: false +hide_table_of_contents: false +keywords: + - custom_connect_plugin_versions + - ccpm + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a custom_connect_plugin_versions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Custom Connect Plugin Version. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (ccpm/v1)
stringKind defines the object this REST resource represents. (CustomConnectPluginVersion)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Custom Connect Plugin Version
objectThe status of the Custom Connect Plugin Version
+ + + +Custom Connect Plugin Version. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (ccpm/v1)
stringKind defines the object this REST resource represents. (CustomConnectPluginVersion)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Custom Connect Plugin Version
objectThe status of the Custom Connect Plugin Version
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, plugin_id, idMake a request to read a custom connect plugin version.
environment, plugin_idRetrieve a sorted, filtered, paginated list of all custom connect plugin versions.
plugin_id, specMake a request to create a custom connect plugin version.
environment, plugin_id, idMake a request to delete a custom connect plugin version.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the custom connect plugin version.
stringThe Plugin
+ +## `SELECT` examples + + + + +Make a request to read a custom connect plugin version. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.ccpm.custom_connect_plugin_versions +WHERE environment = '{{ environment }}' -- required +AND plugin_id = '{{ plugin_id }}' -- required +AND id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all custom connect plugin versions. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.ccpm.custom_connect_plugin_versions +WHERE environment = '{{ environment }}' -- required +AND plugin_id = '{{ plugin_id }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Make a request to create a custom connect plugin version. + +```sql +INSERT INTO confluent.ccpm.custom_connect_plugin_versions ( +spec, +plugin_id +) +SELECT +'{{ spec }}' /* required */, +'{{ plugin_id }}' +RETURNING +id, +api_version, +kind, +metadata, +spec, +status +; +``` + + + +{`# Description fields are for documentation purposes +- name: custom_connect_plugin_versions + props: + - name: plugin_id + value: "{{ plugin_id }}" + description: Required parameter for the custom_connect_plugin_versions resource. + - name: spec + description: | + The desired state of the Custom Connect Plugin Version + value: + version: "{{ version }}" + sensitive_config_properties: + - "{{ sensitive_config_properties }}" + documentation_link: "{{ documentation_link }}" + content_format: "{{ content_format }}" + connector_classes: + - class_name: "{{ class_name }}" + type: "{{ type }}" + upload_source: + location: "{{ location }}" + upload_id: "{{ upload_id }}" + environment: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} + + + + + +## `DELETE` examples + + + + +Make a request to delete a custom connect plugin version. + +```sql +DELETE FROM confluent.ccpm.custom_connect_plugin_versions +WHERE environment = '{{ environment }}' --required +AND plugin_id = '{{ plugin_id }}' --required +AND id = '{{ id }}' --required +; +``` + + diff --git a/website/docs/services/ccpm/custom_connect_plugins/index.md b/website/docs/services/ccpm/custom_connect_plugins/index.md new file mode 100644 index 0000000..344206a --- /dev/null +++ b/website/docs/services/ccpm/custom_connect_plugins/index.md @@ -0,0 +1,369 @@ +--- +title: custom_connect_plugins +hide_title: false +hide_table_of_contents: false +keywords: + - custom_connect_plugins + - ccpm + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a custom_connect_plugins resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Custom Connect Plugin. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (ccpm/v1)
stringKind defines the object this REST resource represents. (CustomConnectPlugin)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Custom Connect Plugin
+ + + +Custom Connect Plugin. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (ccpm/v1)
stringKind defines the object this REST resource represents. (CustomConnectPlugin)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Custom Connect Plugin
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a custom connect plugin.
environmentspec.cloud, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all custom connect plugins.

If no `cloud` filter is specified, returns custom connect plugins from all clouds.
specMake a request to create a custom connect plugin.
id, specMake a request to update a custom connect plugin.

environment, idMake a request to delete a custom connect plugin.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the custom connect plugin.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for spec.cloud. (example: AWS)
+ +## `SELECT` examples + + + + +Make a request to read a custom connect plugin. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec +FROM confluent.ccpm.custom_connect_plugins +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all custom connect plugins.

If no `cloud` filter is specified, returns custom connect plugins from all clouds.
+ +```sql +SELECT +id, +api_version, +kind, +metadata, +spec +FROM confluent.ccpm.custom_connect_plugins +WHERE environment = '{{ environment }}' -- required +AND spec.cloud = '{{ spec.cloud }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples + + + + +Make a request to create a custom connect plugin. + +```sql +INSERT INTO confluent.ccpm.custom_connect_plugins ( +spec +) +SELECT +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec +; +``` + + + +{`# Description fields are for documentation purposes +- name: custom_connect_plugins + props: + - name: spec + description: | + The desired state of the Custom Connect Plugin + value: + cloud: "{{ cloud }}" + display_name: "{{ display_name }}" + description: "{{ description }}" + runtime_language: "{{ runtime_language }}" + environment: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} + + + + + +## `UPDATE` examples + + + + +Make a request to update a custom connect plugin.

+ +```sql +UPDATE confluent.ccpm.custom_connect_plugins +SET +spec = '{{ spec }}' +WHERE +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec; +``` + + + + +## `DELETE` examples + + + + +Make a request to delete a custom connect plugin. + +```sql +DELETE FROM confluent.ccpm.custom_connect_plugins +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; +``` + + diff --git a/website/docs/services/ccpm/index.md b/website/docs/services/ccpm/index.md new file mode 100644 index 0000000..442641b --- /dev/null +++ b/website/docs/services/ccpm/index.md @@ -0,0 +1,34 @@ +--- +title: ccpm +hide_title: false +hide_table_of_contents: false +keywords: + - ccpm + - confluent + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +ccpm service documentation. + +:::info[Service Summary] + +total resources: __3__ + +::: + +## Resources +
+
+custom_connect_plugin_versions
+custom_connect_plugins +
+
+presigned_urls +
+
\ No newline at end of file diff --git a/website/docs/services/ccpm/presigned_urls/index.md b/website/docs/services/ccpm/presigned_urls/index.md new file mode 100644 index 0000000..aaeeed2 --- /dev/null +++ b/website/docs/services/ccpm/presigned_urls/index.md @@ -0,0 +1,138 @@ +--- +title: presigned_urls +hide_title: false +hide_table_of_contents: false +keywords: + - presigned_urls + - ccpm + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a presigned_urls resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
content_format, cloud, environmentRequest a presigned upload URL to upload a Custom Connect Plugin archive.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `INSERT` examples + + + + +Request a presigned upload URL to upload a Custom Connect Plugin archive. + +```sql +INSERT INTO confluent.ccpm.presigned_urls ( +content_format, +cloud, +environment +) +SELECT +'{{ content_format }}' /* required */, +'{{ cloud }}' /* required */, +'{{ environment }}' /* required */ +RETURNING +upload_id, +api_version, +cloud, +content_format, +environment, +kind, +upload_form_data, +upload_url +; +``` + + + +{`# Description fields are for documentation purposes +- name: presigned_urls + props: + - name: content_format + value: "{{ content_format }}" + description: | + Content format of the Custom Connect Plugin archive. + - name: cloud + value: "{{ cloud }}" + description: | + Cloud provider where the Custom Connect Plugin archive is uploaded. + - name: environment + description: | + The environment to which this belongs. + value: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} + + + diff --git a/website/docs/services/connect/connector_config/index.md b/website/docs/services/connect/connector_config/index.md index d627607..7d3b815 100644 --- a/website/docs/services/connect/connector_config/index.md +++ b/website/docs/services/connect/connector_config/index.md @@ -1,4 +1,4 @@ ---- +--- title: connector_config hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,33 +23,138 @@ Creates, updates, deletes, gets or lists a connector_config resourc ## Overview - +
Nameconnector_config
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | Name or alias of the class (plugin) for this connector. For Custom Connector, it must be the same as connector_name. | -| | `string` | The cloud environment type. | -| | `string` | The cloud service provider, e.g. aws, azure, etc. | -| | `string` | The connector class name. E.g. BigQuerySink, GcsSink, etc. | -| | `string` | The kafka cluster api key. | -| | `string` | The kafka cluster api secret key. | -| | `string` | The kafka cluster endpoint. | -| | `string` | The kafka cluster region. | + +The following fields are returned by `SELECT` queries: + + + + +Connector. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName or alias of the class (plugin) for this connector. For Custom Connector, it must be the same as connector_name.
stringThe cloud environment type.
stringThe cloud service provider, e.g. aws, azure, etc.
stringThe connector class name. E.g. BigQuerySink, GcsSink, etc.
stringThe kafka cluster api key.
stringThe kafka cluster api secret key.
stringThe kafka cluster endpoint.
stringThe kafka cluster region.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Get the configuration for the connector. | -| | `INSERT` | | Create a new connector using the given configuration, or update the configuration for an existing connector. Returns information about the connector after the change has been made. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Get the configuration for the connector.
connector.class, name, kafka.api.key, kafka.api.secretCreate a new connector using the given configuration, or update the configuration for an existing connector. Returns information about the connector after the change has been made.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Get the configuration for the connector. + + +Get the configuration for the connector. ```sql SELECT @@ -61,116 +167,47 @@ kafka.api.secret, kafka.endpoint, kafka.region FROM confluent.connect.connector_config -WHERE connector_name = '{{ connector_name }}' -AND environment_id = '{{ environment_id }}' -AND kafka_cluster_id = '{{ kafka_cluster_id }}'; +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new connector_config resource. + +## `REPLACE` examples - - -```sql -/*+ create */ -INSERT INTO confluent.connect.connector_config ( -data__connector.class, -data__name, -data__kafka.api.key, -data__kafka.api.secret, -data__confluent.connector.type, -data__confluent.custom.plugin.id, -data__confluent.custom.connection.endpoints, -data__confluent.custom.schema.registry.auto, -connector_name, -environment_id, -kafka_cluster_id -) -SELECT -'{{ connector.class }}', -'{{ name }}', -'{{ kafka.api.key }}', -'{{ kafka.api.secret }}', -'{{ confluent.connector.type }}', -'{{ confluent.custom.plugin.id }}', -'{{ confluent.custom.connection.endpoints }}', -'{{ confluent.custom.schema.registry.auto }}', -'{{ connector_name }}', -'{{ environment_id }}', -'{{ kafka_cluster_id }}' -; -``` - + { label: 'create_or_update_connectv1_connector_config', value: 'create_or_update_connectv1_connector_config' } + ]} +> + - +Create a new connector using the given configuration, or update the configuration for an existing connector. Returns information about the connector after the change has been made. ```sql -/*+ create */ -INSERT INTO confluent.connect.connector_config ( -data__connector.class, -data__name, -data__kafka.api.key, -data__kafka.api.secret, -connector_name, -environment_id, -kafka_cluster_id -) -SELECT -'{{ connector.class }}', -'{{ name }}', -'{{ kafka.api.key }}', -'{{ kafka.api.secret }}', -'{{ connector_name }}', -'{{ environment_id }}', -'{{ kafka_cluster_id }}' -; -``` - - - - -```yaml -- name: connector_config - props: - - name: connector_name - value: string - - name: environment_id - value: string - - name: kafka_cluster_id - value: string - - name: data__connector.class - value: string - - name: data__kafka.api.key - value: string - - name: data__kafka.api.secret - value: string - - name: data__name - value: string - - name: connector.class - value: string - - name: name - value: string - - name: kafka.api.key - value: string - - name: kafka.api.secret - value: string - - name: confluent.connector.type - value: string - - name: confluent.custom.plugin.id - value: string - - name: confluent.custom.connection.endpoints - value: string - - name: confluent.custom.schema.registry.auto - value: string - +REPLACE confluent.connect.connector_config +SET +connector.class = '{{ connector.class }}', +name = '{{ name }}', +kafka.api.key = '{{ kafka.api.key }}', +kafka.api.secret = '{{ kafka.api.secret }}', +confluent.connector.type = '{{ confluent.connector.type }}', +confluent.custom.plugin.id = '{{ confluent.custom.plugin.id }}', +confluent.custom.connection.endpoints = '{{ confluent.custom.connection.endpoints }}', +confluent.custom.schema.registry.auto = '{{ confluent.custom.schema.registry.auto }}', +confluent.custom.connect.plugin.runtime = '{{ confluent.custom.connect.plugin.runtime }}', +confluent.custom.connect.java.version = '{{ confluent.custom.connect.java.version }}' +WHERE +connector.class = '{{ connector.class }}' --required +AND name = '{{ name }}' --required +AND kafka.api.key = '{{ kafka.api.key }}' --required +AND kafka.api.secret = '{{ kafka.api.secret }}' --required +RETURNING +name, +config, +tasks, +type; ``` diff --git a/website/docs/services/connect/connector_offsets/index.md b/website/docs/services/connect/connector_offsets/index.md index 59eb34d..72fb5c4 100644 --- a/website/docs/services/connect/connector_offsets/index.md +++ b/website/docs/services/connect/connector_offsets/index.md @@ -1,4 +1,4 @@ ---- +--- title: connector_offsets hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,28 +23,111 @@ Creates, updates, deletes, gets or lists a connector_offsets resour ## Overview - +
Nameconnector_offsets
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The ID of the connector. | -| | `string` | The name of the connector. | -| | `object` | Metadata of the connector offset. | -| | `array` | Array of offsets which are categorised into partitions. | + +The following fields are returned by `SELECT` queries: + + + + +Connector Offsets. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the connector.
stringThe name of the connector.
objectMetadata of the connector offset.
arrayArray of offsets which are categorised into partitions.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Get the current offsets for the connector. The offsets provide information on the point in the source system, from which the connector is pulling in data. The offsets of a connector are continuously observed periodically and are queryable via this API. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Get the current offsets for the connector. The offsets provide information on the point in the source system,
from which the connector is pulling in data. The offsets of a connector are continuously observed periodically and are queryable via this API.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Get the current offsets for the connector. The offsets provide information on the point in the source system, from which the connector is pulling in data. The offsets of a connector are continuously observed periodically and are queryable via this API. + + +Get the current offsets for the connector. The offsets provide information on the point in the source system,
from which the connector is pulling in data. The offsets of a connector are continuously observed periodically and are queryable via this API. ```sql SELECT @@ -52,7 +136,7 @@ name, metadata, offsets FROM confluent.connect.connector_offsets -WHERE connector_name = '{{ connector_name }}' -AND environment_id = '{{ environment_id }}' -AND kafka_cluster_id = '{{ kafka_cluster_id }}'; -``` \ No newline at end of file +; +``` + + diff --git a/website/docs/services/connect/connector_offsets_requests/index.md b/website/docs/services/connect/connector_offsets_requests/index.md index 4cd8c23..d59d6cd 100644 --- a/website/docs/services/connect/connector_offsets_requests/index.md +++ b/website/docs/services/connect/connector_offsets_requests/index.md @@ -1,4 +1,4 @@ ---- +--- title: connector_offsets_requests hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,29 +23,118 @@ Creates, updates, deletes, gets or lists a connector_offsets_requests -Nameconnector_offsets_requests +Name TypeResource Id ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The time at which the offsets were applied. The time is in UTC, ISO 8601 format. | -| | `array` | Array of offsets which are categorised into partitions. | -| | `object` | The request made to alter offsets. | -| | `object` | The response of the alter offsets operation. | + +The following fields are returned by `SELECT` queries: + + + + +Connector Offsets Request Status. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (date-time)The time at which the offsets were applied. The time is in UTC, ISO 8601 format. (example: 2024-02-20T15:14:19.000Z)
arrayArray of offsets which are categorised into partitions.
objectThe request made to alter offsets.
objectThe response of the alter offsets operation.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Get the status of the previous alter offset request. | -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Request to alter the offsets of a connector. This supports the ability to PATCH/DELETE the offsets of a connector. Note, you will see momentary downtime as this will internally stop the connector, while the offsets are being altered. You can only make one alter offsets request at a time for a connector. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Get the status of the previous alter offset request.
typeRequest to alter the offsets of a connector. This supports the ability to PATCH/DELETE the offsets of a connector.
Note, you will see momentary downtime as this will internally stop the connector, while the offsets are being altered.
You can only make one alter offsets request at a time for a connector.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Get the status of the previous alter offset request. + + +Get the status of the previous alter offset request. ```sql SELECT @@ -53,7 +143,32 @@ previous_offsets, request, status FROM confluent.connect.connector_offsets_requests -WHERE connector_name = '{{ connector_name }}' -AND environment_id = '{{ environment_id }}' -AND kafka_cluster_id = '{{ kafka_cluster_id }}'; -``` \ No newline at end of file +; +``` + + + + +## Lifecycle Methods + + + + +Request to alter the offsets of a connector. This supports the ability to PATCH/DELETE the offsets of a connector.
Note, you will see momentary downtime as this will internally stop the connector, while the offsets are being altered.
You can only make one alter offsets request at a time for a connector. + +```sql +EXEC confluent.connect.connector_offsets_requests.alter_connectv1_connector_offsets_request +@@json= +'{ +"type": "{{ type }}", +"offsets": "{{ offsets }}" +}' +; +``` + + diff --git a/website/docs/services/connect/connector_status/index.md b/website/docs/services/connect/connector_status/index.md index 5f3ef1f..6b531a4 100644 --- a/website/docs/services/connect/connector_status/index.md +++ b/website/docs/services/connect/connector_status/index.md @@ -1,4 +1,4 @@ ---- +--- title: connector_status hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,28 +23,111 @@ Creates, updates, deletes, gets or lists a connector_status resourc ## Overview - +
Nameconnector_status
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The name of the connector. | -| | `object` | The map containing connector status. | -| | `array` | The map containing the task status. | -| | `string` | Type of connector, sink or source. | + +The following fields are returned by `SELECT` queries: + + + + +Connector. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the connector.
objectThe map containing connector status.
arrayThe map containing the task status.
stringType of connector, sink or source. (sink, source)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Get current status of the connector. This includes whether it is running, failed, or paused. Also includes which worker it is assigned to, error information if it has failed, and the state of all its tasks. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Get current status of the connector. This includes whether it is running, failed, or paused. Also includes which worker it is assigned to, error information if it has failed, and the state of all its tasks.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -Get current status of the connector. This includes whether it is running, failed, or paused. Also includes which worker it is assigned to, error information if it has failed, and the state of all its tasks. + + +Get current status of the connector. This includes whether it is running, failed, or paused. Also includes which worker it is assigned to, error information if it has failed, and the state of all its tasks. ```sql SELECT @@ -52,7 +136,7 @@ connector, tasks, type FROM confluent.connect.connector_status -WHERE connector_name = '{{ connector_name }}' -AND environment_id = '{{ environment_id }}' -AND kafka_cluster_id = '{{ kafka_cluster_id }}'; -``` \ No newline at end of file +; +``` + + diff --git a/website/docs/services/connect/connector_tasks/index.md b/website/docs/services/connect/connector_tasks/index.md index 366d7e3..3331425 100644 --- a/website/docs/services/connect/connector_tasks/index.md +++ b/website/docs/services/connect/connector_tasks/index.md @@ -1,4 +1,4 @@ ---- +--- title: connector_tasks hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,33 +23,108 @@ Creates, updates, deletes, gets or lists a connector_tasks resource ## Overview - +
Nameconnector_tasks
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | The ID of task. | -| | `object` | Configuration parameters for the connector. These configurations are the minimum set of key-value pairs (KVP) which can be used to define how the connector connects Kafka to the external system. Some of these KVPs are common to all the connectors, such as connection parameters to Kafka, connector metadata, etc. The list of common connector configurations is as follows - cloud.environment - cloud.provider - connector.class - kafka.api.key - kafka.api.secret - kafka.endpoint - kafka.region - name A specific connector such as `GcsSink` would have additional parameters such as `gcs.bucket.name`, `flush.size`, etc. | + +The following fields are returned by `SELECT` queries: + + + + +Connector Task. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe ID of task.
objectConfiguration parameters for the connector. These configurations are the minimum set of key-value pairs (KVP) which can be used to define how the connector connects Kafka to the external system. Some of these KVPs are common to all the connectors, such as connection parameters to Kafka, connector metadata, etc. The list of common connector configurations is as follows - cloud.environment - cloud.provider - connector.class - kafka.api.key - kafka.api.secret - kafka.endpoint - kafka.region - name A specific connector such as `GcsSink` would have additional parameters such as `gcs.bucket.name`, `flush.size`, etc.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Get a list of tasks currently running for the connector. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Get a list of tasks currently running for the connector.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Get a list of tasks currently running for the connector. + + +Get a list of tasks currently running for the connector. ```sql SELECT id, config FROM confluent.connect.connector_tasks -WHERE connector_name = '{{ connector_name }}' -AND environment_id = '{{ environment_id }}' -AND kafka_cluster_id = '{{ kafka_cluster_id }}'; -``` \ No newline at end of file +; +``` + + diff --git a/website/docs/services/connect/connectors/index.md b/website/docs/services/connect/connectors/index.md index 1715fd2..5f9b3fc 100644 --- a/website/docs/services/connect/connectors/index.md +++ b/website/docs/services/connect/connectors/index.md @@ -1,4 +1,4 @@ ---- +--- title: connectors hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,33 +23,193 @@ Creates, updates, deletes, gets or lists a connectors resource. ## Overview - +
Nameconnectors
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | Name of the connector | -| | `object` | Configuration parameters for the connector. These configurations are the minimum set of key-value pairs (KVP) which can be used to define how the connector connects Kafka to the external system. Some of these KVPs are common to all the connectors, such as connection parameters to Kafka, connector metadata, etc. The list of common connector configurations is as follows - cloud.environment - cloud.provider - connector.class - kafka.api.key - kafka.api.secret - kafka.endpoint - kafka.region - name A specific connector such as `GcsSink` would have additional parameters such as `gcs.bucket.name`, `flush.size`, etc. | -| | `array` | List of active tasks generated by the connector | -| | `string` | Type of connector, sink or source | + +The following fields are returned by `SELECT` queries: + + + + +Connector. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the connector
objectConfiguration parameters for the connector. These configurations are the minimum set of key-value pairs (KVP) which can be used to define how the connector connects Kafka to the external system. Some of these KVPs are common to all the connectors, such as connection parameters to Kafka, connector metadata, etc. The list of common connector configurations is as follows - cloud.environment - cloud.provider - connector.class - kafka.api.key - kafka.api.secret - kafka.endpoint - kafka.region - name A specific connector such as `GcsSink` would have additional parameters such as `gcs.bucket.name`, `flush.size`, etc.
arrayList of active tasks generated by the connector
stringType of connector, sink or source (sink, source)
+ + + +Connector. + + + + + + + + + + + +
NameDatatypeDescription
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a list of "names" of the active connectors. You can then make a [read request](#operation/readConnectv1Connector) for a specific connector by name. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Get information about the connector. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Create a new connector. Returns the new connector information if successful. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Delete a connector. Halts all tasks and deletes the connector configuration. | -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Pause the connector and its tasks. Stops message processing until the connector is resumed. This call is asynchronous and the tasks will not transition to PAUSED state at the same time. | -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Resume a paused connector or do nothing if the connector is not paused. This call is asynchronous and the tasks will not transition to RUNNING state at the same time. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Get information about the connector.
Retrieve a list of "names" of the active connectors. You can then make a read request for a specific connector by name.
Create a new connector. Returns the new connector information if successful.
Delete a connector. Halts all tasks and deletes the connector configuration.
environment_id, kafka_cluster_idexpandRetrieve an object with the queried expansions of all connectors. Without `expand` query parameter, this list connector’s endpoint will return a list of only the connector names.
Pause the connector and its tasks. Stops message processing until the connector is resumed. This call is asynchronous and the tasks will not transition to PAUSED state at the same time.
Resume a paused connector or do nothing if the connector is not paused. This call is asynchronous and the tasks will not transition to RUNNING state at the same time.
Restart the connector and its tasks. Stops message processing until the connector and tasks are restart. This call is asynchronous and the connector will not transition to another state at the same time.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the environment this resource belongs to.
stringThe unique identifier for the Kafka cluster.
string- id : Returns metadata of each connector such as id and id type. - info : Returns metadata of each connector such as the configuration, task information, and type of connector. - status : Returns additional state information of each connector including their status and tasks.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a list of "names" of the active connectors. You can then make a [read request](#operation/readConnectv1Connector) for a specific connector by name. + + +Get information about the connector. ```sql SELECT @@ -57,106 +218,161 @@ config, tasks, type FROM confluent.connect.connectors -WHERE environment_id = '{{ environment_id }}' -AND kafka_cluster_id = '{{ kafka_cluster_id }}'; +; ``` -## `INSERT` example - -Use the following StackQL query and manifest file to create a new connectors resource. + + - - +Retrieve a list of "names" of the active connectors. You can then make a read request for a specific connector by name. ```sql -/*+ create */ -INSERT INTO confluent.connect.connectors ( -data__name, -data__config, -data__offsets, -environment_id, -kafka_cluster_id -) -SELECT -'{{ name }}', -'{{ config }}', -'{{ offsets }}', -'{{ environment_id }}', -'{{ kafka_cluster_id }}' +SELECT +* +FROM confluent.connect.connectors ; ``` + + - +## `INSERT` examples + + + + +Create a new connector. Returns the new connector information if successful. ```sql -/*+ create */ INSERT INTO confluent.connect.connectors ( -environment_id, -kafka_cluster_id +name, +config, +offsets ) SELECT -'{{ environment_id }}', -'{{ kafka_cluster_id }}' +'{{ name }}', +'{{ config }}', +'{{ offsets }}' +RETURNING +name, +config, +offsets, +tasks, +type ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: connectors props: - - name: environment_id - value: string - - name: kafka_cluster_id - value: string - name: name - value: string + value: "{{ name }}" + description: | + Name of the connector to create. - name: config - props: - - name: connector.class - value: string - - name: name - value: string - - name: kafka.api.key - value: string - - name: kafka.api.secret - value: string - - name: confluent.connector.type - value: string - - name: confluent.custom.plugin.id - value: string - - name: confluent.custom.connection.endpoints - value: string - - name: confluent.custom.schema.registry.auto - value: string + description: | + Configuration parameters for the connector. All values should be strings. + value: + connector.class: "{{ connector.class }}" + name: "{{ name }}" + kafka.api.key: "{{ kafka.api.key }}" + kafka.api.secret: "{{ kafka.api.secret }}" + confluent.connector.type: "{{ confluent.connector.type }}" + confluent.custom.plugin.id: "{{ confluent.custom.plugin.id }}" + confluent.custom.connection.endpoints: "{{ confluent.custom.connection.endpoints }}" + confluent.custom.schema.registry.auto: "{{ confluent.custom.schema.registry.auto }}" + confluent.custom.connect.plugin.runtime: "{{ confluent.custom.connect.plugin.runtime }}" + confluent.custom.connect.java.version: "{{ confluent.custom.connect.java.version }}" - name: offsets - value: array - props: - - name: partition - value: object - - name: offset - value: object + description: | + Array of offsets which are categorised into partitions. + value: + - partition: "{{ partition }}" + offset: "{{ offset }}" +`} -``` -## `DELETE` example -Deletes the specified connectors resource. +## `DELETE` examples + + + + +Delete a connector. Halts all tasks and deletes the connector configuration. ```sql -/*+ delete */ DELETE FROM confluent.connect.connectors -WHERE connector_name = '{{ connector_name }}' -AND environment_id = '{{ environment_id }}' -AND kafka_cluster_id = '{{ kafka_cluster_id }}'; +; +``` + + + + +## Lifecycle Methods + + + + +Retrieve an object with the queried expansions of all connectors. Without `expand` query parameter, this list connector’s endpoint will return a list of only the connector names. + +```sql +EXEC confluent.connect.connectors.list_connectv1_connectors_with_expansions +@environment_id='{{ environment_id }}' --required, +@kafka_cluster_id='{{ kafka_cluster_id }}' --required, +@expand='{{ expand }}' +; ``` + + + +Pause the connector and its tasks. Stops message processing until the connector is resumed. This call is asynchronous and the tasks will not transition to PAUSED state at the same time. + +```sql +EXEC confluent.connect.connectors.pause_connectv1_connector + +; +``` + + + +Resume a paused connector or do nothing if the connector is not paused. This call is asynchronous and the tasks will not transition to RUNNING state at the same time. + +```sql +EXEC confluent.connect.connectors.resume_connectv1_connector + +; +``` + + + +Restart the connector and its tasks. Stops message processing until the connector and tasks are restart. This call is asynchronous and the connector will not transition to another state at the same time. + +```sql +EXEC confluent.connect.connectors.restart_connectv1_connector + +; +``` + + diff --git a/website/docs/services/connect/connectors_with_expansions/index.md b/website/docs/services/connect/connectors_with_expansions/index.md deleted file mode 100644 index 35891a5..0000000 --- a/website/docs/services/connect/connectors_with_expansions/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: connectors_with_expansions -hide_title: false -hide_table_of_contents: false -keywords: - - connectors_with_expansions - - connect - - confluent - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage confluent resources using SQL -custom_edit_url: null -image: /img/stackql-confluent-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a connectors_with_expansions resource. - -## Overview - - - - -
Nameconnectors_with_expansions
TypeResource
Id
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve an object with the queried expansions of all connectors. Without `expand` query parameter, this list connector’s endpoint will return a [list of only the connector names](#operation/listConnectv1Connectors). | - -## `SELECT` examples - -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve an object with the queried expansions of all connectors. Without `expand` query parameter, this list connector’s endpoint will return a [list of only the connector names](#operation/listConnectv1Connectors). - - -```sql -SELECT - -FROM confluent.connect.connectors_with_expansions -WHERE environment_id = '{{ environment_id }}' -AND kafka_cluster_id = '{{ kafka_cluster_id }}'; -``` \ No newline at end of file diff --git a/website/docs/services/connect/custom_connector_plugins/index.md b/website/docs/services/connect/custom_connector_plugins/index.md index 45a0960..3194afa 100644 --- a/website/docs/services/connect/custom_connector_plugins/index.md +++ b/website/docs/services/connect/custom_connector_plugins/index.md @@ -1,4 +1,4 @@ ---- +--- title: custom_connector_plugins hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,171 +23,517 @@ Creates, updates, deletes, gets or lists a custom_connector_plugins ## Overview - +
Namecustom_connector_plugins
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | Description of Custom Connector Plugin. | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Cloud provider where the Custom Connector Plugin archive is uploaded. | -| | `string` | Java class or alias for connector. You can get connector class from connector documentation provided by developer. | -| | `string` | Custom Connector type. | -| | `string` | Archive format of Custom Connector Plugin. | -| | `string` | Display name of Custom Connector Plugin. | -| | `string` | Document link of Custom Connector Plugin. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `array` | A sensitive property is a connector configuration property that must be hidden after a user enters property value when setting up connector. | -| | `object` | [immutable] Upload source of Custom Connector Plugin. Only required in `create` request, will be ignored in `read`, `update` or `list`. | + +The following fields are returned by `SELECT` queries: + + + + +Custom Connector Plugin. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringDisplay name of Custom Connector Plugin.
stringAPIVersion defines the schema version of this representation of a resource. (connect/v1)
stringCloud provider where the Custom Connector Plugin archive is uploaded. (example: AWS, default: AWS)
stringJava class or alias for connector. You can get connector class from connector documentation provided by developer. (pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$, example: io.confluent.kafka.connect.datagen.DatagenConnector)
stringCustom Connector type. (example: SOURCE)
stringArchive format of Custom Connector Plugin. (example: ZIP)
stringDescription of Custom Connector Plugin.
stringDocument link of Custom Connector Plugin. (pattern: ^$|^(http://|https://).+, example: https://github.com/confluentinc/kafka-connect-datagen)
stringKind defines the object this REST resource represents. (CustomConnectorPlugin)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringRuntime language of Custom Connector Plugin. (example: JAVA, default: JAVA)
arrayA sensitive property is a connector configuration property that must be hidden after a user enters property value when setting up connector.
objectUpload source of Custom Connector Plugin. Only required in `create` request, will be ignored in `read`, `update` or `list`.
+ + + +Custom Connector Plugin. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringDisplay name of Custom Connector Plugin.
stringAPIVersion defines the schema version of this representation of a resource. (connect/v1)
stringCloud provider where the Custom Connector Plugin archive is uploaded. (example: AWS, default: AWS)
stringJava class or alias for connector. You can get connector class from connector documentation provided by developer. (pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$, example: io.confluent.kafka.connect.datagen.DatagenConnector)
stringCustom Connector type. (example: SOURCE)
stringArchive format of Custom Connector Plugin. (example: ZIP)
stringDescription of Custom Connector Plugin.
stringDocument link of Custom Connector Plugin. (pattern: ^$|^(http://|https://).+, example: https://github.com/confluentinc/kafka-connect-datagen)
stringKind defines the object this REST resource represents. (CustomConnectorPlugin)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringRuntime language of Custom Connector Plugin. (example: JAVA, default: JAVA)
arrayA sensitive property is a connector configuration property that must be hidden after a user enters property value when setting up connector.
objectUpload source of Custom Connector Plugin. Only required in `create` request, will be ignored in `read`, `update` or `list`.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a custom connector plugin. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all custom connector plugins. If no `cloud` filter is specified, returns custom connector plugins from all clouds. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a custom connector plugin. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a custom connector plugin. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a custom connector plugin. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a custom connector plugin.
cloud, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all custom connector plugins.

If no `cloud` filter is specified, returns custom connector plugins from all clouds.
display_name, connector_class, connector_type, upload_sourceMake a request to create a custom connector plugin.
idMake a request to update a custom connector plugin.

idMake a request to delete a custom connector plugin.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the custom connector plugin.
stringFilter the results by exact match for cloud. (example: AWS)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all custom connector plugins. If no `cloud` filter is specified, returns custom connector plugins from all clouds. + + +Make a request to read a custom connector plugin. ```sql SELECT id, -description, +display_name, api_version, cloud, connector_class, connector_type, content_format, +description, +documentation_link, +kind, +metadata, +runtime_language, +sensitive_config_properties, +upload_source +FROM confluent.connect.custom_connector_plugins +WHERE id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all custom connector plugins.

If no `cloud` filter is specified, returns custom connector plugins from all clouds.
+ +```sql +SELECT +id, display_name, +api_version, +cloud, +connector_class, +connector_type, +content_format, +description, documentation_link, kind, metadata, +runtime_language, sensitive_config_properties, upload_source FROM confluent.connect.custom_connector_plugins +WHERE cloud = '{{ cloud }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` -## `INSERT` example + + + -Use the following StackQL query and manifest file to create a new custom_connector_plugins resource. +## `INSERT` examples - + { label: 'create_connect_v1_custom_connector_plugin', value: 'create_connect_v1_custom_connector_plugin' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a custom connector plugin. ```sql -/*+ create */ INSERT INTO confluent.connect.custom_connector_plugins ( -data__display_name, -data__description, -data__documentation_link, -data__connector_class, -data__connector_type, -data__cloud, -data__sensitive_config_properties, -data__upload_source +display_name, +description, +documentation_link, +connector_class, +connector_type, +cloud, +sensitive_config_properties, +upload_source, +runtime_language ) SELECT -'{{ display_name }}', +'{{ display_name }}' /* required */, '{{ description }}', '{{ documentation_link }}', -'{{ connector_class }}', -'{{ connector_type }}', +'{{ connector_class }}' /* required */, +'{{ connector_type }}' /* required */, '{{ cloud }}', '{{ sensitive_config_properties }}', -'{{ upload_source }}' -; -``` - - - - -```sql -/*+ create */ -INSERT INTO confluent.connect.custom_connector_plugins ( -data__display_name, -data__connector_class, -data__connector_type, -data__upload_source -) -SELECT -'{{ display_name }}', -'{{ connector_class }}', -'{{ connector_type }}', -'{{ upload_source }}' +'{{ upload_source }}' /* required */, +'{{ runtime_language }}' +RETURNING +id, +display_name, +api_version, +cloud, +connector_class, +connector_type, +content_format, +description, +documentation_link, +kind, +metadata, +runtime_language, +sensitive_config_properties, +upload_source ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: custom_connector_plugins props: - name: display_name - value: string + value: "{{ display_name }}" + description: | + Display name of Custom Connector Plugin. - name: description - value: string + value: "{{ description }}" + description: | + Description of Custom Connector Plugin. - name: documentation_link - value: string + value: "{{ documentation_link }}" + description: | + Document link of Custom Connector Plugin. - name: connector_class - value: string + value: "{{ connector_class }}" + description: | + Java class or alias for connector. You can get connector class from connector documentation provided by developer. - name: connector_type - value: string + value: "{{ connector_type }}" + description: | + Custom Connector type. - name: cloud - value: string + value: "{{ cloud }}" + description: | + Cloud provider where the Custom Connector Plugin archive is uploaded. + default: AWS - name: sensitive_config_properties - value: array + value: + - "{{ sensitive_config_properties }}" + description: | + A sensitive property is a connector configuration property that must be hidden after a user enters property + value when setting up connector. - name: upload_source - props: - - name: location - value: string - - name: upload_id - value: string + description: | + Upload source of Custom Connector Plugin. Only required in \`create\` request, will be ignored in \`read\`, \`update\` or \`list\`. + value: + location: "{{ location }}" + upload_id: "{{ upload_id }}" + - name: runtime_language + value: "{{ runtime_language }}" + description: | + Runtime language of Custom Connector Plugin. + default: JAVA +`} -``` -## `UPDATE` example -Updates a custom_connector_plugins resource. +## `UPDATE` examples + + + + +Make a request to update a custom connector plugin.

```sql -/*+ update */ UPDATE confluent.connect.custom_connector_plugins SET display_name = '{{ display_name }}', description = '{{ description }}', documentation_link = '{{ documentation_link }}', +connector_class = '{{ connector_class }}', +connector_type = '{{ connector_type }}', +cloud = '{{ cloud }}', sensitive_config_properties = '{{ sensitive_config_properties }}', -upload_source = '{{ upload_source }}' +upload_source = '{{ upload_source }}', +runtime_language = '{{ runtime_language }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +RETURNING +id, +display_name, +api_version, +cloud, +connector_class, +connector_type, +content_format, +description, +documentation_link, +kind, +metadata, +runtime_language, +sensitive_config_properties, +upload_source; ``` + + + -## `DELETE` example +## `DELETE` examples -Deletes the specified custom_connector_plugins resource. + + + +Make a request to delete a custom connector plugin. ```sql -/*+ delete */ DELETE FROM confluent.connect.custom_connector_plugins -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/connect/custom_connector_runtimes/index.md b/website/docs/services/connect/custom_connector_runtimes/index.md new file mode 100644 index 0000000..8cd4d96 --- /dev/null +++ b/website/docs/services/connect/custom_connector_runtimes/index.md @@ -0,0 +1,184 @@ +--- +title: custom_connector_runtimes +hide_title: false +hide_table_of_contents: false +keywords: + - custom_connector_runtimes + - connect + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a custom_connector_runtimes resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Custom Connector Runtime. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringName of the runtime that is being used while provisioning a custom connector. This corresponds to the property custom.connect.plugin.runtime in the connector configuration. (example: 3.9.0)
stringAPIVersion defines the schema version of this representation of a resource. (connect/v1)
stringDescription of the runtime (example: Custom Connector Plugin runtime using AK 3.9.0 and supporting Java 11 and 17)
string (date-time)End of Life date for the runtime (example: 2006-01-02T15:04:05-07:00)
stringKind defines the object this REST resource represents. (CustomConnectorRuntime)
stringThe product maturity phase for the plugin runtime. EA (Early Access), GA (Generally Available), or Preview. (example: GA)
stringThe underlying version of Apache Kafka which bundles the connect runtime (example: 3.9.0)
arrayList of supported Java versions
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
page_size, page_tokenRetrieve a sorted, filtered, paginated list of all custom connector runtimes.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
+ +## `SELECT` examples + + + + +Retrieve a sorted, filtered, paginated list of all custom connector runtimes. + +```sql +SELECT +id, +custom_connect_plugin_runtime_name, +api_version, +description, +end_of_life_at, +kind, +product_maturity, +runtime_ak_version, +supported_java_versions +FROM confluent.connect.custom_connector_runtimes +WHERE page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + diff --git a/website/docs/services/connect/index.md b/website/docs/services/connect/index.md index b7f75f4..114e16d 100644 --- a/website/docs/services/connect/index.md +++ b/website/docs/services/connect/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png connect service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 10
-
-
+total resources: __10__ ::: @@ -37,8 +33,8 @@ connect service documentation.
connectors
-connectors_with_expansions
custom_connector_plugins
+custom_connector_runtimes
managed_connector_plugins
presigned_urls
diff --git a/website/docs/services/connect/managed_connector_plugins/index.md b/website/docs/services/connect/managed_connector_plugins/index.md index 10e6088..b3a3ebf 100644 --- a/website/docs/services/connect/managed_connector_plugins/index.md +++ b/website/docs/services/connect/managed_connector_plugins/index.md @@ -1,4 +1,4 @@ ---- +--- title: managed_connector_plugins hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,28 +23,120 @@ Creates, updates, deletes, gets or lists a managed_connector_plugins -Namemanaged_connector_plugins +Name TypeResource Id ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The connector class name. E.g. BigQuerySink. | -| | `string` | Type of connector, sink or source. | -| | `string` | The version string for the connector available. | + +The following fields are returned by `SELECT` queries: + + + + +Connector Plugin. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe connector class name. E.g. BigQuerySink.
stringType of connector, sink or source. (sink, source)
stringThe version string for the connector available.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return a list of Managed Connector plugins installed in the Kafka Connect cluster. | -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Validate the provided configuration values against the configuration definition. This API performs per config validation and returns suggested values and validation error messages. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return a list of Managed Connector plugins installed in the Kafka Connect cluster.
Validate the provided configuration values against the configuration definition. This API performs per config validation and returns suggested values and validation error messages.
Translate the provided Self Managed configuration values. This API performs configuration translation
and returns the translated fully managed configuration along with any errors or warnings.
Query Parameter `mask_sensitive=true` redacts sensitive config values in response.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return a list of Managed Connector plugins installed in the Kafka Connect cluster. + + +Return a list of Managed Connector plugins installed in the Kafka Connect cluster. ```sql SELECT @@ -51,6 +144,39 @@ class, type, version FROM confluent.connect.managed_connector_plugins -WHERE environment_id = '{{ environment_id }}' -AND kafka_cluster_id = '{{ kafka_cluster_id }}'; -``` \ No newline at end of file +; +``` + + + + +## Lifecycle Methods + + + + +Validate the provided configuration values against the configuration definition. This API performs per config validation and returns suggested values and validation error messages. + +```sql +EXEC confluent.connect.managed_connector_plugins.validate_connectv1_connector_plugin + +; +``` + + + +Translate the provided Self Managed configuration values. This API performs configuration translation
and returns the translated fully managed configuration along with any errors or warnings.
Query Parameter `mask_sensitive=true` redacts sensitive config values in response. + +```sql +EXEC confluent.connect.managed_connector_plugins.translate_connectv1_connector_plugin + +; +``` + + diff --git a/website/docs/services/connect/presigned_urls/index.md b/website/docs/services/connect/presigned_urls/index.md index 86df4e4..459d747 100644 --- a/website/docs/services/connect/presigned_urls/index.md +++ b/website/docs/services/connect/presigned_urls/index.md @@ -1,4 +1,4 @@ ---- +--- title: presigned_urls hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,16 +23,79 @@ Creates, updates, deletes, gets or lists a presigned_urls resource. ## Overview - +
Namepresigned_urls
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + `SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Request a presigned upload URL to upload a Custom Connector Plugin archive. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
content_formatRequest a presigned upload URL to upload a Custom Connector Plugin archive.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## Lifecycle Methods + + + + +Request a presigned upload URL to upload a Custom Connector Plugin archive. + +```sql +EXEC confluent.connect.presigned_urls.presigned_upload_url_connect_v1_presigned_url +@@json= +'{ +"content_format": "{{ content_format }}", +"cloud": "{{ cloud }}" +}' +; +``` + + diff --git a/website/docs/services/encryption_keys/data_encryption_keys/index.md b/website/docs/services/encryption_keys/data_encryption_keys/index.md index e1b5c60..543cdb1 100644 --- a/website/docs/services/encryption_keys/data_encryption_keys/index.md +++ b/website/docs/services/encryption_keys/data_encryption_keys/index.md @@ -1,4 +1,4 @@ ---- +--- title: data_encryption_keys hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,36 +23,212 @@ Creates, updates, deletes, gets or lists a data_encryption_keys res ## Overview - +
Namedata_encryption_keys
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | Algorithm of the dek | -| | `boolean` | Whether the dek is deleted | -| | `string` | Encrypted key material of the dek | -| | `string` | Kek name of the dek | -| | `string` | Raw key material of the dek | -| | `string` | Subject of the dek | -| | `integer` | Timestamp of the dek | -| | `integer` | Version of the dek | + +The following fields are returned by `SELECT` queries: + + + + +The dek info + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAlgorithm of the dek (AES128_GCM, AES256_GCM, AES256_SIV)
booleanWhether the dek is deleted
stringEncrypted key material of the dek
stringKek name of the dek
stringRaw key material of the dek
stringSubject of the dek
integer (int64)Timestamp of the dek
integer (int32)Version of the dek
+ + + +List of dek subjects + + + + + + + + + + + +
NameDatatypeDescription
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | | -| | `SELECT` | | | -| | `INSERT` | | | -| | `DELETE` | | | -| | `EXEC` | | | -## `SELECT` examples +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
name, subjectalgorithm, deleted
namedeleted, offset, limit
name
name, subjectalgorithm, permanent
name, subjectalgorithm
+ +## Parameters +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the kek
stringSubject of the dek
stringAlgorithm of the dek
booleanWhether to include deleted keys
integerPagination size for results. Ignored if negative
integerPagination offset for results
booleanWhether to perform a permanent delete
+ +## `SELECT` examples + + + +The dek info ```sql SELECT @@ -64,85 +241,149 @@ subject, ts, version FROM confluent.encryption_keys.data_encryption_keys -WHERE name = '{{ name }}'; +WHERE name = '{{ name }}' -- required +AND subject = '{{ subject }}' -- required +AND algorithm = '{{ algorithm }}' +AND deleted = '{{ deleted }}' +; ``` -## `INSERT` example - -Use the following StackQL query and manifest file to create a new data_encryption_keys resource. + + - - +List of dek subjects ```sql -/*+ create */ -INSERT INTO confluent.encryption_keys.data_encryption_keys ( -data__subject, -data__version, -data__algorithm, -data__encryptedKeyMaterial, -data__deleted, -name -) -SELECT -'{{ subject }}', -'{{ version }}', -'{{ algorithm }}', -'{{ encryptedKeyMaterial }}', -'{{ deleted }}', -'{{ name }}' +SELECT +* +FROM confluent.encryption_keys.data_encryption_keys +WHERE name = '{{ name }}' -- required +AND deleted = '{{ deleted }}' +AND offset = '{{ offset }}' +AND limit = '{{ limit }}' ; ``` + + - +## `INSERT` examples + + + + +No description available. ```sql -/*+ create */ INSERT INTO confluent.encryption_keys.data_encryption_keys ( +subject, +version, +algorithm, +encryptedKeyMaterial, +deleted, name ) SELECT +'{{ subject }}', +{{ version }}, +'{{ algorithm }}', +'{{ encryptedKeyMaterial }}', +{{ deleted }}, '{{ name }}' +RETURNING +algorithm, +deleted, +encryptedKeyMaterial, +kekName, +keyMaterial, +subject, +ts, +version ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: data_encryption_keys props: - name: name - value: string + value: "{{ name }}" + description: Required parameter for the data_encryption_keys resource. - name: subject - value: string + value: "{{ subject }}" + description: | + Subject of the dek - name: version - value: integer + value: {{ version }} + description: | + Version of the dek - name: algorithm - value: string + value: "{{ algorithm }}" + description: | + Algorithm of the dek + valid_values: ['AES128_GCM', 'AES256_GCM', 'AES256_SIV'] - name: encryptedKeyMaterial - value: string + value: "{{ encryptedKeyMaterial }}" + description: | + Encrypted key material of the dek - name: deleted - value: boolean + value: {{ deleted }} + description: | + Whether the dek is deleted +`} -``` -## `DELETE` example -Deletes the specified data_encryption_keys resource. +## `DELETE` examples + + + + +No description available. ```sql -/*+ delete */ DELETE FROM confluent.encryption_keys.data_encryption_keys -WHERE name = '{{ name }}' -AND subject = '{{ subject }}'; +WHERE name = '{{ name }}' --required +AND subject = '{{ subject }}' --required +AND algorithm = '{{ algorithm }}' +AND permanent = '{{ permanent }}' +; ``` + + + + +## Lifecycle Methods + + + + +No Content + +```sql +EXEC confluent.encryption_keys.data_encryption_keys.undelete_dek_versions +@name='{{ name }}' --required, +@subject='{{ subject }}' --required, +@algorithm='{{ algorithm }}' +; +``` + + diff --git a/website/docs/services/encryption_keys/dek_versions/index.md b/website/docs/services/encryption_keys/dek_versions/index.md index c27899d..8e6983f 100644 --- a/website/docs/services/encryption_keys/dek_versions/index.md +++ b/website/docs/services/encryption_keys/dek_versions/index.md @@ -1,4 +1,4 @@ ---- +--- title: dek_versions hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,35 +23,210 @@ Creates, updates, deletes, gets or lists a dek_versions resource. ## Overview - +
Namedek_versions
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | Algorithm of the dek | -| | `boolean` | Whether the dek is deleted | -| | `string` | Encrypted key material of the dek | -| | `string` | Kek name of the dek | -| | `string` | Raw key material of the dek | -| | `string` | Subject of the dek | -| | `integer` | Timestamp of the dek | -| | `integer` | Version of the dek | + +The following fields are returned by `SELECT` queries: + + + + +The dek info + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAlgorithm of the dek (AES128_GCM, AES256_GCM, AES256_SIV)
booleanWhether the dek is deleted
stringEncrypted key material of the dek
stringKek name of the dek
stringRaw key material of the dek
stringSubject of the dek
integer (int64)Timestamp of the dek
integer (int32)Version of the dek
+ + + +List of version numbers for dek + + + + + + + + + + + +
NameDatatypeDescription
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | | -| | `SELECT` | | | -| | `DELETE` | | | -| | `EXEC` | | | -## `SELECT` examples +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
name, subject, versionalgorithm, deleted
name, subjectalgorithm, deleted, offset, limit
name, subject, versionalgorithm, permanent
name, subject, versionalgorithm
+## Parameters +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the kek
stringSubject of the dek
stringVersion of the dek
stringAlgorithm of the dek
booleanWhether to include deleted keys
integerPagination size for results. Ignored if negative
integerPagination offset for results
booleanWhether to perform a permanent delete
+ +## `SELECT` examples + + + + +The dek info ```sql SELECT @@ -63,17 +239,78 @@ subject, ts, version FROM confluent.encryption_keys.dek_versions -WHERE name = '{{ name }}' -AND subject = '{{ subject }}'; +WHERE name = '{{ name }}' -- required +AND subject = '{{ subject }}' -- required +AND version = '{{ version }}' -- required +AND algorithm = '{{ algorithm }}' +AND deleted = '{{ deleted }}' +; ``` -## `DELETE` example + + -Deletes the specified dek_versions resource. +List of version numbers for dek + +```sql +SELECT +* +FROM confluent.encryption_keys.dek_versions +WHERE name = '{{ name }}' -- required +AND subject = '{{ subject }}' -- required +AND algorithm = '{{ algorithm }}' +AND deleted = '{{ deleted }}' +AND offset = '{{ offset }}' +AND limit = '{{ limit }}' +; +``` + + + + +## `DELETE` examples + + + + +No description available. ```sql -/*+ delete */ DELETE FROM confluent.encryption_keys.dek_versions -WHERE name = '{{ name }}' -AND subject = '{{ subject }}' -AND version = '{{ version }}'; +WHERE name = '{{ name }}' --required +AND subject = '{{ subject }}' --required +AND version = '{{ version }}' --required +AND algorithm = '{{ algorithm }}' +AND permanent = '{{ permanent }}' +; +``` + + + + +## Lifecycle Methods + + + + +No Content + +```sql +EXEC confluent.encryption_keys.dek_versions.undelete_dek_version +@name='{{ name }}' --required, +@subject='{{ subject }}' --required, +@version='{{ version }}' --required, +@algorithm='{{ algorithm }}' +; ``` + + diff --git a/website/docs/services/encryption_keys/index.md b/website/docs/services/encryption_keys/index.md index 6a4babd..c617c2f 100644 --- a/website/docs/services/encryption_keys/index.md +++ b/website/docs/services/encryption_keys/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png encryption_keys service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 4
-
-
+total resources: __4__ ::: diff --git a/website/docs/services/encryption_keys/key_encryption_keys/index.md b/website/docs/services/encryption_keys/key_encryption_keys/index.md index 2d0a666..82ee8ef 100644 --- a/website/docs/services/encryption_keys/key_encryption_keys/index.md +++ b/website/docs/services/encryption_keys/key_encryption_keys/index.md @@ -1,4 +1,4 @@ ---- +--- title: key_encryption_keys hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,37 +23,211 @@ Creates, updates, deletes, gets or lists a key_encryption_keys reso ## Overview - +
Namekey_encryption_keys
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | Name of the kek | -| | `boolean` | Whether the kek is deleted | -| | `string` | Description of the kek | -| | `string` | KMS key ID of the kek | -| | `object` | Properties of the kek | -| | `string` | KMS type of the kek | -| | `boolean` | Whether the kek is shared | -| | `integer` | Timestamp of the kek | + +The following fields are returned by `SELECT` queries: + + + + +The kek info + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the kek
booleanWhether the kek is deleted
stringDescription of the kek
stringKMS key ID of the kek
objectProperties of the kek
stringKMS type of the kek
booleanWhether the kek is shared
integer (int64)Timestamp of the kek
+ + + +List of kek names + + + + + + + + + + + +
NameDatatypeDescription
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | | -| | `SELECT` | | | -| | `INSERT` | | | -| | `DELETE` | | | -| | `REPLACE` | | | -| | `EXEC` | | | -## `SELECT` examples +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
namedeleted
deleted
testSharing
nametestSharing
namepermanent
name
name
+## Parameters +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the kek
booleanWhether to include deleted keys
booleanWhether to perform a permanent delete
booleanWhether to test kek sharing
+ +## `SELECT` examples + + + + +The kek info ```sql SELECT @@ -65,32 +240,49 @@ kmsType, shared, ts FROM confluent.encryption_keys.key_encryption_keys +WHERE name = '{{ name }}' -- required +AND deleted = '{{ deleted }}' +; +``` + + + +List of kek names + +```sql +SELECT +* +FROM confluent.encryption_keys.key_encryption_keys +WHERE deleted = '{{ deleted }}' ; ``` -## `INSERT` example + + + -Use the following StackQL query and manifest file to create a new key_encryption_keys resource. +## `INSERT` examples - + { label: 'create_kek', value: 'create_kek' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +No description available. ```sql -/*+ create */ INSERT INTO confluent.encryption_keys.key_encryption_keys ( -data__name, -data__kmsType, -data__kmsKeyId, -data__kmsProps, -data__doc, -data__shared, -data__deleted +name, +kmsType, +kmsKeyId, +kmsProps, +doc, +shared, +deleted, +testSharing ) SELECT '{{ name }}', @@ -98,57 +290,148 @@ SELECT '{{ kmsKeyId }}', '{{ kmsProps }}', '{{ doc }}', -'{{ shared }}', -'{{ deleted }}' +{{ shared }}, +{{ deleted }}, +'{{ testSharing }}' +RETURNING +name, +deleted, +doc, +kmsKeyId, +kmsProps, +kmsType, +shared, +ts ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: key_encryption_keys props: - name: name - value: string + value: "{{ name }}" + description: | + Name of the kek - name: kmsType - value: string + value: "{{ kmsType }}" + description: | + KMS type of the kek - name: kmsKeyId - value: string + value: "{{ kmsKeyId }}" + description: | + KMS key ID of the kek - name: kmsProps - value: object + value: "{{ kmsProps }}" + description: | + Properties of the kek - name: doc - value: string + value: "{{ doc }}" + description: | + Description of the kek - name: shared - value: boolean + value: {{ shared }} + description: | + Whether the kek is shared - name: deleted - value: boolean + value: {{ deleted }} + description: | + Whether the kek is deleted + - name: testSharing + value: {{ testSharing }} + description: Whether to test kek sharing + description: Whether to test kek sharing +`} -``` -## `REPLACE` example -Replaces all fields in the specified key_encryption_keys resource. +## `REPLACE` examples + + + + +No description available. ```sql -/*+ update */ REPLACE confluent.encryption_keys.key_encryption_keys SET kmsProps = '{{ kmsProps }}', doc = '{{ doc }}', -shared = true|false +shared = {{ shared }} WHERE -name = '{{ name }}'; +name = '{{ name }}' --required +AND testSharing = {{ testSharing}} +RETURNING +name, +deleted, +doc, +kmsKeyId, +kmsProps, +kmsType, +shared, +ts; ``` + + + + +## `DELETE` examples -## `DELETE` example + + -Deletes the specified key_encryption_keys resource. +No description available. ```sql -/*+ delete */ DELETE FROM confluent.encryption_keys.key_encryption_keys -WHERE name = '{{ name }}'; +WHERE name = '{{ name }}' --required +AND permanent = '{{ permanent }}' +; ``` + + + + +## Lifecycle Methods + + + + +No Content + +```sql +EXEC confluent.encryption_keys.key_encryption_keys.undelete_kek +@name='{{ name }}' --required +; +``` + + + +The test response + +```sql +EXEC confluent.encryption_keys.key_encryption_keys.test_kek +@name='{{ name }}' --required +; +``` + + diff --git a/website/docs/services/encryption_keys/keys/index.md b/website/docs/services/encryption_keys/keys/index.md index 7b099ad..3752225 100644 --- a/website/docs/services/encryption_keys/keys/index.md +++ b/website/docs/services/encryption_keys/keys/index.md @@ -1,4 +1,4 @@ ---- +--- title: keys hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,94 +23,434 @@ Creates, updates, deletes, gets or lists a keys resource. ## Overview - +
Namekeys
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `object` | The cloud-specific key details. For AWS, provide the corresponding `key_arn`. For Azure, provide the corresponding `key_id`. For GCP, provide the corresponding `key_id`. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `string` | The cloud provider of the Key. | -| | `string` | The state of the key: AVAILABLE: key can be used for a Kafka cluster provisioning IN_USE: key is already in use by a Kafka cluster provisioning | + +The following fields are returned by `SELECT` queries: + + + + +Key. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe human-readable name of the key object. (example: Key for billing cluster)
stringAPIVersion defines the schema version of this representation of a resource. (byok/v1)
objectThe cloud-specific key details. For AWS, provide the corresponding `key_arn`. For Azure, provide the corresponding `key_id`. For GCP, provide the corresponding `key_id`.
stringKind defines the object this REST resource represents. (Key)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe cloud provider of the Key. (example: AWS)
stringThe state of the key: AVAILABLE: key can be used for a Kafka cluster provisioning. IN_USE: key is already in use by a Kafka cluster provisioning. (example: IN_USE)
objectThe validation details of the key.
+ + + +Key. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe human-readable name of the key object. (example: Key for billing cluster)
stringAPIVersion defines the schema version of this representation of a resource. (byok/v1)
objectThe cloud-specific key details. For AWS, provide the corresponding `key_arn`. For Azure, provide the corresponding `key_id`. For GCP, provide the corresponding `key_id`.
stringKind defines the object this REST resource represents. (Key)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe cloud provider of the Key. (example: AWS)
stringThe state of the key: AVAILABLE: key can be used for a Kafka cluster provisioning. IN_USE: key is already in use by a Kafka cluster provisioning. (example: IN_USE)
objectThe validation details of the key.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a key. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all keys. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a key. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a key. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a key.
display_name, provider, state, validation_phase, validation_region, key, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all keys.
keyMake a request to create a key.
idMake a request to update a key.

idMake a request to delete a key.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the key.
stringFilter the results by a partial search of display_name. (example: Key for billing cluster)
stringFilters results by a partial match on the key identifier: key_arn for AWS, key_id for Azure and GCP. (example: vault-name)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for provider. (example: AWS)
stringFilter the results by exact match for state. (example: IN_USE)
stringFilter the results by exact match for validation_phase.
stringFilter keys by the cloud region where they are deployed. (example: us-west-2)
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all keys. + + +Make a request to read a key. ```sql SELECT id, +display_name, api_version, key, kind, metadata, provider, -state +state, +validation FROM confluent.encryption_keys.keys +WHERE id = '{{ id }}' -- required ; ``` -## `INSERT` example + + + +Retrieve a sorted, filtered, paginated list of all keys. + +```sql +SELECT +id, +display_name, +api_version, +key, +kind, +metadata, +provider, +state, +validation +FROM confluent.encryption_keys.keys +WHERE display_name = '{{ display_name }}' +AND provider = '{{ provider }}' +AND state = '{{ state }}' +AND validation_phase = '{{ validation_phase }}' +AND validation_region = '{{ validation_region }}' +AND key = '{{ key }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + -Use the following StackQL query and manifest file to create a new keys resource. +## `INSERT` examples - + { label: 'create_byok_v1_key', value: 'create_byok_v1_key' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a key. ```sql -/*+ create */ INSERT INTO confluent.encryption_keys.keys ( -data__key +key, +display_name ) SELECT -'{{ key }}' +'{{ key }}' /* required */, +'{{ display_name }}' +RETURNING +id, +display_name, +api_version, +key, +kind, +metadata, +provider, +state, +validation ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: keys props: - name: key - props: - - name: key_arn - value: string - - name: kind - value: string + description: | + The cloud-specific key details. + For AWS, provide the corresponding \`key_arn\`. + For Azure, provide the corresponding \`key_id\`. + For GCP, provide the corresponding \`key_id\`. + value: + key_arn: "{{ key_arn }}" + roles: + - "{{ roles }}" + kind: "{{ kind }}" + application_id: "{{ application_id }}" + key_id: "{{ key_id }}" + key_vault_id: "{{ key_vault_id }}" + tenant_id: "{{ tenant_id }}" + security_group: "{{ security_group }}" + - name: display_name + value: "{{ display_name }}" + description: | + The human-readable name of the key object. +`} + + + + + +## `UPDATE` examples + + + + +Make a request to update a key.

+```sql +UPDATE confluent.encryption_keys.keys +SET +key = '{{ key }}', +display_name = '{{ display_name }}' +WHERE +id = '{{ id }}' --required +RETURNING +id, +display_name, +api_version, +key, +kind, +metadata, +provider, +state, +validation; ``` -## `DELETE` example -Deletes the specified keys resource. +## `DELETE` examples + + + + +Make a request to delete a key. ```sql -/*+ delete */ DELETE FROM confluent.encryption_keys.keys -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/endpoints/endpoints/index.md b/website/docs/services/endpoints/endpoints/index.md new file mode 100644 index 0000000..287e833 --- /dev/null +++ b/website/docs/services/endpoints/endpoints/index.md @@ -0,0 +1,256 @@ +--- +title: endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - endpoints + - endpoints + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an endpoints resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Endpoint. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
objectThe access_point to which this belongs.
stringAPIVersion defines the schema version of this representation of a resource. (endpoint/v1)
stringThe cloud service provider. (example: AWS)
stringThe network connection type. (example: PRIVATE_LINK)
stringThe endpoint URL or address. (example: https://lkc-abc123-ap12345.us-west-2.aws.accesspoint.glb.confluent.cloud:443)
stringThe endpoint type enum values: * `REST` - REST API endpoint for HTTP/HTTPS access, used by Kafka/Flink/Schema Registry services. * `BOOTSTRAP` - Kafka native protocol bootstrap servers for direct client connections, used by Kafka only. * `LANGUAGE_SERVICE` - Flink language service endpoint for SQL/Table API, used by Flink only.
objectThe environment to which this belongs.
objectThe gateway to which this belongs.
booleanWhether the endpoint is private (true) or public (false).
stringKind defines the object this REST resource represents. (Endpoint)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe cloud service provider region in which the resource is located. (example: us-west-2)
objectThe resource associated with the endpoint. The resource can be one of Kafka Cluster ID (example: lkc-12345), or Schema Registry Cluster ID (example: lsrc-12345). May be null or omitted if not associated with a resource.
stringThe Confluent Cloud service. (example: KAFKA)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
service, environmentcloud, region, is_private, resource, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all endpoints.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringFilter the results by exact match for environment. (example: env-00000)
stringFilter the results by exact match for service. (example: KAFKA)
stringFilter the results by exact match for cloud. (example: AWS)
booleanFilter the results by whether the endpoint is private (true) or public (false). If not specified, returns both private and public endpoints. (example: true)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for region. (example: us-west-2)
stringFilter the results by exact match for resource. (example: lkc-abc123)
+ +## `SELECT` examples + + + + +Retrieve a sorted, filtered, paginated list of all endpoints. + +```sql +SELECT +id, +access_point, +api_version, +cloud, +connection_type, +endpoint, +endpoint_type, +environment, +gateway, +is_private, +kind, +metadata, +region, +resource, +service +FROM confluent.endpoints.endpoints +WHERE service = '{{ service }}' -- required +AND environment = '{{ environment }}' -- required +AND cloud = '{{ cloud }}' +AND region = '{{ region }}' +AND is_private = '{{ is_private }}' +AND resource = '{{ resource }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + diff --git a/website/docs/services/endpoints/index.md b/website/docs/services/endpoints/index.md new file mode 100644 index 0000000..283fd84 --- /dev/null +++ b/website/docs/services/endpoints/index.md @@ -0,0 +1,33 @@ +--- +title: endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - endpoints + - confluent + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +endpoints service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+endpoints +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/flink_artifacts/flink_artifacts/index.md b/website/docs/services/flink_artifacts/flink_artifacts/index.md index 559a187..ef47f22 100644 --- a/website/docs/services/flink_artifacts/flink_artifacts/index.md +++ b/website/docs/services/flink_artifacts/flink_artifacts/index.md @@ -1,4 +1,4 @@ ---- +--- title: flink_artifacts hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,52 +23,345 @@ Creates, updates, deletes, gets or lists a flink_artifacts resource ## Overview - +
Nameflink_artifacts
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | Description of the Flink Artifact. | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Java class or alias for the artifact as provided by developer. | -| | `string` | Cloud provider where the Flink Artifact archive is uploaded. | -| | `string` | Archive format of the Flink Artifact. | -| | `string` | Display name of the Flink Artifact. | -| | `string` | Document link of the Flink Artifact. | -| | `string` | Environment the Flink Artifact belongs to. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `string` | The Cloud provider region the Flink Artifact archive is uploaded. | -| | `string` | Runtime language of the Flink Artifact. | -| | `array` | Versions associated with this Flink Artifact. | + +The following fields are returned by `SELECT` queries: + + + + +Flink Artifact. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringUnique name of the Flink Artifact per cloud, region, environment scope.
stringAPIVersion defines the schema version of this representation of a resource. (artifact/v1)
stringJava class or alias for the artifact as provided by developer. Deprecated (pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$, example: io.confluent.example.SumScalarFunction)
stringCloud provider where the Flink Artifact archive is uploaded. (example: AWS)
stringArchive format of the Flink Artifact. (example: JAR)
stringDescription of the Flink Artifact.
stringDocumentation link of the Flink Artifact. (pattern: ^$|^(http://|https://).+)
stringEnvironment the Flink Artifact belongs to. (example: env-00000)
stringKind defines the object this REST resource represents. (FlinkArtifact)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe Cloud provider region the Flink Artifact archive is uploaded. (example: us-east-1)
stringRuntime language of the Flink Artifact. (example: JAVA, default: JAVA)
arrayVersions associated with this Flink Artifact.
+ + + +Flink Artifact. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringUnique name of the Flink Artifact per cloud, region, environment scope.
stringAPIVersion defines the schema version of this representation of a resource. (artifact/v1)
stringJava class or alias for the artifact as provided by developer. Deprecated (pattern: ^(([a-zA-Z][a-zA-Z_$0-9]*(\.[a-zA-Z][a-zA-Z_$0-9]*)*)\.)?([a-zA-Z][a-zA-Z_$0-9]*)$, example: io.confluent.example.SumScalarFunction)
stringCloud provider where the Flink Artifact archive is uploaded. (example: AWS)
stringArchive format of the Flink Artifact. (example: JAR)
stringDescription of the Flink Artifact.
stringDocumentation link of the Flink Artifact. (pattern: ^$|^(http://|https://).+)
stringEnvironment the Flink Artifact belongs to. (example: env-00000)
stringKind defines the object this REST resource represents. (FlinkArtifact)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe Cloud provider region the Flink Artifact archive is uploaded. (example: us-east-1)
stringRuntime language of the Flink Artifact. (example: JAVA, default: JAVA)
arrayVersions associated with this Flink Artifact.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Flink Artifact API EA](https://img.shields.io/badge/-Request%20Access%20To%20Flink%20Artifact%20API%20EA-%23bc8540)](mailto:ccloud-api-access+artifact-v1-early-access@confluent.io?subject=Request%20to%20join%20artifact/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20artifact/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Make a request to read a flink artifact. | -| | `SELECT` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Flink Artifact API EA](https://img.shields.io/badge/-Request%20Access%20To%20Flink%20Artifact%20API%20EA-%23bc8540)](mailto:ccloud-api-access+artifact-v1-early-access@confluent.io?subject=Request%20to%20join%20artifact/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20artifact/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Retrieve a sorted, filtered, paginated list of all flink artifacts. If no `environment` filter is specified, returns Artifacts across envs for cloud & region. | -| | `INSERT` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Flink Artifact API EA](https://img.shields.io/badge/-Request%20Access%20To%20Flink%20Artifact%20API%20EA-%23bc8540)](mailto:ccloud-api-access+artifact-v1-early-access@confluent.io?subject=Request%20to%20join%20artifact/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20artifact/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Make a request to create a flink artifact. | -| | `DELETE` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Flink Artifact API EA](https://img.shields.io/badge/-Request%20Access%20To%20Flink%20Artifact%20API%20EA-%23bc8540)](mailto:ccloud-api-access+artifact-v1-early-access@confluent.io?subject=Request%20to%20join%20artifact/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20artifact/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Make a request to delete a flink artifact. | -| | `UPDATE` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Flink Artifact API EA](https://img.shields.io/badge/-Request%20Access%20To%20Flink%20Artifact%20API%20EA-%23bc8540)](mailto:ccloud-api-access+artifact-v1-early-access@confluent.io?subject=Request%20to%20join%20artifact/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20artifact/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Make a request to update a flink artifact. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
cloud, region, environment, idMake a request to read a flink artifact.
cloud, region, environmentpage_size, page_tokenRetrieve a sorted, filtered, paginated list of all flink artifacts.
cloud, region, cloud, region, environment, display_name, upload_sourceMake a request to create a flink artifact.
cloud, region, environment, idMake a request to update a flink artifact.

cloud, region, environment, idMake a request to delete a flink artifact.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given cloud. (example: AWS)
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the flink artifact.
stringScope the operation to the given region. (example: us-east-1)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Flink Artifact API EA](https://img.shields.io/badge/-Request%20Access%20To%20Flink%20Artifact%20API%20EA-%23bc8540)](mailto:ccloud-api-access+artifact-v1-early-access@confluent.io?subject=Request%20to%20join%20artifact/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20artifact/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Retrieve a sorted, filtered, paginated list of all flink artifacts. If no `environment` filter is specified, returns Artifacts across envs for cloud & region. + + +Make a request to read a flink artifact. ```sql SELECT id, -description, +display_name, api_version, class, cloud, content_format, +description, +documentation_link, +environment, +kind, +metadata, +region, +runtime_language, +versions +FROM confluent.flink_artifacts.flink_artifacts +WHERE cloud = '{{ cloud }}' -- required +AND region = '{{ region }}' -- required +AND environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all flink artifacts. + +```sql +SELECT +id, display_name, +api_version, +class, +cloud, +content_format, +description, documentation_link, environment, kind, @@ -76,160 +370,214 @@ region, runtime_language, versions FROM confluent.flink_artifacts.flink_artifacts -WHERE cloud = '{{ cloud }}' -AND region = '{{ region }}'; +WHERE cloud = '{{ cloud }}' -- required +AND region = '{{ region }}' -- required +AND environment = '{{ environment }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new flink_artifacts resource. + +## `INSERT` examples - + { label: 'create_artifact_v1_flink_artifact', value: 'create_artifact_v1_flink_artifact' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a flink artifact. ```sql -/*+ create */ INSERT INTO confluent.flink_artifacts.flink_artifacts ( -data__cloud, -data__region, -data__environment, -data__display_name, -data__class, -data__content_format, -data__description, -data__documentation_link, -data__runtime_language, -data__upload_source, +cloud, +region, +environment, +display_name, +class, +content_format, +description, +documentation_link, +runtime_language, +upload_source, cloud, region ) SELECT -'{{ cloud }}', -'{{ region }}', -'{{ environment }}', -'{{ display_name }}', +'{{ cloud }}' /* required */, +'{{ region }}' /* required */, +'{{ environment }}' /* required */, +'{{ display_name }}' /* required */, '{{ class }}', '{{ content_format }}', '{{ description }}', '{{ documentation_link }}', '{{ runtime_language }}', -'{{ upload_source }}' -; -``` - - - - -```sql -/*+ create */ -INSERT INTO confluent.flink_artifacts.flink_artifacts ( -data__cloud, -data__region, -data__environment, -data__display_name, -data__class, -data__upload_source, +'{{ upload_source }}' /* required */, +'{{ cloud }}' /* required */, +'{{ region }}' /* required */ +RETURNING +id, +display_name, +api_version, +class, cloud, -region -) -SELECT -'{{ cloud }}', -'{{ region }}', -'{{ environment }}', -'{{ display_name }}', -'{{ class }}', -'{{ upload_source }}' +content_format, +description, +documentation_link, +environment, +kind, +metadata, +region, +runtime_language, +versions ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: flink_artifacts props: - name: cloud - value: string + value: "{{ cloud }}" + description: Required parameter for the flink_artifacts resource. - name: region - value: string - - name: data__class - value: string - - name: data__cloud - value: string - - name: data__display_name - value: string - - name: data__environment - value: string - - name: data__region - value: string - - name: data__upload_source - value: string + value: "{{ region }}" + description: Required parameter for the flink_artifacts resource. - name: cloud - value: string + value: "{{ cloud }}" + description: | + Cloud provider where the Flink Artifact archive is uploaded. - name: region - value: string + value: "{{ region }}" + description: | + The Cloud provider region the Flink Artifact archive is uploaded. - name: environment - value: string + value: "{{ environment }}" + description: | + Environment the Flink Artifact belongs to. - name: display_name - value: string + value: "{{ display_name }}" + description: | + Unique name of the Flink Artifact per cloud, region, environment scope. - name: class - value: string + value: "{{ class }}" + description: | + Java class or alias for the artifact as provided by developer. Deprecated - name: content_format - value: string + value: "{{ content_format }}" + description: | + Archive format of the Flink Artifact. - name: description - value: string + value: "{{ description }}" + description: | + Description of the Flink Artifact. - name: documentation_link - value: string + value: "{{ documentation_link }}" + description: | + Documentation link of the Flink Artifact. - name: runtime_language - value: string + value: "{{ runtime_language }}" + description: | + Runtime language of the Flink Artifact. + default: JAVA - name: upload_source - props: - - name: location - value: string - - name: upload_id - value: string + description: | + Upload source of the Flink Artifact source. + value: + api_version: "{{ api_version }}" + kind: "{{ kind }}" + id: "{{ id }}" + metadata: + self: "{{ self }}" + resource_name: "{{ resource_name }}" + created_at: "{{ created_at }}" + updated_at: "{{ updated_at }}" + deleted_at: "{{ deleted_at }}" + location: "{{ location }}" + upload_id: "{{ upload_id }}" +`} -``` -## `UPDATE` example -Updates a flink_artifacts resource. +## `UPDATE` examples + + + + +Make a request to update a flink artifact.

```sql -/*+ update */ UPDATE confluent.flink_artifacts.flink_artifacts SET cloud = '{{ cloud }}', region = '{{ region }}', environment = '{{ environment }}', display_name = '{{ display_name }}', +class = '{{ class }}', content_format = '{{ content_format }}', description = '{{ description }}', documentation_link = '{{ documentation_link }}', runtime_language = '{{ runtime_language }}', versions = '{{ versions }}' WHERE -cloud = '{{ cloud }}' -AND id = '{{ id }}' -AND region = '{{ region }}'; +cloud = '{{ cloud }}' --required +AND region = '{{ region }}' --required +AND environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +RETURNING +id, +display_name, +api_version, +class, +cloud, +content_format, +description, +documentation_link, +environment, +kind, +metadata, +region, +runtime_language, +versions; ``` + + -## `DELETE` example -Deletes the specified flink_artifacts resource. +## `DELETE` examples + + + + +Make a request to delete a flink artifact. ```sql -/*+ delete */ DELETE FROM confluent.flink_artifacts.flink_artifacts -WHERE cloud = '{{ cloud }}' -AND id = '{{ id }}' -AND region = '{{ region }}'; +WHERE cloud = '{{ cloud }}' --required +AND region = '{{ region }}' --required +AND environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/flink_artifacts/index.md b/website/docs/services/flink_artifacts/index.md index 89ca409..d563e87 100644 --- a/website/docs/services/flink_artifacts/index.md +++ b/website/docs/services/flink_artifacts/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png flink_artifacts service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 2
-
-
+total resources: __2__ ::: diff --git a/website/docs/services/flink_artifacts/presigned_urls/index.md b/website/docs/services/flink_artifacts/presigned_urls/index.md index 861144e..e704740 100644 --- a/website/docs/services/flink_artifacts/presigned_urls/index.md +++ b/website/docs/services/flink_artifacts/presigned_urls/index.md @@ -1,4 +1,4 @@ ---- +--- title: presigned_urls hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,16 +23,81 @@ Creates, updates, deletes, gets or lists a presigned_urls resource. ## Overview - +
Namepresigned_urls
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + `SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `EXEC` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Flink Artifact API EA](https://img.shields.io/badge/-Request%20Access%20To%20Flink%20Artifact%20API%20EA-%23bc8540)](mailto:ccloud-api-access+artifact-v1-early-access@confluent.io?subject=Request%20to%20join%20artifact/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20artifact/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Request a presigned upload URL to upload a Flink Artifact archive. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
content_format, cloud, region, environmentRequest a presigned upload URL to upload a Flink Artifact archive.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## Lifecycle Methods + + + + +Request a presigned upload URL to upload a Flink Artifact archive. + +```sql +EXEC confluent.flink_artifacts.presigned_urls.presigned_upload_url_artifact_v1_presigned_url +@@json= +'{ +"content_format": "{{ content_format }}", +"cloud": "{{ cloud }}", +"region": "{{ region }}", +"environment": "{{ environment }}" +}' +; +``` + + diff --git a/website/docs/services/flink_compute_pools/compute_pools/index.md b/website/docs/services/flink_compute_pools/compute_pools/index.md index a48d283..5df921b 100644 --- a/website/docs/services/flink_compute_pools/compute_pools/index.md +++ b/website/docs/services/flink_compute_pools/compute_pools/index.md @@ -1,4 +1,4 @@ ---- +--- title: compute_pools hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,109 +23,373 @@ Creates, updates, deletes, gets or lists a compute_pools resource. ## Overview - +
Namecompute_pools
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Compute Pool | -| | `object` | The status of the Compute Pool | + +The following fields are returned by `SELECT` queries: + + + + +Compute Pool. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (fcpm/v2)
stringKind defines the object this REST resource represents. (ComputePool)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Compute Pool
objectThe status of the Compute Pool
+ + + +Compute Pool. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (fcpm/v2)
stringKind defines the object this REST resource represents. (ComputePool)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Compute Pool
objectThe status of the Compute Pool
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a compute pool. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all compute pools. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a compute pool. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a compute pool. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a compute pool. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a compute pool.
environmentspec.region, spec.network, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all compute pools.
specMake a request to create a compute pool.
id, specMake a request to update a compute pool.
environment, idMake a request to delete a compute pool.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the compute pool.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for spec.network. (example: n-00000)
stringFilter the results by exact match for spec.region. (example: us-west-1)
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all compute pools. + + + +Make a request to read a compute pool. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.flink_compute_pools.compute_pools +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all compute pools. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.flink_compute_pools.compute_pools -WHERE environment = '{{ environment }}'; +WHERE environment = '{{ environment }}' -- required +AND spec.region = '{{ spec.region }}' +AND spec.network = '{{ spec.network }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new compute_pools resource. + +## `INSERT` examples - + { label: 'create_fcpm_v2_compute_pool', value: 'create_fcpm_v2_compute_pool' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a compute pool. ```sql -/*+ create */ INSERT INTO confluent.flink_compute_pools.compute_pools ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: compute_pools props: - name: spec - props: - - name: environment - value: string - - name: network - value: string + description: | + The desired state of the Compute Pool + value: + display_name: "{{ display_name }}" + cloud: "{{ cloud }}" + region: "{{ region }}" + max_cfu: {{ max_cfu }} + enable_ai: {{ enable_ai }} + default_pool: {{ default_pool }} + environment: + id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + network: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} -``` -## `UPDATE` example -Updates a compute_pools resource. +## `UPDATE` examples + + + + +Make a request to update a compute pool. ```sql -/*+ update */ UPDATE confluent.flink_compute_pools.compute_pools SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified compute_pools resource. +Make a request to delete a compute pool. ```sql -/*+ delete */ DELETE FROM confluent.flink_compute_pools.compute_pools -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/flink_compute_pools/index.md b/website/docs/services/flink_compute_pools/index.md index 969d7d8..771aa93 100644 --- a/website/docs/services/flink_compute_pools/index.md +++ b/website/docs/services/flink_compute_pools/index.md @@ -16,20 +16,17 @@ image: /img/stackql-confluent-provider-featured-image.png flink_compute_pools service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 2
-
-
+total resources: __3__ ::: ## Resources
-compute_pools +compute_pools
+org_compute_pool_configs
regions diff --git a/website/docs/services/flink_compute_pools/org_compute_pool_configs/index.md b/website/docs/services/flink_compute_pools/org_compute_pool_configs/index.md new file mode 100644 index 0000000..4b1699b --- /dev/null +++ b/website/docs/services/flink_compute_pools/org_compute_pool_configs/index.md @@ -0,0 +1,175 @@ +--- +title: org_compute_pool_configs +hide_title: false +hide_table_of_contents: false +keywords: + - org_compute_pool_configs + - flink_compute_pools + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_compute_pool_configs resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Org Compute Pool Config. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the organization. (example: 9bb441c4-edef-46ac-8a41-c49e44a3fd9a)
stringAPIVersion defines the schema version of this representation of a resource. (fcpm/v2)
stringKind defines the object this REST resource represents. (OrgComputePoolConfig)
objectThe desired state of the organization-level Compute Pool configuration
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Make a request to read an org compute pool config.
Make a request to update an org compute pool config.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Make a request to read an org compute pool config. + +```sql +SELECT +organization_id, +api_version, +kind, +spec +FROM confluent.flink_compute_pools.org_compute_pool_configs +; +``` + + + + +## `UPDATE` examples + + + + +Make a request to update an org compute pool config. + +```sql +UPDATE confluent.flink_compute_pools.org_compute_pool_configs +SET +spec = '{{ spec }}' +RETURNING +organization_id, +api_version, +kind, +spec; +``` + + diff --git a/website/docs/services/flink_compute_pools/regions/index.md b/website/docs/services/flink_compute_pools/regions/index.md index a7d3a22..e64a358 100644 --- a/website/docs/services/flink_compute_pools/regions/index.md +++ b/website/docs/services/flink_compute_pools/regions/index.md @@ -1,4 +1,4 @@ ---- +--- title: regions hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,45 +23,174 @@ Creates, updates, deletes, gets or lists a regions resource. ## Overview - +
Nameregions
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | The cloud service provider that hosts the region. | -| | `string` | The display name. | -| | `string` | The regional API endpoint for Flink compute pools. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `string` | The private regional API endpoint for Flink compute pools. | -| | `string` | The region name. | + +The following fields are returned by `SELECT` queries: + + + + +Region. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe display name. (example: Ohio (us-east-2))
stringThe region name. (example: us-east-2)
stringAPIVersion defines the schema version of this representation of a resource. (fcpm/v2)
stringThe cloud service provider that hosts the region. (example: AWS)
string (uri)The regional API endpoint for Flink compute pools.
stringKind defines the object this REST resource represents. (Region)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
string (uri)The private regional API endpoint for Flink compute pools.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all regions. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
cloud, region_name, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all regions.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringFilter the results by exact match for cloud. (example: AWS)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for region_name. (example: us-east-2)
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all regions. + + +Retrieve a sorted, filtered, paginated list of all regions. ```sql SELECT id, +display_name, +region_name, api_version, cloud, -display_name, http_endpoint, kind, metadata, -private_http_endpoint, -region_name +private_http_endpoint FROM confluent.flink_compute_pools.regions +WHERE cloud = '{{ cloud }}' +AND region_name = '{{ region_name }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; -``` \ No newline at end of file +``` + + diff --git a/website/docs/services/iam/api_keys/index.md b/website/docs/services/iam/api_keys/index.md index 20cc591..0130865 100644 --- a/website/docs/services/iam/api_keys/index.md +++ b/website/docs/services/iam/api_keys/index.md @@ -1,4 +1,4 @@ ---- +--- title: api_keys hide_title: false hide_table_of_contents: false @@ -15,113 +15,359 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a api_keys resource. +Creates, updates, deletes, gets or lists an api_keys resource. ## Overview - +
Nameapi_keys
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Api Key | + +The following fields are returned by `SELECT` queries: + + + + +API Key. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringKind defines the object this REST resource represents. (ApiKey)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Api Key
+ + + +API Key. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringKind defines the object this REST resource represents. (ApiKey)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Api Key
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read an API key. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all API keys. This can show all keys for a single owner (across resources - Kafka clusters), or all keys for a single resource (across owners). If no `owner` or `resource` filters are specified, returns all API Keys in the organization. You will only see the keys that are accessible to the account making the API request. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create an API key. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete an API key. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update an API key. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read an API key.
spec.owner, spec.resource, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all API keys.

This can show all keys for a single owner (across resources - Kafka clusters), or all keys for a single
resource (across owners). If no `owner` or `resource` filters are specified, returns all API Keys in the
organization. You will only see the keys that are accessible to the account making the API request.
specMake a request to create an API key.
idMake a request to update an API key.

idMake a request to delete an API key.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the API key.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for spec.owner.
stringFilter the results by exact match for spec.resource.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all API keys. This can show all keys for a single owner (across resources - Kafka clusters), or all keys for a single resource (across owners). If no `owner` or `resource` filters are specified, returns all API Keys in the organization. You will only see the keys that are accessible to the account making the API request. + + +Make a request to read an API key. ```sql SELECT id, -_spec, api_version, kind, metadata, spec FROM confluent.iam.api_keys +WHERE id = '{{ id }}' -- required ; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new api_keys resource. +Retrieve a sorted, filtered, paginated list of all API keys.

This can show all keys for a single owner (across resources - Kafka clusters), or all keys for a single
resource (across owners). If no `owner` or `resource` filters are specified, returns all API Keys in the
organization. You will only see the keys that are accessible to the account making the API request.
+ +```sql +SELECT +id, +api_version, +kind, +metadata, +spec +FROM confluent.iam.api_keys +WHERE spec.owner = '{{ spec.owner }}' +AND spec.resource = '{{ spec.resource }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples - + { label: 'create_iam_v2_api_key', value: 'create_iam_v2_api_key' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create an API key. ```sql -/*+ create */ INSERT INTO confluent.iam.api_keys ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: api_keys props: - name: spec - props: - - name: owner - value: string - - name: resource - value: string + description: | + The desired state of the Api Key + value: + secret: "{{ secret }}" + display_name: "{{ display_name }}" + description: "{{ description }}" + owner: + id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" + resource: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" +`} -``` -## `UPDATE` example -Updates a api_keys resource. +## `UPDATE` examples + + + + +Make a request to update an API key.

```sql -/*+ update */ UPDATE confluent.iam.api_keys SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec; ``` + + -## `DELETE` example -Deletes the specified api_keys resource. +## `DELETE` examples + + + + +Make a request to delete an API key. ```sql -/*+ delete */ DELETE FROM confluent.iam.api_keys -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/iam/certificate_authorities/index.md b/website/docs/services/iam/certificate_authorities/index.md index 5c09cf8..1cdf379 100644 --- a/website/docs/services/iam/certificate_authorities/index.md +++ b/website/docs/services/iam/certificate_authorities/index.md @@ -1,4 +1,4 @@ ---- +--- title: certificate_authorities hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,53 +23,328 @@ Creates, updates, deletes, gets or lists a certificate_authorities ## Overview - +
Namecertificate_authorities
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | A description of the certificate authority. | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | The file name of the uploaded pem file for this certificate authority. | -| | `string` | The source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL). | -| | `string` | The timestamp for when CRL was last updated. | -| | `string` | The url from which to fetch the CRL for the certificate authority if crl_source is URL. | -| | `string` | The human-readable name of the certificate authority. | -| | `array` | The expiration dates of certificates in the chain. | -| | `array` | The fingerprints for each certificate in the certificate chain. These are SHA-1 encoded strings that act as unique identifiers for the certificates in the chain. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `array` | The serial numbers for each certificate in the certificate chain. | -| | `string` | The current state of the certificate authority. | + +The following fields are returned by `SELECT` queries: + + + + +Certificate Authority. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe human-readable name of the certificate authority. (example: My Certificate Authority)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringThe file name of the uploaded pem file for this certificate authority. (example: certificate.pem)
stringThe source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL). (example: LOCAL)
string (date-time)The timestamp for when CRL was last updated. (example: 2017-07-21T17:32:28.000Z)
string (uri)The url from which to fetch the CRL for the certificate authority if crl_source is URL.
stringA description of the certificate authority. (example: Sample description text)
arrayThe expiration dates of certificates in the chain.
arrayThe fingerprints for each certificate in the certificate chain. These are SHA-1 encoded strings that act as unique identifiers for the certificates in the chain.
stringKind defines the object this REST resource represents. (CertificateAuthority)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
arrayThe serial numbers for each certificate in the certificate chain.
stringThe current state of the certificate authority. (example: ENABLED)
+ + + +Certificate Authority. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe human-readable name of the certificate authority. (example: My Certificate Authority)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringThe file name of the uploaded pem file for this certificate authority. (example: certificate.pem)
stringThe source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL). (example: LOCAL)
string (date-time)The timestamp for when CRL was last updated. (example: 2017-07-21T17:32:28.000Z)
string (uri)The url from which to fetch the CRL for the certificate authority if crl_source is URL.
stringA description of the certificate authority. (example: Sample description text)
arrayThe expiration dates of certificates in the chain.
arrayThe fingerprints for each certificate in the certificate chain. These are SHA-1 encoded strings that act as unique identifiers for the certificates in the chain.
stringKind defines the object this REST resource represents. (CertificateAuthority)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
arrayThe serial numbers for each certificate in the certificate chain.
stringThe current state of the certificate authority. (example: ENABLED)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a certificate authority. | -| | `SELECT` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all certificate authorities. | -| | `INSERT` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a certificate authority. | -| | `DELETE` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a certificate authority. | -| | `EXEC` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a certificate authority. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a certificate authority.
page_size, page_tokenRetrieve a sorted, filtered, paginated list of all certificate authorities.
Make a request to create a certificate authority.
idMake a request to update a certificate authority.

idMake a request to delete a certificate authority.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the certificate authority.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all certificate authorities. + + +Make a request to read a certificate authority. ```sql SELECT id, -description, +display_name, api_version, certificate_chain_filename, crl_source, crl_updated_at, crl_url, +description, +expiration_dates, +fingerprints, +kind, +metadata, +serial_numbers, +state +FROM confluent.iam.certificate_authorities +WHERE id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all certificate authorities. + +```sql +SELECT +id, display_name, +api_version, +certificate_chain_filename, +crl_source, +crl_updated_at, +crl_url, +description, expiration_dates, fingerprints, kind, @@ -76,31 +352,35 @@ metadata, serial_numbers, state FROM confluent.iam.certificate_authorities +WHERE page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new certificate_authorities resource. + +## `INSERT` examples - + { label: 'create_iam_v2_certificate_authority', value: 'create_iam_v2_certificate_authority' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a certificate authority. ```sql -/*+ create */ INSERT INTO confluent.iam.certificate_authorities ( -data__display_name, -data__description, -data__certificate_chain, -data__certificate_chain_filename, -data__crl_url, -data__crl_chain +display_name, +description, +certificate_chain, +certificate_chain_filename, +crl_url, +crl_chain ) SELECT '{{ display_name }}', @@ -109,38 +389,120 @@ SELECT '{{ certificate_chain_filename }}', '{{ crl_url }}', '{{ crl_chain }}' +RETURNING +id, +display_name, +api_version, +certificate_chain_filename, +crl_source, +crl_updated_at, +crl_url, +description, +expiration_dates, +fingerprints, +kind, +metadata, +serial_numbers, +state ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: certificate_authorities props: - name: display_name - value: string + value: "{{ display_name }}" + description: | + The human-readable name of the certificate authority. - name: description - value: string + value: "{{ description }}" + description: | + A description of the certificate authority. - name: certificate_chain - value: string + value: "{{ certificate_chain }}" + description: | + The PEM encoded string containing the signing certificate chain + used to validate client certs. - name: certificate_chain_filename - value: string + value: "{{ certificate_chain_filename }}" + description: | + The name of the certificate file. - name: crl_url - value: string + value: "{{ crl_url }}" + description: | + The url from which to fetch the CRL for the certificate authority if crl_source is URL. - name: crl_chain - value: string + value: "{{ crl_chain }}" + description: | + The PEM encoded string containing the CRL for this certificate authority. + Defaults to this over \`crl_url\` if available. +`} + + + + + +## `REPLACE` examples + + + + +Make a request to update a certificate authority.

+```sql +REPLACE confluent.iam.certificate_authorities +SET +display_name = '{{ display_name }}', +description = '{{ description }}', +certificate_chain = '{{ certificate_chain }}', +certificate_chain_filename = '{{ certificate_chain_filename }}', +crl_url = '{{ crl_url }}', +crl_chain = '{{ crl_chain }}' +WHERE +id = '{{ id }}' --required +RETURNING +id, +display_name, +api_version, +certificate_chain_filename, +crl_source, +crl_updated_at, +crl_url, +description, +expiration_dates, +fingerprints, +kind, +metadata, +serial_numbers, +state; ``` -## `DELETE` example -Deletes the specified certificate_authorities resource. +## `DELETE` examples + + + + +Make a request to delete a certificate authority. ```sql -/*+ delete */ DELETE FROM confluent.iam.certificate_authorities -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/iam/certificate_identity_pools/index.md b/website/docs/services/iam/certificate_identity_pools/index.md index 5feee43..dc9d7dc 100644 --- a/website/docs/services/iam/certificate_identity_pools/index.md +++ b/website/docs/services/iam/certificate_identity_pools/index.md @@ -1,4 +1,4 @@ ---- +--- title: certificate_identity_pools hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,45 +23,291 @@ Creates, updates, deletes, gets or lists a certificate_identity_pools -Namecertificate_identity_pools +Name TypeResource Id ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | A description of how this `IdentityPool` is used | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | The name of the `IdentityPool`. | -| | `string` | The certificate field that will be used to represent the pool's external identifier for audit logging. | -| | `string` | A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) that specifies which identities can authenticate using your certificate identity pool (see [CEL filter for mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) for more details). | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `string` | Represents the federated identity associated with this pool. | -| | `string` | The current state of the identity pool | + +The following fields are returned by `SELECT` queries: + + + + +Certificate Identity Pool. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe name of the `IdentityPool`. (example: My Identity Pool)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringA description of how this `IdentityPool` is used (example: Prod Access to Kafka clusters to Release Engineering)
stringThe certificate field that will be used to represent the pool's external identifier for audit logging. (example: UID)
stringA filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) that specifies which identities can authenticate using your certificate identity pool (see [CEL filter for mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) for more details). (example: C=='Canada' && O=='Confluent')
stringKind defines the object this REST resource represents. (CertificateIdentityPool)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringRepresents the federated identity associated with this pool. (example: pool-abc)
stringThe current state of the identity pool (example: ENABLED)
+ + + +Certificate Identity Pool. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe name of the `IdentityPool`. (example: My Identity Pool)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringA description of how this `IdentityPool` is used (example: Prod Access to Kafka clusters to Release Engineering)
stringThe certificate field that will be used to represent the pool's external identifier for audit logging. (example: UID)
stringA filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) that specifies which identities can authenticate using your certificate identity pool (see [CEL filter for mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) for more details). (example: C=='Canada' && O=='Confluent')
stringKind defines the object this REST resource represents. (CertificateIdentityPool)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringRepresents the federated identity associated with this pool. (example: pool-abc)
stringThe current state of the identity pool (example: ENABLED)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a certificate identity pool. | -| | `SELECT` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all certificate identity pools. | -| | `INSERT` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a certificate identity pool. | -| | `DELETE` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a certificate identity pool. | -| | `EXEC` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a certificate identity pool. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
certificate_authority_id, idMake a request to read a certificate identity pool.
certificate_authority_idpage_size, page_tokenRetrieve a sorted, filtered, paginated list of all certificate identity pools.
certificate_authority_id, display_name, description, external_identifier, filterassigned_resource_ownerMake a request to create a certificate identity pool.
certificate_authority_id, idMake a request to update a certificate identity pool.

certificate_authority_id, idMake a request to delete a certificate identity pool.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Certificate Authority
stringThe unique identifier for the certificate identity pool.
stringThe resource_id of the principal who will be assigned resource owner on the created certificate identity pool. Principal can be group-mapping (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx). (example: u-a83k9b)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all certificate identity pools. + + +Make a request to read a certificate identity pool. ```sql SELECT id, -description, +display_name, api_version, +description, +external_identifier, +filter, +kind, +metadata, +principal, +state +FROM confluent.iam.certificate_identity_pools +WHERE certificate_authority_id = '{{ certificate_authority_id }}' -- required +AND id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all certificate identity pools. + +```sql +SELECT +id, display_name, +api_version, +description, external_identifier, filter, kind, @@ -68,68 +315,148 @@ metadata, principal, state FROM confluent.iam.certificate_identity_pools -WHERE certificate_authority_id = '{{ certificate_authority_id }}'; +WHERE certificate_authority_id = '{{ certificate_authority_id }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + + -Use the following StackQL query and manifest file to create a new certificate_identity_pools resource. +## `INSERT` examples - + { label: 'create_iam_v2_certificate_identity_pool', value: 'create_iam_v2_certificate_identity_pool' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a certificate identity pool. ```sql -/*+ create */ INSERT INTO confluent.iam.certificate_identity_pools ( -data__display_name, -data__description, -data__external_identifier, -data__filter, -certificate_authority_id +display_name, +description, +external_identifier, +filter, +certificate_authority_id, +assigned_resource_owner ) SELECT -'{{ display_name }}', -'{{ description }}', -'{{ external_identifier }}', -'{{ filter }}', -'{{ certificate_authority_id }}' +'{{ display_name }}' /* required */, +'{{ description }}' /* required */, +'{{ external_identifier }}' /* required */, +'{{ filter }}' /* required */, +'{{ certificate_authority_id }}', +'{{ assigned_resource_owner }}' +RETURNING +id, +display_name, +api_version, +description, +external_identifier, +filter, +kind, +metadata, +principal, +state ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: certificate_identity_pools props: - name: certificate_authority_id - value: string + value: "{{ certificate_authority_id }}" + description: Required parameter for the certificate_identity_pools resource. - name: display_name - value: string + value: "{{ display_name }}" + description: | + The name of the \`IdentityPool\`. - name: description - value: string + value: "{{ description }}" + description: | + A description of how this \`IdentityPool\` is used - name: external_identifier - value: string + value: "{{ external_identifier }}" + description: | + The certificate field that will be used to represent the + pool's external identifier for audit logging. - name: filter - value: string + value: "{{ filter }}" + description: | + A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) that specifies which identities can authenticate using your certificate identity pool (see [CEL filter for mTLS](https://docs.confluent.io/cloud/current/access-management/authenticate/mtls/cel-filters.html) for more details). + - name: assigned_resource_owner + value: "{{ assigned_resource_owner }}" + description: The resource_id of the principal who will be assigned resource owner on the created certificate identity pool. Principal can be group-mapping (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx). (example: u-a83k9b) + description: The resource_id of the principal who will be assigned resource owner on the created certificate identity pool. Principal can be group-mapping (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx). (example: u-a83k9b) +`} + + + + + +## `REPLACE` examples + + + +Make a request to update a certificate identity pool.

+ +```sql +REPLACE confluent.iam.certificate_identity_pools +SET +display_name = '{{ display_name }}', +description = '{{ description }}', +external_identifier = '{{ external_identifier }}', +filter = '{{ filter }}' +WHERE +certificate_authority_id = '{{ certificate_authority_id }}' --required +AND id = '{{ id }}' --required +RETURNING +id, +display_name, +api_version, +description, +external_identifier, +filter, +kind, +metadata, +principal, +state; ``` -## `DELETE` example -Deletes the specified certificate_identity_pools resource. +## `DELETE` examples + + + + +Make a request to delete a certificate identity pool. ```sql -/*+ delete */ DELETE FROM confluent.iam.certificate_identity_pools -WHERE certificate_authority_id = '{{ certificate_authority_id }}' -AND id = '{{ id }}'; +WHERE certificate_authority_id = '{{ certificate_authority_id }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/iam/group_mappings/index.md b/website/docs/services/iam/group_mappings/index.md index 9f3c9cc..f66edcb 100644 --- a/website/docs/services/iam/group_mappings/index.md +++ b/website/docs/services/iam/group_mappings/index.md @@ -1,4 +1,4 @@ ---- +--- title: group_mappings hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,118 +23,393 @@ Creates, updates, deletes, gets or lists a group_mappings resource. ## Overview - +
Namegroup_mappings
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | A description explaining the purpose and use of the group mapping. | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | The name of the group mapping. | -| | `string` | A single group identifier or a condition based on [supported CEL operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) that defines which groups are included. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `string` | The unique federated identity associated with this group mapping. | -| | `string` | The current state of the group mapping. | + +The following fields are returned by `SELECT` queries: + + + + +Group Mapping. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe name of the group mapping. (example: Application Developers)
stringAPIVersion defines the schema version of this representation of a resource. (iam.v2/sso)
stringA description explaining the purpose and use of the group mapping. (example: Admin access to production environment for Engineering)
stringA single group identifier or a condition based on [supported CEL operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) that defines which groups are included. (example: "kafka" in groups && "all" in groups || "everyone" in groups)
stringKind defines the object this REST resource represents. (GroupMapping)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe unique federated identity associated with this group mapping. (example: group-a1b2)
stringThe current state of the group mapping. (example: ENABLED)
+ + + +Group Mapping. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe name of the group mapping. (example: Application Developers)
stringAPIVersion defines the schema version of this representation of a resource. (iam.v2/sso)
stringA description explaining the purpose and use of the group mapping. (example: Admin access to production environment for Engineering)
stringA single group identifier or a condition based on [supported CEL operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) that defines which groups are included. (example: "kafka" in groups && "all" in groups || "everyone" in groups)
stringKind defines the object this REST resource represents. (GroupMapping)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe unique federated identity associated with this group mapping. (example: group-a1b2)
stringThe current state of the group mapping. (example: ENABLED)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a group mapping. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all group mappings. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a group mapping. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a group mapping. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a group mapping. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a group mapping.
page_size, page_tokenRetrieve a sorted, filtered, paginated list of all group mappings.
display_name, description, filterMake a request to create a group mapping.
idMake a request to update a group mapping.

idMake a request to delete a group mapping.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the group mapping.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all group mappings. + + +Make a request to read a group mapping. ```sql SELECT id, -description, +display_name, api_version, +description, +filter, +kind, +metadata, +principal, +state +FROM confluent.iam.group_mappings +WHERE id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all group mappings. + +```sql +SELECT +id, display_name, +api_version, +description, filter, kind, metadata, principal, state FROM confluent.iam.group_mappings +WHERE page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` -## `INSERT` example + + + -Use the following StackQL query and manifest file to create a new group_mappings resource. +## `INSERT` examples - + { label: 'create_iam_v2_sso_group_mapping', value: 'create_iam_v2_sso_group_mapping' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a group mapping. ```sql -/*+ create */ INSERT INTO confluent.iam.group_mappings ( -data__display_name, -data__description, -data__filter +display_name, +description, +filter ) SELECT -'{{ display_name }}', -'{{ description }}', -'{{ filter }}' +'{{ display_name }}' /* required */, +'{{ description }}' /* required */, +'{{ filter }}' /* required */ +RETURNING +id, +display_name, +api_version, +description, +filter, +kind, +metadata, +principal, +state ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: group_mappings props: - name: display_name - value: string + value: "{{ display_name }}" + description: | + The name of the group mapping. - name: description - value: string + value: "{{ description }}" + description: | + A description explaining the purpose and use of the group mapping. - name: filter - value: string + value: "{{ filter }}" + description: | + A single group identifier or a condition based on [supported CEL operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) that defines which groups are included. +`} -``` -## `UPDATE` example -Updates a group_mappings resource. +## `UPDATE` examples + + + + +Make a request to update a group mapping.

```sql -/*+ update */ UPDATE confluent.iam.group_mappings SET display_name = '{{ display_name }}', description = '{{ description }}', filter = '{{ filter }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +RETURNING +id, +display_name, +api_version, +description, +filter, +kind, +metadata, +principal, +state; ``` + + + -## `DELETE` example +## `DELETE` examples -Deletes the specified group_mappings resource. + + + +Make a request to delete a group mapping. ```sql -/*+ delete */ DELETE FROM confluent.iam.group_mappings -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/iam/identity_pools/index.md b/website/docs/services/iam/identity_pools/index.md index 6af0ea0..c206967 100644 --- a/website/docs/services/iam/identity_pools/index.md +++ b/website/docs/services/iam/identity_pools/index.md @@ -1,4 +1,4 @@ ---- +--- title: identity_pools hide_title: false hide_table_of_contents: false @@ -15,52 +15,299 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a identity_pools resource. +Creates, updates, deletes, gets or lists an identity_pools resource. ## Overview - +
Nameidentity_pools
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | A description of how this `IdentityPool` is used | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | The name of the `IdentityPool`. | -| | `string` | A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) that specifies which identities can authenticate using your identity pool (see [Set identity pool filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) for more details). | -| | `string` | The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from (see [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) for more details). This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access topic A". | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `string` | Represents the federated identity associated with this pool. | -| | `string` | The current state of the identity pool | + +The following fields are returned by `SELECT` queries: + + + + +Identity Pool. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe name of the `IdentityPool`. (example: My Identity Pool)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringA description of how this `IdentityPool` is used (example: Prod Access to Kafka clusters to Release Engineering)
stringA filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) that specifies which identities can authenticate using your identity pool (see [Set identity pool filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) for more details). (example: claims.aud=="confluent" && claims.group!="invalid_group")
stringThe JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from (see [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) for more details). This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access topic A". (example: claims.sub)
stringKind defines the object this REST resource represents. (IdentityPool)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringRepresents the federated identity associated with this pool. (example: pool-abc)
stringThe current state of the identity pool (example: ENABLED)
+ + + +Identity Pool. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe name of the `IdentityPool`. (example: My Identity Pool)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringA description of how this `IdentityPool` is used (example: Prod Access to Kafka clusters to Release Engineering)
stringA filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) that specifies which identities can authenticate using your identity pool (see [Set identity pool filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) for more details). (example: claims.aud=="confluent" && claims.group!="invalid_group")
stringThe JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from (see [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) for more details). This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access topic A". (example: claims.sub)
stringKind defines the object this REST resource represents. (IdentityPool)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringRepresents the federated identity associated with this pool. (example: pool-abc)
stringThe current state of the identity pool (example: ENABLED)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read an identity pool. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all identity pools. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create an identity pool. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete an identity pool. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update an identity pool. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
provider_id, idMake a request to read an identity pool.
provider_idpage_size, page_tokenRetrieve a sorted, filtered, paginated list of all identity pools.
provider_id, display_name, description, identity_claim, filterassigned_resource_ownerMake a request to create an identity pool.
provider_id, idMake a request to update an identity pool.

provider_id, idMake a request to delete an identity pool.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the identity pool.
stringThe Provider
stringThe resource_id of the principal who will be assigned resource owner on the created identity pool. Principal can be group-mapping (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx). (example: u-a83k9b)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all identity pools. + + +Make a request to read an identity pool. ```sql SELECT id, -description, +display_name, api_version, +description, +filter, +identity_claim, +kind, +metadata, +principal, +state +FROM confluent.iam.identity_pools +WHERE provider_id = '{{ provider_id }}' -- required +AND id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all identity pools. + +```sql +SELECT +id, display_name, +api_version, +description, filter, identity_claim, kind, @@ -68,67 +315,108 @@ metadata, principal, state FROM confluent.iam.identity_pools -WHERE provider_id = '{{ provider_id }}'; +WHERE provider_id = '{{ provider_id }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + + -Use the following StackQL query and manifest file to create a new identity_pools resource. +## `INSERT` examples - + { label: 'create_iam_v2_identity_pool', value: 'create_iam_v2_identity_pool' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create an identity pool. ```sql -/*+ create */ INSERT INTO confluent.iam.identity_pools ( -data__display_name, -data__description, -data__identity_claim, -data__filter, -provider_id +display_name, +description, +identity_claim, +filter, +provider_id, +assigned_resource_owner ) SELECT -'{{ display_name }}', -'{{ description }}', -'{{ identity_claim }}', -'{{ filter }}', -'{{ provider_id }}' +'{{ display_name }}' /* required */, +'{{ description }}' /* required */, +'{{ identity_claim }}' /* required */, +'{{ filter }}' /* required */, +'{{ provider_id }}', +'{{ assigned_resource_owner }}' +RETURNING +id, +display_name, +api_version, +description, +filter, +identity_claim, +kind, +metadata, +principal, +state ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: identity_pools props: - name: provider_id - value: string + value: "{{ provider_id }}" + description: Required parameter for the identity_pools resource. - name: display_name - value: string + value: "{{ display_name }}" + description: | + The name of the \`IdentityPool\`. - name: description - value: string + value: "{{ description }}" + description: | + A description of how this \`IdentityPool\` is used - name: identity_claim - value: string + value: "{{ identity_claim }}" + description: | + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + (see [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1) for more details). + This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access + topic A". - name: filter - value: string + value: "{{ filter }}" + description: | + A filter expression in [Supported Common Expression Language (CEL)](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#supported-common-expression-language-cel-filters) that specifies which identities can authenticate using your identity pool (see [Set identity pool filters](https://docs.confluent.io/cloud/current/access-management/authenticate/oauth/identity-pools.html#set-identity-pool-filters) for more details). + - name: assigned_resource_owner + value: "{{ assigned_resource_owner }}" + description: The resource_id of the principal who will be assigned resource owner on the created identity pool. Principal can be group-mapping (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx). (example: u-a83k9b) + description: The resource_id of the principal who will be assigned resource owner on the created identity pool. Principal can be group-mapping (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx). (example: u-a83k9b) +`} -``` -## `UPDATE` example -Updates a identity_pools resource. +## `UPDATE` examples + + + + +Make a request to update an identity pool.

```sql -/*+ update */ UPDATE confluent.iam.identity_pools SET display_name = '{{ display_name }}', @@ -136,17 +424,41 @@ description = '{{ description }}', identity_claim = '{{ identity_claim }}', filter = '{{ filter }}' WHERE -id = '{{ id }}' -AND provider_id = '{{ provider_id }}'; +provider_id = '{{ provider_id }}' --required +AND id = '{{ id }}' --required +RETURNING +id, +display_name, +api_version, +description, +filter, +identity_claim, +kind, +metadata, +principal, +state; ``` + + + + +## `DELETE` examples -## `DELETE` example + + -Deletes the specified identity_pools resource. +Make a request to delete an identity pool. ```sql -/*+ delete */ DELETE FROM confluent.iam.identity_pools -WHERE id = '{{ id }}' -AND provider_id = '{{ provider_id }}'; +WHERE provider_id = '{{ provider_id }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/iam/identity_providers/index.md b/website/docs/services/iam/identity_providers/index.md index c21926c..fe9fb67 100644 --- a/website/docs/services/iam/identity_providers/index.md +++ b/website/docs/services/iam/identity_providers/index.md @@ -1,4 +1,4 @@ ---- +--- title: identity_providers hide_title: false hide_table_of_contents: false @@ -15,52 +15,312 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a identity_providers resource. +Creates, updates, deletes, gets or lists an identity_providers resource. ## Overview - +
Nameidentity_providers
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | A description of the identity provider. | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | The human-readable name of the OAuth identity provider. | -| | `string` | A publicly accessible URL uniquely identifying the OAuth identity provider authorized to issue access tokens. | -| | `string` | A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth identity provider. JWKS provides a set of crypotgraphic keys used to verify the authenticity and integrity of JSON Web Tokens (JWTs) issued by the OAuth identity provider. | -| | `array` | The JWKS issued by the OAuth identity provider. Only `kid` (key ID) and `alg` (algorithm) properties for each key set are included. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `string` | The current state of the identity provider. | + +The following fields are returned by `SELECT` queries: + + + + +Identity Provider. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe human-readable name of the OAuth identity provider. (example: My OIDC Provider)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringA description of the identity provider.
stringThe JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). This appears in audit log records. Note: if the client specifies mapping to one identity pool ID, the identity claim configured with that pool will be used instead. Note - The attribute is in an [Early Access lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) (example: claims.sub)
string (uri)A publicly accessible URL uniquely identifying the OAuth identity provider authorized to issue access tokens. (example: https://login.microsoftonline.com/{tenantid}/v2.0)
string (uri)A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth identity provider. JWKS provides a set of crypotgraphic keys used to verify the authenticity and integrity of JSON Web Tokens (JWTs) issued by the OAuth identity provider. (example: https://login.microsoftonline.com/common/discovery/v2.0/keys)
arrayThe JWKS issued by the OAuth identity provider. Only `kid` (key ID) and `alg` (algorithm) properties for each key set are included.
stringKind defines the object this REST resource represents. (IdentityProvider)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe current state of the identity provider. (example: ENABLED)
+ + + +Identity Provider. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe human-readable name of the OAuth identity provider. (example: My OIDC Provider)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringA description of the identity provider.
stringThe JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). This appears in audit log records. Note: if the client specifies mapping to one identity pool ID, the identity claim configured with that pool will be used instead. Note - The attribute is in an [Early Access lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) (example: claims.sub)
string (uri)A publicly accessible URL uniquely identifying the OAuth identity provider authorized to issue access tokens. (example: https://login.microsoftonline.com/{tenantid}/v2.0)
string (uri)A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth identity provider. JWKS provides a set of crypotgraphic keys used to verify the authenticity and integrity of JSON Web Tokens (JWTs) issued by the OAuth identity provider. (example: https://login.microsoftonline.com/common/discovery/v2.0/keys)
arrayThe JWKS issued by the OAuth identity provider. Only `kid` (key ID) and `alg` (algorithm) properties for each key set are included.
stringKind defines the object this REST resource represents. (IdentityProvider)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe current state of the identity provider. (example: ENABLED)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read an identity provider. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all identity providers. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create an identity provider. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete an identity provider. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update an identity provider. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read an identity provider.
page_size, page_tokenRetrieve a sorted, filtered, paginated list of all identity providers.
display_name, description, issuer, jwks_uriMake a request to create an identity provider.
idMake a request to update an identity provider.

idMake a request to delete an identity provider.
provider_idMake a request to refresh the provider's JWKS

+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the identity provider.
stringThe Provider
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all identity providers. + + +Make a request to read an identity provider. ```sql SELECT id, -description, +display_name, api_version, +description, +identity_claim, +issuer, +jwks_uri, +keys, +kind, +metadata, +state +FROM confluent.iam.identity_providers +WHERE id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all identity providers. + +```sql +SELECT +id, display_name, +api_version, +description, +identity_claim, issuer, jwks_uri, keys, @@ -68,79 +328,176 @@ kind, metadata, state FROM confluent.iam.identity_providers +WHERE page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new identity_providers resource. + +## `INSERT` examples - + { label: 'create_iam_v2_identity_provider', value: 'create_iam_v2_identity_provider' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create an identity provider. ```sql -/*+ create */ INSERT INTO confluent.iam.identity_providers ( -data__display_name, -data__description, -data__issuer, -data__jwks_uri +display_name, +description, +identity_claim, +issuer, +jwks_uri ) SELECT -'{{ display_name }}', -'{{ description }}', -'{{ issuer }}', -'{{ jwks_uri }}' +'{{ display_name }}' /* required */, +'{{ description }}' /* required */, +'{{ identity_claim }}', +'{{ issuer }}' /* required */, +'{{ jwks_uri }}' /* required */ +RETURNING +id, +display_name, +api_version, +description, +identity_claim, +issuer, +jwks_uri, +keys, +kind, +metadata, +state ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: identity_providers props: - name: display_name - value: string + value: "{{ display_name }}" + description: | + The human-readable name of the OAuth identity provider. - name: description - value: string + value: "{{ description }}" + description: | + A description of the identity provider. + - name: identity_claim + value: "{{ identity_claim }}" + description: | + The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from + [Registered Claim Names](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1). This appears + in audit log records. Note: if the client specifies mapping to one identity pool ID, the identity + claim configured with that pool will be used instead. + Note - The attribute is in an [Early Access lifecycle stage] + (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy) - name: issuer - value: string + value: "{{ issuer }}" + description: | + A publicly accessible URL uniquely identifying the OAuth + identity provider authorized to issue access tokens. - name: jwks_uri - value: string + value: "{{ jwks_uri }}" + description: | + A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth + identity provider. JWKS provides a set of crypotgraphic keys + used to verify the authenticity and integrity of JSON Web + Tokens (JWTs) issued by the OAuth identity provider. +`} -``` -## `UPDATE` example -Updates a identity_providers resource. +## `UPDATE` examples + + + + +Make a request to update an identity provider.

```sql -/*+ update */ UPDATE confluent.iam.identity_providers SET display_name = '{{ display_name }}', description = '{{ description }}', +identity_claim = '{{ identity_claim }}', issuer = '{{ issuer }}', jwks_uri = '{{ jwks_uri }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +RETURNING +id, +display_name, +api_version, +description, +identity_claim, +issuer, +jwks_uri, +keys, +kind, +metadata, +state; ``` + + + + +## `DELETE` examples -## `DELETE` example + + -Deletes the specified identity_providers resource. +Make a request to delete an identity provider. ```sql -/*+ delete */ DELETE FROM confluent.iam.identity_providers -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; ``` + + + + +## Lifecycle Methods + + + + +Make a request to refresh the provider's JWKS

+ +```sql +EXEC confluent.iam.identity_providers.refresh_iam_v2_json_web_key_set +@provider_id='{{ provider_id }}' --required +@@json= +'{ +"spec": "{{ spec }}" +}' +; +``` + + diff --git a/website/docs/services/iam/index.md b/website/docs/services/iam/index.md index d6376ef..716ff8e 100644 --- a/website/docs/services/iam/index.md +++ b/website/docs/services/iam/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png iam service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 13
-
-
+total resources: __13__ ::: @@ -38,9 +34,9 @@ iam service documentation. invitations
+ip_filter_summaries
ip_filters
ip_groups
-jwks
role_bindings
service_accounts
users diff --git a/website/docs/services/iam/invitations/index.md b/website/docs/services/iam/invitations/index.md index 49c9755..9725abc 100644 --- a/website/docs/services/iam/invitations/index.md +++ b/website/docs/services/iam/invitations/index.md @@ -1,4 +1,4 @@ ---- +--- title: invitations hide_title: false hide_table_of_contents: false @@ -15,45 +15,283 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a invitations resource. +Creates, updates, deletes, gets or lists an invitations resource. ## Overview - +
Nameinvitations
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | The timestamp that the invitation was accepted | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | The user/invitee's authentication type. Note that only the [OrganizationAdmin role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default. | -| | `object` | The invitation creator | -| | `string` | The user/invitee's email address | -| | `string` | The timestamp that the invitation will expire | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `string` | The status of invitations | -| | `object` | The user/invitee | + +The following fields are returned by `SELECT` queries: + + + + +Invitation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
string (date-time)The timestamp that the invitation was accepted (example: 2022-07-06T17:21:33.000Z)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringThe user/invitee's authentication type. Note that only the [OrganizationAdmin role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default. (example: AUTH_TYPE_SSO)
objectThe invitation creator
string (email)The user/invitee's email address (example: johndoe@confluent.io)
string (date-time)The timestamp that the invitation will expire (example: 2022-07-07T17:22:39.000Z)
stringKind defines the object this REST resource represents. (Invitation)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe status of invitations (example: INVITE_STATUS_SENT)
objectThe user/invitee
+ + + +Invitation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
string (date-time)The timestamp that the invitation was accepted (example: 2022-07-06T17:21:33.000Z)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringThe user/invitee's authentication type. Note that only the [OrganizationAdmin role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default. (example: AUTH_TYPE_SSO)
objectThe invitation creator
string (email)The user/invitee's email address (example: johndoe@confluent.io)
string (date-time)The timestamp that the invitation will expire (example: 2022-07-07T17:22:39.000Z)
stringKind defines the object this REST resource represents. (Invitation)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe status of invitations (example: INVITE_STATUS_SENT)
objectThe user/invitee
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read an invitation. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all invitations. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create an invitation. The newly invited user will not have any permissions. Give the user permission by assigning them to one or more roles by creating [role bindings](https://docs.confluent.io/cloud/current/api.html#tag/Role-Bindings-(iamv2)) for the created `user`. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete an invitation. Delete will deactivate the user if the user didn't accept the invitation yet. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read an invitation.
email, status, user, creator, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all invitations.
emailMake a request to create an invitation.

The newly invited user will not have any permissions. Give the user permission by assigning them to one or
more roles by creating
[role bindings](https://docs.confluent.io/cloud/current/api.html#tag/Role-Bindings-(iamv2))
for the created `user`.
idMake a request to delete an invitation.

Delete will deactivate the user if the user didn't accept the invitation yet.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the invitation.
stringFilter the results by exact match for creator. (example: u-m2r9o7)
stringFilter the results by exact match for email. (example: johndoe@confluent.io)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for status. (example: INVITE_STATUS_SENT)
stringFilter the results by exact match for user. (example: u-j93dy8)
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all invitations. + + +Make a request to read an invitation. ```sql SELECT @@ -69,80 +307,114 @@ metadata, status, user FROM confluent.iam.invitations +WHERE id = '{{ id }}' -- required ; ``` -## `INSERT` example - -Use the following StackQL query and manifest file to create a new invitations resource. + + - - +Retrieve a sorted, filtered, paginated list of all invitations. ```sql -/*+ create */ -INSERT INTO confluent.iam.invitations ( -data__email, -data__auth_type, -data__user, -data__creator -) -SELECT -'{{ email }}', -'{{ auth_type }}', -'{{ user }}', -'{{ creator }}' +SELECT +id, +accepted_at, +api_version, +auth_type, +creator, +email, +expires_at, +kind, +metadata, +status, +user +FROM confluent.iam.invitations +WHERE email = '{{ email }}' +AND status = '{{ status }}' +AND user = '{{ user }}' +AND creator = '{{ creator }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` + - + +## `INSERT` examples + + + + +Make a request to create an invitation.

The newly invited user will not have any permissions. Give the user permission by assigning them to one or
more roles by creating
[role bindings](https://docs.confluent.io/cloud/current/api.html#tag/Role-Bindings-(iamv2))
for the created `user`.
```sql -/*+ create */ INSERT INTO confluent.iam.invitations ( -data__email +email, +auth_type ) SELECT -'{{ email }}' +'{{ email }}' /* required */, +'{{ auth_type }}' +RETURNING +id, +accepted_at, +api_version, +auth_type, +creator, +email, +expires_at, +kind, +metadata, +status, +user ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: invitations props: - name: email - value: string + value: "{{ email }}" + description: | + The user/invitee's email address - name: auth_type - value: string - - name: user - props: - - name: id - value: string - - name: creator - props: - - name: id - value: string + value: "{{ auth_type }}" + description: | + The user/invitee's authentication type. Note that only the [OrganizationAdmin role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin) + can invite AUTH_TYPE_LOCAL users to SSO organizations. + The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. + Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default. +`} -``` -## `DELETE` example -Deletes the specified invitations resource. +## `DELETE` examples + + + + +Make a request to delete an invitation.

Delete will deactivate the user if the user didn't accept the invitation yet.
```sql -/*+ delete */ DELETE FROM confluent.iam.invitations -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/iam/ip_filter_summaries/index.md b/website/docs/services/iam/ip_filter_summaries/index.md new file mode 100644 index 0000000..b13195a --- /dev/null +++ b/website/docs/services/iam/ip_filter_summaries/index.md @@ -0,0 +1,148 @@ +--- +title: ip_filter_summaries +hide_title: false +hide_table_of_contents: false +keywords: + - ip_filter_summaries + - iam + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an ip_filter_summaries resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +IP Filter Summary. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
arraySummary of the operation groups and IP filters created in those operation groups.
stringKind defines the object this REST resource represents. (IpFilterSummary)
stringThe scope associated with this object.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
scopeMake a request to read an IP filter summary.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given scope. (example: crn://confluent.cloud/organization=org-123/environment=env-abc)
+ +## `SELECT` examples + + + + +Make a request to read an IP filter summary. + +```sql +SELECT +api_version, +categories, +kind, +scope +FROM confluent.iam.ip_filter_summaries +WHERE scope = '{{ scope }}' -- required +; +``` + + diff --git a/website/docs/services/iam/ip_filters/index.md b/website/docs/services/iam/ip_filters/index.md index f8edfc7..e905b9e 100644 --- a/website/docs/services/iam/ip_filters/index.md +++ b/website/docs/services/iam/ip_filters/index.md @@ -1,4 +1,4 @@ ---- +--- title: ip_filters hide_title: false hide_table_of_contents: false @@ -15,124 +15,438 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a ip_filters resource. +Creates, updates, deletes, gets or lists an ip_filters resource. ## Overview - +
Nameip_filters
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | A human readable name for an IP Filter. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: `[`, `]`, `\|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. | -| | `array` | A list of IP Groups. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `string` | Scope of resources covered by this IP filter. The only resource_group currently available is "management". | + +The following fields are returned by `SELECT` queries: + + + + +IP Filter. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringA human readable name for an IP Filter. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. (example: Management API Rules)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
arrayA list of IP Groups.
stringKind defines the object this REST resource represents. (IpFilter)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
arrayScope of resources covered by this IP filter. Resource group must be set to 'multiple' in order to use this property.During update operations, note that the operation groups passed in will replace the list of existing operation groups (passing in an empty list will remove all operation groups) from the filter (in line with the behavior for ip_groups).
stringScope of resources covered by this IP filter. Available resource groups include "management" and "multiple". (example: management)
string (uri)A CRN that specifies the scope of the ip filter, specifically the organization or environment. Without specifying this property, the ip filter would apply to the whole organization. (example: crn://confluent.cloud/organization=org-123/environment=env-abc, pattern: ^crn://.+$)
+ + + +IP Filter. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringA human readable name for an IP Filter. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. (example: Management API Rules)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
arrayA list of IP Groups.
stringKind defines the object this REST resource represents. (IpFilter)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
arrayScope of resources covered by this IP filter. Resource group must be set to 'multiple' in order to use this property.During update operations, note that the operation groups passed in will replace the list of existing operation groups (passing in an empty list will remove all operation groups) from the filter (in line with the behavior for ip_groups).
stringScope of resources covered by this IP filter. Available resource groups include "management" and "multiple". (example: management)
string (uri)A CRN that specifies the scope of the ip filter, specifically the organization or environment. Without specifying this property, the ip filter would apply to the whole organization. (example: crn://confluent.cloud/organization=org-123/environment=env-abc, pattern: ^crn://.+$)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To IP Filters API](https://img.shields.io/badge/-Request%20Access%20To%20IP%20Filters%20API-%23bc8540)](mailto:ccloud-api-access+iam-v2-limited-availability@confluent.io?subject=Request%20to%20join%20iam/v2%20API%20Limited%20Availability&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Limited%20Availability%20for%20iam/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Make a request to read an IP filter. | -| | `SELECT` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To IP Filters API](https://img.shields.io/badge/-Request%20Access%20To%20IP%20Filters%20API-%23bc8540)](mailto:ccloud-api-access+iam-v2-limited-availability@confluent.io?subject=Request%20to%20join%20iam/v2%20API%20Limited%20Availability&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Limited%20Availability%20for%20iam/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Retrieve a sorted, filtered, paginated list of all IP filters. | -| | `INSERT` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To IP Filters API](https://img.shields.io/badge/-Request%20Access%20To%20IP%20Filters%20API-%23bc8540)](mailto:ccloud-api-access+iam-v2-limited-availability@confluent.io?subject=Request%20to%20join%20iam/v2%20API%20Limited%20Availability&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Limited%20Availability%20for%20iam/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Make a request to create an IP filter. | -| | `DELETE` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To IP Filters API](https://img.shields.io/badge/-Request%20Access%20To%20IP%20Filters%20API-%23bc8540)](mailto:ccloud-api-access+iam-v2-limited-availability@confluent.io?subject=Request%20to%20join%20iam/v2%20API%20Limited%20Availability&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Limited%20Availability%20for%20iam/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Make a request to delete an IP filter. | -| | `UPDATE` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To IP Filters API](https://img.shields.io/badge/-Request%20Access%20To%20IP%20Filters%20API-%23bc8540)](mailto:ccloud-api-access+iam-v2-limited-availability@confluent.io?subject=Request%20to%20join%20iam/v2%20API%20Limited%20Availability&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Limited%20Availability%20for%20iam/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Make a request to update an IP filter. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read an IP filter.
resource_scope, include_parent_scopes, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all IP filters.
filter_name, resource_group, ip_groupsMake a request to create an IP filter.
idMake a request to update an IP filter.

idMake a request to delete an IP filter.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the IP filter.
stringIf set to true, this includes filters defined at the organization level. The resource scope must also be set to use this parameter.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringLists all filters belonging to the specified resource scope.
## `SELECT` examples -[![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To IP Filters API](https://img.shields.io/badge/-Request%20Access%20To%20IP%20Filters%20API-%23bc8540)](mailto:ccloud-api-access+iam-v2-limited-availability@confluent.io?subject=Request%20to%20join%20iam/v2%20API%20Limited%20Availability&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Limited%20Availability%20for%20iam/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Retrieve a sorted, filtered, paginated list of all IP filters. + + +Make a request to read an IP filter. ```sql SELECT id, +filter_name, api_version, +ip_groups, +kind, +metadata, +operation_groups, +resource_group, +resource_scope +FROM confluent.iam.ip_filters +WHERE id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all IP filters. + +```sql +SELECT +id, filter_name, +api_version, ip_groups, kind, metadata, -resource_group +operation_groups, +resource_group, +resource_scope FROM confluent.iam.ip_filters +WHERE resource_scope = '{{ resource_scope }}' +AND include_parent_scopes = '{{ include_parent_scopes }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new ip_filters resource. + +## `INSERT` examples - + { label: 'create_iam_v2_ip_filter', value: 'create_iam_v2_ip_filter' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create an IP filter. ```sql -/*+ create */ INSERT INTO confluent.iam.ip_filters ( -data__filter_name, -data__resource_group, -data__ip_groups +filter_name, +resource_group, +resource_scope, +operation_groups, +ip_groups ) SELECT -'{{ filter_name }}', -'{{ resource_group }}', -'{{ ip_groups }}' +'{{ filter_name }}' /* required */, +'{{ resource_group }}' /* required */, +'{{ resource_scope }}', +'{{ operation_groups }}', +'{{ ip_groups }}' /* required */ +RETURNING +id, +filter_name, +api_version, +ip_groups, +kind, +metadata, +operation_groups, +resource_group, +resource_scope ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: ip_filters props: - name: filter_name - value: string + value: "{{ filter_name }}" + description: | + A human readable name for an IP Filter. Can contain any unicode letter or number, the ASCII space character, + or any of the following special characters: \`[\`, \`]\`, \`|\`, \`&\`, \`+\`, \`-\`, \`_\`, \`/\`, \`.\`, \`,\`. - name: resource_group - value: string + value: "{{ resource_group }}" + description: | + Scope of resources covered by this IP filter. Available resource groups include "management" and "multiple". + - name: resource_scope + value: "{{ resource_scope }}" + description: | + A CRN that specifies the scope of the ip filter, specifically the organization + or environment. Without specifying this property, the ip filter + would apply to the whole organization. + - name: operation_groups + value: + - "{{ operation_groups }}" + description: | + Scope of resources covered by this IP filter. Resource group must be set to 'multiple' + in order to use this property.During update operations, note that the operation + groups passed in will replace the list of existing operation groups + (passing in an empty list will remove all operation groups) from the filter + (in line with the behavior for ip_groups). - name: ip_groups - value: array - props: - - name: id - value: string + description: | + A list of IP Groups. + value: + - id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} -``` -## `UPDATE` example -Updates a ip_filters resource. +## `UPDATE` examples + + + + +Make a request to update an IP filter.

```sql -/*+ update */ UPDATE confluent.iam.ip_filters SET filter_name = '{{ filter_name }}', resource_group = '{{ resource_group }}', +resource_scope = '{{ resource_scope }}', +operation_groups = '{{ operation_groups }}', ip_groups = '{{ ip_groups }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +RETURNING +id, +filter_name, +api_version, +ip_groups, +kind, +metadata, +operation_groups, +resource_group, +resource_scope; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified ip_filters resource. +Make a request to delete an IP filter. ```sql -/*+ delete */ DELETE FROM confluent.iam.ip_filters -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/iam/ip_groups/index.md b/website/docs/services/iam/ip_groups/index.md index b790013..97d41e0 100644 --- a/website/docs/services/iam/ip_groups/index.md +++ b/website/docs/services/iam/ip_groups/index.md @@ -1,4 +1,4 @@ ---- +--- title: ip_groups hide_title: false hide_table_of_contents: false @@ -15,114 +15,354 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a ip_groups resource. +Creates, updates, deletes, gets or lists an ip_groups resource. ## Overview - +
Nameip_groups
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `array` | A list of CIDRs. | -| | `string` | A human readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: `[`, `]`, `\|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | + +The following fields are returned by `SELECT` queries: + + + + +IP Group. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringA human readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. (example: CorpNet)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
arrayA list of CIDRs.
stringKind defines the object this REST resource represents. (IpGroup)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+ + + +IP Group. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringA human readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`. (example: CorpNet)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
arrayA list of CIDRs.
stringKind defines the object this REST resource represents. (IpGroup)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To IP Groups API](https://img.shields.io/badge/-Request%20Access%20To%20IP%20Groups%20API-%23bc8540)](mailto:cloud-support@confluent.io?subject=Request%20to%20join%20IP%20Filtering%20API%20Limited%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Limited%20Access%20for%20IP%20Filtering.%0AMy%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.%0A) Make a request to read an IP group. | -| | `SELECT` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To IP Groups API](https://img.shields.io/badge/-Request%20Access%20To%20IP%20Groups%20API-%23bc8540)](mailto:cloud-support@confluent.io?subject=Request%20to%20join%20IP%20Filtering%20API%20Limited%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Limited%20Access%20for%20IP%20Filtering.%0AMy%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.%0A) Retrieve a sorted, filtered, paginated list of all IP groups. | -| | `INSERT` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To IP Groups API](https://img.shields.io/badge/-Request%20Access%20To%20IP%20Groups%20API-%23bc8540)](mailto:cloud-support@confluent.io?subject=Request%20to%20join%20IP%20Filtering%20API%20Limited%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Limited%20Access%20for%20IP%20Filtering.%0AMy%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.%0A) Make a request to create an IP group. | -| | `DELETE` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To IP Groups API](https://img.shields.io/badge/-Request%20Access%20To%20IP%20Groups%20API-%23bc8540)](mailto:cloud-support@confluent.io?subject=Request%20to%20join%20IP%20Filtering%20API%20Limited%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Limited%20Access%20for%20IP%20Filtering.%0AMy%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.%0A) Make a request to delete an IP group. | -| | `UPDATE` | | [![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To IP Groups API](https://img.shields.io/badge/-Request%20Access%20To%20IP%20Groups%20API-%23bc8540)](mailto:cloud-support@confluent.io?subject=Request%20to%20join%20IP%20Filtering%20API%20Limited%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Limited%20Access%20for%20IP%20Filtering.%0AMy%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.%0A) Make a request to update an IP group. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read an IP group.
page_size, page_tokenRetrieve a sorted, filtered, paginated list of all IP groups.
group_name, cidr_blocksMake a request to create an IP group.
idMake a request to update an IP group.

idMake a request to delete an IP group.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the IP group.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To IP Groups API](https://img.shields.io/badge/-Request%20Access%20To%20IP%20Groups%20API-%23bc8540)](mailto:cloud-support@confluent.io?subject=Request%20to%20join%20IP%20Filtering%20API%20Limited%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Limited%20Access%20for%20IP%20Filtering.%0AMy%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.%0A) Retrieve a sorted, filtered, paginated list of all IP groups. + + +Make a request to read an IP group. ```sql SELECT id, +group_name, api_version, cidr_blocks, +kind, +metadata +FROM confluent.iam.ip_groups +WHERE id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all IP groups. + +```sql +SELECT +id, group_name, +api_version, +cidr_blocks, kind, metadata FROM confluent.iam.ip_groups +WHERE page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` -## `INSERT` example + + + -Use the following StackQL query and manifest file to create a new ip_groups resource. +## `INSERT` examples - + { label: 'create_iam_v2_ip_group', value: 'create_iam_v2_ip_group' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create an IP group. ```sql -/*+ create */ INSERT INTO confluent.iam.ip_groups ( -data__group_name, -data__cidr_blocks +group_name, +cidr_blocks ) SELECT -'{{ group_name }}', -'{{ cidr_blocks }}' +'{{ group_name }}' /* required */, +'{{ cidr_blocks }}' /* required */ +RETURNING +id, +group_name, +api_version, +cidr_blocks, +kind, +metadata ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: ip_groups props: - name: group_name - value: string + value: "{{ group_name }}" + description: | + A human readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or + any of the following special characters: \`[\`, \`]\`, \`|\`, \`&\`, \`+\`, \`-\`, \`_\`, \`/\`, \`.\`, \`,\`. - name: cidr_blocks - value: array + value: + - "{{ cidr_blocks }}" + description: | + A list of CIDRs. +`} -``` -## `UPDATE` example -Updates a ip_groups resource. +## `UPDATE` examples + + + + +Make a request to update an IP group.

```sql -/*+ update */ UPDATE confluent.iam.ip_groups SET group_name = '{{ group_name }}', cidr_blocks = '{{ cidr_blocks }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +RETURNING +id, +group_name, +api_version, +cidr_blocks, +kind, +metadata; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified ip_groups resource. +Make a request to delete an IP group. ```sql -/*+ delete */ DELETE FROM confluent.iam.ip_groups -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/iam/jwks/index.md b/website/docs/services/iam/jwks/index.md deleted file mode 100644 index 16fe76a..0000000 --- a/website/docs/services/iam/jwks/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: jwks -hide_title: false -hide_table_of_contents: false -keywords: - - jwks - - iam - - confluent - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage confluent resources using SQL -custom_edit_url: null -image: /img/stackql-confluent-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a jwks resource. - -## Overview - - - - -
Namejwks
TypeResource
Id
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to refresh the provider's JWKS | diff --git a/website/docs/services/iam/role_bindings/index.md b/website/docs/services/iam/role_bindings/index.md index a328329..8221940 100644 --- a/website/docs/services/iam/role_bindings/index.md +++ b/website/docs/services/iam/role_bindings/index.md @@ -1,4 +1,4 @@ ---- +--- title: role_bindings hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,98 +23,343 @@ Creates, updates, deletes, gets or lists a role_bindings resource. ## Overview - +
Namerole_bindings
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | A CRN that specifies the scope and resource patterns necessary for the role to bind | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `string` | The principal User to bind the role to | -| | `string` | The name of the role to bind to the principal | + +The following fields are returned by `SELECT` queries: + + + + +Role Binding. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe name of the role to bind to the principal (example: CloudClusterAdmin)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
string (uri)A CRN that specifies the scope and resource patterns necessary for the role to bind (pattern: ^crn://.+$, example: crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa)
stringKind defines the object this REST resource represents. (RoleBinding)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe principal User to bind the role to (pattern: (^User:.+$), example: User:u-111aaa)
+ + + +Role Binding. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe name of the role to bind to the principal (example: CloudClusterAdmin)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
string (uri)A CRN that specifies the scope and resource patterns necessary for the role to bind (pattern: ^crn://.+$, example: crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa)
stringKind defines the object this REST resource represents. (RoleBinding)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe principal User to bind the role to (pattern: (^User:.+$), example: User:u-111aaa)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a role binding. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all role bindings. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a role binding. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a role binding. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a role binding.
crn_patternprincipal, role_name, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all role bindings.
principal, role_name, crn_patternMake a request to create a role binding.
idMake a request to delete a role binding.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringFilter the results by a partial search of crn_pattern. (example: crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-aaa1111/cloud-cluster=lkc-1111aaa)
stringThe unique identifier for the role binding.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for principal. (example: User:u-111aaa)
stringFilter the results by exact match for role_name. (example: CloudClusterAdmin)
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a role binding. + + +Make a request to read a role binding. ```sql SELECT id, +role_name, api_version, crn_pattern, kind, metadata, -principal, -role_name +principal FROM confluent.iam.role_bindings -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' -- required +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new role_bindings resource. +Retrieve a sorted, filtered, paginated list of all role bindings. + +```sql +SELECT +id, +role_name, +api_version, +crn_pattern, +kind, +metadata, +principal +FROM confluent.iam.role_bindings +WHERE crn_pattern = '{{ crn_pattern }}' -- required +AND principal = '{{ principal }}' +AND role_name = '{{ role_name }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples - + { label: 'create_iam_v2_role_binding', value: 'create_iam_v2_role_binding' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a role binding. ```sql -/*+ create */ INSERT INTO confluent.iam.role_bindings ( -data__principal, -data__role_name, -data__crn_pattern +principal, +role_name, +crn_pattern ) SELECT -'{{ principal }}', -'{{ role_name }}', -'{{ crn_pattern }}' +'{{ principal }}' /* required */, +'{{ role_name }}' /* required */, +'{{ crn_pattern }}' /* required */ +RETURNING +id, +role_name, +api_version, +crn_pattern, +kind, +metadata, +principal ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: role_bindings props: - name: principal - value: string + value: "{{ principal }}" + description: | + The principal User to bind the role to - name: role_name - value: string + value: "{{ role_name }}" + description: | + The name of the role to bind to the principal - name: crn_pattern - value: string + value: "{{ crn_pattern }}" + description: | + A CRN that specifies the scope and resource patterns necessary for the role to bind +`} -``` -## `DELETE` example -Deletes the specified role_bindings resource. +## `DELETE` examples + + + + +Make a request to delete a role binding. ```sql -/*+ delete */ DELETE FROM confluent.iam.role_bindings -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/iam/service_accounts/index.md b/website/docs/services/iam/service_accounts/index.md index 681cead..7a091c4 100644 --- a/website/docs/services/iam/service_accounts/index.md +++ b/website/docs/services/iam/service_accounts/index.md @@ -1,4 +1,4 @@ ---- +--- title: service_accounts hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,119 +23,361 @@ Creates, updates, deletes, gets or lists a service_accounts resourc ## Overview - +
Nameservice_accounts
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | A free-form description of the Service Account | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | A human-readable name for the Service Account | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | + +The following fields are returned by `SELECT` queries: + + + + +Service Account. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringA human-readable name for the Service Account (example: DeLorean_auto_repair)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringA free-form description of the Service Account (example: Doc's repair bot for the DeLorean)
stringKind defines the object this REST resource represents. (ServiceAccount)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+ + + +Service Account. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringA human-readable name for the Service Account (example: DeLorean_auto_repair)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringA free-form description of the Service Account (example: Doc's repair bot for the DeLorean)
stringKind defines the object this REST resource represents. (ServiceAccount)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a service account. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all service accounts. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a service account. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a service account. If successful, this request will also recursively delete all of the service account's associated resources, including its cloud and cluster API keys. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a service account. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a service account.
display_name, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all service accounts.
display_nameassigned_resource_ownerMake a request to create a service account.
idMake a request to update a service account.

idMake a request to delete a service account.

If successful, this request will also recursively delete all of the service account's associated resources,
including its cloud and cluster API keys.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the service account.
stringThe resource_id of the principal who will be assigned resource owner on the created service account. Principal can be group-mapping (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx). (example: u-a83k9b)
arrayFilter the results by exact match for display_name. Pass multiple times to see results matching any of the values. (example: [tf_runner_sa, mySA])
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all service accounts. + + +Make a request to read a service account. ```sql SELECT id, -description, -api_version, display_name, +api_version, +description, kind, metadata FROM confluent.iam.service_accounts +WHERE id = '{{ id }}' -- required ; ``` -## `INSERT` example - -Use the following StackQL query and manifest file to create a new service_accounts resource. + + - - +Retrieve a sorted, filtered, paginated list of all service accounts. ```sql -/*+ create */ -INSERT INTO confluent.iam.service_accounts ( -data__display_name, -data__description -) -SELECT -'{{ display_name }}', -'{{ description }}' +SELECT +id, +display_name, +api_version, +description, +kind, +metadata +FROM confluent.iam.service_accounts +WHERE display_name = '{{ display_name }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` + - + +## `INSERT` examples + + + + +Make a request to create a service account. ```sql -/*+ create */ INSERT INTO confluent.iam.service_accounts ( -data__display_name +display_name, +description, +assigned_resource_owner ) SELECT -'{{ display_name }}' +'{{ display_name }}' /* required */, +'{{ description }}', +'{{ assigned_resource_owner }}' +RETURNING +id, +display_name, +api_version, +description, +kind, +metadata ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: service_accounts props: - name: display_name - value: string + value: "{{ display_name }}" + description: | + A human-readable name for the Service Account - name: description - value: string + value: "{{ description }}" + description: | + A free-form description of the Service Account + - name: assigned_resource_owner + value: "{{ assigned_resource_owner }}" + description: The resource_id of the principal who will be assigned resource owner on the created service account. Principal can be group-mapping (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx). (example: u-a83k9b) + description: The resource_id of the principal who will be assigned resource owner on the created service account. Principal can be group-mapping (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx). (example: u-a83k9b) +`} -``` -## `UPDATE` example -Updates a service_accounts resource. +## `UPDATE` examples + + + + +Make a request to update a service account.

```sql -/*+ update */ UPDATE confluent.iam.service_accounts SET +display_name = '{{ display_name }}', description = '{{ description }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +RETURNING +id, +display_name, +api_version, +description, +kind, +metadata; ``` + + + -## `DELETE` example +## `DELETE` examples -Deletes the specified service_accounts resource. + + + +Make a request to delete a service account.

If successful, this request will also recursively delete all of the service account's associated resources,
including its cloud and cluster API keys.
```sql -/*+ delete */ DELETE FROM confluent.iam.service_accounts -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/iam/users/index.md b/website/docs/services/iam/users/index.md index a38df43..f37cf6e 100644 --- a/website/docs/services/iam/users/index.md +++ b/website/docs/services/iam/users/index.md @@ -1,4 +1,4 @@ ---- +--- title: users hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,66 +23,332 @@ Creates, updates, deletes, gets or lists a users resource. ## Overview - +
Nameusers
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | The user's authentication method | -| | `string` | The user's email address | -| | `string` | The user's full name | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | + +The following fields are returned by `SELECT` queries: + + + + +User. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe user's full name (example: Marty McFly)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringThe user's authentication method (example: AUTH_TYPE_SSO)
string (email)The user's email address (example: marty.mcfly@example.com)
stringKind defines the object this REST resource represents. (User)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+ + + +User. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe user's full name (example: Marty McFly)
stringAPIVersion defines the schema version of this representation of a resource. (iam/v2)
stringThe user's authentication method (example: AUTH_TYPE_SSO)
string (email)The user's email address (example: marty.mcfly@example.com)
stringKind defines the object this REST resource represents. (User)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a user. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all users. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a user. If successful, this request will also recursively delete all of the user's associated resources, including its cloud and cluster API keys. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a user. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a user.
page_size, page_tokenRetrieve a sorted, filtered, paginated list of all users.
idMake a request to update a user.

idMake a request to delete a user.

If successful, this request will also recursively delete all of the user's associated resources,
including its cloud and cluster API keys.
idUpdate the auth type of a user
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the user.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all users. + + +Make a request to read a user. ```sql SELECT id, +full_name, api_version, auth_type, email, +kind, +metadata +FROM confluent.iam.users +WHERE id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all users. + +```sql +SELECT +id, full_name, +api_version, +auth_type, +email, kind, metadata FROM confluent.iam.users +WHERE page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` -## `UPDATE` example + + + + +## `UPDATE` examples + + + -Updates a users resource. +Make a request to update a user.

```sql -/*+ update */ UPDATE confluent.iam.users SET +email = '{{ email }}', full_name = '{{ full_name }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +RETURNING +id, +full_name, +api_version, +auth_type, +email, +kind, +metadata; ``` + + -## `DELETE` example -Deletes the specified users resource. +## `DELETE` examples + + + + +Make a request to delete a user.

If successful, this request will also recursively delete all of the user's associated resources,
including its cloud and cluster API keys.
```sql -/*+ delete */ DELETE FROM confluent.iam.users -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Update the auth type of a user + +```sql +EXEC confluent.iam.users.update_auth_type_iam_v2_user +@id='{{ id }}' --required +@@json= +'{ +"auth_type": "{{ auth_type }}" +}' +; ``` + + diff --git a/website/docs/services/kafka/acls/index.md b/website/docs/services/kafka/acls/index.md index eb1607d..1856f0f 100644 --- a/website/docs/services/kafka/acls/index.md +++ b/website/docs/services/kafka/acls/index.md @@ -1,4 +1,4 @@ ---- +--- title: acls hide_title: false hide_table_of_contents: false @@ -15,145 +15,316 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a acls resource. +Creates, updates, deletes, gets or lists an acls resource. ## Overview - +
Nameacls
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +The list of ACLs. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string
object
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return a list of ACLs that match the search criteria. | -| | `INSERT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Create an ACL. | -| | `DELETE` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Delete the ACLs that match the search criteria. | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Create ACLs. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
resource_type, resource_name, pattern_type, principal, host, operation, permission- When calling `/acls` without the `principal` parameter, service
accounts are returned in numeric ID format (e.g., `User:12345`).
- To retrieve service accounts in the `sa-xxx` format, use
`/acls?principal=UserV2:*`.
- The `principal` parameter supports both legacy `User:` format and
new `UserV2:` format for service accounts.
Return a list of ACLs that match the search criteria.
resource_type, resource_name, pattern_type, principal, host, operation, permissionCreate an ACL.
resource_type, pattern_type, operation, permissionresource_name, principal, hostDelete the ACLs that match the search criteria.
dataCreate ACLs.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ACL operation.
stringThe ACL pattern type.
stringThe ACL permission.
stringThe ACL resource type.
stringThe ACL host.
stringThe ACL operation.
stringThe ACL pattern type.
stringThe ACL permission.
stringThe ACL principal. This is the Service Account name or user name. Supports both legacy `User:` format (numeric IDs) and new `UserV2:` format (sa-xxx format) for service accounts. Use `UserV2:*` to retrieve service accounts in the new format.
stringThe ACL resource name.
stringThe ACL resource type.
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return a list of ACLs that match the search criteria. + + +- When calling `/acls` without the `principal` parameter, service
accounts are returned in numeric ID format (e.g., `User:12345`).
- To retrieve service accounts in the `sa-xxx` format, use
`/acls?principal=UserV2:*`.
- The `principal` parameter supports both legacy `User:` format and
new `UserV2:` format for service accounts.
Return a list of ACLs that match the search criteria. ```sql SELECT -cluster_id, -host, +data, kind, -metadata, -operation, -pattern_type, -permission, -principal, -resource_name, -resource_type +metadata FROM confluent.kafka.acls -WHERE cluster_id = '{{ cluster_id }}'; +WHERE resource_type = '{{ resource_type }}' +AND resource_name = '{{ resource_name }}' +AND pattern_type = '{{ pattern_type }}' +AND principal = '{{ principal }}' +AND host = '{{ host }}' +AND operation = '{{ operation }}' +AND permission = '{{ permission }}' +; ``` -## `INSERT` example + + + -Use the following StackQL query and manifest file to create a new acls resource. +## `INSERT` examples - + { label: 'create_kafka_acls', value: 'create_kafka_acls' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Create an ACL. ```sql -/*+ create */ INSERT INTO confluent.kafka.acls ( -data__resource_type, -data__resource_name, -data__pattern_type, -data__principal, -data__host, -data__operation, -data__permission, -cluster_id +resource_type, +resource_name, +pattern_type, +principal, +host, +operation, +permission ) SELECT -'{{ resource_type }}', -'{{ resource_name }}', -'{{ pattern_type }}', -'{{ principal }}', -'{{ host }}', -'{{ operation }}', -'{{ permission }}', -'{{ cluster_id }}' +'{{ resource_type }}' /* required */, +'{{ resource_name }}' /* required */, +'{{ pattern_type }}' /* required */, +'{{ principal }}' /* required */, +'{{ host }}' /* required */, +'{{ operation }}' /* required */, +'{{ permission }}' /* required */ ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: acls props: - - name: cluster_id - value: string - - name: data__host - value: string - - name: data__operation - value: string - - name: data__pattern_type - value: string - - name: data__permission - value: string - - name: data__principal - value: string - - name: data__resource_name - value: string - - name: data__resource_type - value: string - name: resource_type - value: string + value: "{{ resource_type }}" + valid_values: ['UNKNOWN', 'ANY', 'TOPIC', 'GROUP', 'CLUSTER', 'TRANSACTIONAL_ID', 'DELEGATION_TOKEN'] - name: resource_name - value: string + value: "{{ resource_name }}" - name: pattern_type - value: string + value: "{{ pattern_type }}" - name: principal - value: string + value: "{{ principal }}" - name: host - value: string + value: "{{ host }}" - name: operation - value: string + value: "{{ operation }}" - name: permission - value: string + value: "{{ permission }}" +`} -``` -## `DELETE` example -Deletes the specified acls resource. +## `DELETE` examples + + + + +Delete the ACLs that match the search criteria. ```sql -/*+ delete */ DELETE FROM confluent.kafka.acls -WHERE cluster_id = '{{ cluster_id }}'; +WHERE resource_type = '{{ resource_type }}' --required +AND pattern_type = '{{ pattern_type }}' --required +AND operation = '{{ operation }}' --required +AND permission = '{{ permission }}' --required +AND resource_name = '{{ resource_name }}' +AND principal = '{{ principal }}' +AND host = '{{ host }}' +; +``` + + + + +## Lifecycle Methods + + + + +Create ACLs. + +```sql +EXEC confluent.kafka.acls.batch_create_kafka_acls +@@json= +'{ +"data": "{{ data }}" +}' +; ``` + + diff --git a/website/docs/services/kafka/cluster_configs/index.md b/website/docs/services/kafka/cluster_configs/index.md index 8d56ccb..3e8988c 100644 --- a/website/docs/services/kafka/cluster_configs/index.md +++ b/website/docs/services/kafka/cluster_configs/index.md @@ -1,4 +1,4 @@ ---- +--- title: cluster_configs hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,39 +23,247 @@ Creates, updates, deletes, gets or lists a cluster_configs resource ## Overview - +
Namecluster_configs
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `array` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +The cluster configuration parameter. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
boolean
boolean
string
object
string
array
string
+ + + +The list of cluster configs. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
boolean
boolean
string
object
string
array
string
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the dynamic cluster-wide broker configuration parameter specified by ``name``. | -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return a list of dynamic cluster-wide broker configuration parameters for the specified Kafka cluster. Returns an empty list if there are no dynamic cluster-wide broker configuration parameters. | -| | `DELETE` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Reset the configuration parameter specified by ``name`` to its default value by deleting a dynamic cluster-wide configuration. | -| | `UPDATE` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Update or delete a set of dynamic cluster-wide broker configuration parameters. | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Update the dynamic cluster-wide broker configuration parameter specified by ``name``. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the dynamic cluster-wide broker configuration parameter specified by ``name``.
Return a list of dynamic cluster-wide broker configuration parameters for the specified Kafka
cluster. Returns an empty list if there are no dynamic cluster-wide broker configuration parameters.
Update the dynamic cluster-wide broker configuration parameter specified by ``name``.
dataUpdate or delete a set of dynamic cluster-wide broker configuration parameters.
Reset the configuration parameter specified by ``name`` to its
default value by deleting a dynamic cluster-wide configuration.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return a list of dynamic cluster-wide broker configuration parameters for the specified Kafka cluster. Returns an empty list if there are no dynamic cluster-wide broker configuration parameters. + + +Return the dynamic cluster-wide broker configuration parameter specified by ``name``. ```sql SELECT @@ -70,30 +279,83 @@ source, synonyms, value FROM confluent.kafka.cluster_configs -WHERE cluster_id = '{{ cluster_id }}'; +; ``` -## `UPDATE` example + + -Updates a cluster_configs resource. +Return a list of dynamic cluster-wide broker configuration parameters for the specified Kafka
cluster. Returns an empty list if there are no dynamic cluster-wide broker configuration parameters. ```sql -/*+ update */ -UPDATE confluent.kafka.cluster_configs +SELECT +name, +cluster_id, +config_type, +is_default, +is_read_only, +is_sensitive, +kind, +metadata, +source, +synonyms, +value +FROM confluent.kafka.cluster_configs +; +``` + + + + +## `REPLACE` examples + + + + +Update the dynamic cluster-wide broker configuration parameter specified by ``name``. + +```sql +REPLACE confluent.kafka.cluster_configs +SET +value = '{{ value }}'; +``` + + + +Update or delete a set of dynamic cluster-wide broker configuration parameters. + +```sql +REPLACE confluent.kafka.cluster_configs SET data = '{{ data }}', -validate_only = true|false +validate_only = {{ validate_only }} WHERE -cluster_id = '{{ cluster_id }}' -AND data__data = '{{ data__data }}'; +data = '{{ data }}' --required; ``` + + + + +## `DELETE` examples -## `DELETE` example + + -Deletes the specified cluster_configs resource. +Reset the configuration parameter specified by ``name`` to its
default value by deleting a dynamic cluster-wide configuration. ```sql -/*+ delete */ DELETE FROM confluent.kafka.cluster_configs -WHERE cluster_id = '{{ cluster_id }}' -AND name = '{{ name }}'; +; ``` + + diff --git a/website/docs/services/kafka/cluster_link_configs/index.md b/website/docs/services/kafka/cluster_link_configs/index.md index 08aa662..c9085cc 100644 --- a/website/docs/services/kafka/cluster_link_configs/index.md +++ b/website/docs/services/kafka/cluster_link_configs/index.md @@ -1,4 +1,4 @@ ---- +--- title: cluster_link_configs hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,63 +23,347 @@ Creates, updates, deletes, gets or lists a cluster_link_configs res ## Overview - +
Namecluster_link_configs
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `array` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Config name and value + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
boolean
boolean
string
object
string
array
string
+ + + +Config name and value + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
boolean
boolean
string
object
string
array
string
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) | -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) | -| | `DELETE` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Batch Alter Cluster Link Configs | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
value
datavalidate_onlyBatch Alter Cluster Link Configs
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanTo validate the action can be performed successfully or not. Default: false (example: false)
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + + + ```sql SELECT name, cluster_id, +link_name, +is_default, +is_read_only, +is_sensitive, kind, +metadata, +source, +synonyms, +value +FROM confluent.kafka.cluster_link_configs +; +``` + + + + + +```sql +SELECT +name, +cluster_id, link_name, +is_default, +is_read_only, +is_sensitive, +kind, metadata, -read_only, -sensitive, source, synonyms, value FROM confluent.kafka.cluster_link_configs -WHERE cluster_id = '{{ cluster_id }}' -AND link_name = '{{ link_name }}'; +; +``` + + + + +## `REPLACE` examples + + + + + + +```sql +REPLACE confluent.kafka.cluster_link_configs +SET +value = '{{ value }}' +WHERE +value = '{{ value }}' --required; ``` -## `DELETE` example + + + +Batch Alter Cluster Link Configs + +```sql +REPLACE confluent.kafka.cluster_link_configs +SET +data = '{{ data }}', +validate_only = {{ validate_only }} +WHERE +data = '{{ data }}' --required +AND validate_only = {{ validate_only}}; +``` + + + + +## `DELETE` examples + + + + -Deletes the specified cluster_link_configs resource. ```sql -/*+ delete */ DELETE FROM confluent.kafka.cluster_link_configs -WHERE cluster_id = '{{ cluster_id }}' -AND config_name = '{{ config_name }}' -AND link_name = '{{ link_name }}'; +; ``` + + diff --git a/website/docs/services/kafka/cluster_links/index.md b/website/docs/services/kafka/cluster_links/index.md index c0f3ea6..daa9b0b 100644 --- a/website/docs/services/kafka/cluster_links/index.md +++ b/website/docs/services/kafka/cluster_links/index.md @@ -1,4 +1,4 @@ ---- +--- title: cluster_links hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,82 +23,367 @@ Creates, updates, deletes, gets or lists a cluster_links resource. ## Overview - +
Namecluster_links
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `array` | | + +The following fields are returned by `SELECT` queries: + + + + +Single link name and properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
string
string
string
string
object
array
array
+ + + +A list of link names and properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
string
string
string
string
object
array
array
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead. | -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead. | -| | `INSERT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Cluster link creation requires source cluster security configurations in the configs JSON section of the data request payload. | -| | `DELETE` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
include_tasks``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead.
``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead.
link_namevalidate_only, validate_linkCluster link creation requires source cluster security configurations in
the configs JSON section of the data request payload.
force, validate_only
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanForce the action. Default: false (example: false)
booleanWhether to include cluster linking tasks in the response. Default: false (example: false)
booleanTo validate the action can be performed successfully or not. Default: false (example: false)
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead. + + +``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead. ```sql SELECT cluster_link_id, destination_cluster_id, +link_id, +remote_cluster_id, +source_cluster_id, +link_name, +category_counts, kind, link_error, link_error_message, -link_id, -link_name, link_state, metadata, +tasks, +topic_names +FROM confluent.kafka.cluster_links +WHERE include_tasks = '{{ include_tasks }}' +; +``` + + + +``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead. + +```sql +SELECT +cluster_link_id, +destination_cluster_id, +link_id, remote_cluster_id, source_cluster_id, +link_name, +category_counts, +kind, +link_error, +link_error_message, +link_state, +metadata, tasks, topic_names FROM confluent.kafka.cluster_links -WHERE cluster_id = '{{ cluster_id }}'; +; ``` -## `INSERT` example + + + -Use the following StackQL query and manifest file to create a new cluster_links resource. +## `INSERT` examples - + { label: 'create_kafka_link', value: 'create_kafka_link' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Cluster link creation requires source cluster security configurations in
the configs JSON section of the data request payload. ```sql -/*+ create */ INSERT INTO confluent.kafka.cluster_links ( -data__source_cluster_id, -data__destination_cluster_id, -data__remote_cluster_id, -data__cluster_link_id, -data__configs, -cluster_id +source_cluster_id, +destination_cluster_id, +remote_cluster_id, +cluster_link_id, +configs, +link_name, +validate_only, +validate_link ) SELECT '{{ source_cluster_id }}', @@ -105,53 +391,67 @@ SELECT '{{ remote_cluster_id }}', '{{ cluster_link_id }}', '{{ configs }}', -'{{ cluster_id }}' -; -``` - - - - -```sql -/*+ create */ -INSERT INTO confluent.kafka.cluster_links ( -cluster_id -) -SELECT -'{{ cluster_id }}' +'{{ link_name }}', +'{{ validate_only }}', +'{{ validate_link }}' ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: cluster_links props: - - name: cluster_id - value: string + - name: link_name + value: "{{ link_name }}" + description: Required parameter for the cluster_links resource. - name: source_cluster_id - value: string + value: "{{ source_cluster_id }}" - name: destination_cluster_id - value: string + value: "{{ destination_cluster_id }}" - name: remote_cluster_id - value: string + value: "{{ remote_cluster_id }}" + description: | + The expected remote cluster ID. - name: cluster_link_id - value: string + value: "{{ cluster_link_id }}" + description: | + The expected cluster link ID. Can be provided when creating the second side of a bidirectional link for validating the link ID is as expected. If it's not provided, it's inferred from the remote cluster. - name: configs - value: array + value: + - name: "{{ name }}" + value: "{{ value }}" + - name: validate_only + value: {{ validate_only }} + description: To validate the action can be performed successfully or not. Default: false (example: false) + description: To validate the action can be performed successfully or not. Default: false (example: false) + - name: validate_link + value: {{ validate_link }} + description: To synchronously validate that the source cluster ID is expected and the dest cluster has the permission to read topics in the source cluster. Default: true (example: false) + description: To synchronously validate that the source cluster ID is expected and the dest cluster has the permission to read topics in the source cluster. Default: true (example: false) +`} -``` -## `DELETE` example -Deletes the specified cluster_links resource. +## `DELETE` examples + + + + + ```sql -/*+ delete */ DELETE FROM confluent.kafka.cluster_links -WHERE cluster_id = '{{ cluster_id }}' -AND link_name = '{{ link_name }}'; +WHERE force = '{{ force }}' +AND validate_only = '{{ validate_only }}' +; ``` + + diff --git a/website/docs/services/kafka/clusters/index.md b/website/docs/services/kafka/clusters/index.md index 7510935..086d7e6 100644 --- a/website/docs/services/kafka/clusters/index.md +++ b/website/docs/services/kafka/clusters/index.md @@ -1,4 +1,4 @@ ---- +--- title: clusters hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,41 +23,148 @@ Creates, updates, deletes, gets or lists a clusters resource. ## Overview - +
Nameclusters
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | | -| | `object` | | -| | `object` | | -| | `string` | | -| | `object` | | -| | `object` | | -| | `string` | | -| | `object` | | -| | `object` | | -| | `object` | | + +The following fields are returned by `SELECT` queries: + + + + +The Kafka cluster. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
object
object
object
object
string
object
object
object
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the Kafka cluster with the specified ``cluster_id``. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the Kafka cluster with the specified ``cluster_id``.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the Kafka cluster with the specified ``cluster_id``. + + +Return the Kafka cluster with the specified ``cluster_id``. ```sql SELECT +cluster_id, acls, broker_configs, brokers, -cluster_id, consumer_groups, controller, kind, @@ -64,5 +172,7 @@ metadata, partition_reassignments, topics FROM confluent.kafka.clusters -WHERE cluster_id = '{{ cluster_id }}'; -``` \ No newline at end of file +; +``` + + diff --git a/website/docs/services/kafka/consumer_groups/index.md b/website/docs/services/kafka/consumer_groups/index.md index d2ffcbb..d68f9ef 100644 --- a/website/docs/services/kafka/consumer_groups/index.md +++ b/website/docs/services/kafka/consumer_groups/index.md @@ -1,4 +1,4 @@ ---- +--- title: consumer_groups hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,48 +23,275 @@ Creates, updates, deletes, gets or lists a consumer_groups resource ## Overview - +
Nameconsumer_groups
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `object` | | -| | `string` | | -| | `object` | | -| | `boolean` | | -| | `string` | | -| | `object` | | -| | `object` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +The consumer group. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
object
boolean
boolean
string
object
object
string
string
string
+ + + +The list of consumer groups. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
object
boolean
boolean
string
object
object
string
string
string
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the consumer group specified by the ``consumer_group_id``. | -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the list of consumer groups that belong to the specified Kafka cluster. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the consumer group specified by the ``consumer_group_id``.
Return the list of consumer groups that belong to the specified
Kafka cluster.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the list of consumer groups that belong to the specified Kafka cluster. + + + +Return the consumer group specified by the ``consumer_group_id``. + +```sql +SELECT +cluster_id, +consumer_group_id, +consumers, +coordinator, +is_mixed_consumer_group, +is_simple, +kind, +lag_summary, +metadata, +partition_assignor, +state, +type +FROM confluent.kafka.consumer_groups +; +``` + + +Return the list of consumer groups that belong to the specified
Kafka cluster. ```sql SELECT cluster_id, -consumer, consumer_group_id, +consumers, coordinator, +is_mixed_consumer_group, is_simple, kind, lag_summary, metadata, partition_assignor, -state +state, +type FROM confluent.kafka.consumer_groups -WHERE cluster_id = '{{ cluster_id }}'; -``` \ No newline at end of file +; +``` + + diff --git a/website/docs/services/kafka/consumers/index.md b/website/docs/services/kafka/consumers/index.md index 51a8489..95cd3f4 100644 --- a/website/docs/services/kafka/consumers/index.md +++ b/website/docs/services/kafka/consumers/index.md @@ -1,4 +1,4 @@ ---- +--- title: consumers hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,45 +23,227 @@ Creates, updates, deletes, gets or lists a consumers resource. ## Overview - +
Nameconsumers
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | + +The following fields are returned by `SELECT` queries: + + + + +The consumer. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
string
object
+ + + +The list of consumers. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
string
object
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the consumer specified by the ``consumer_id``. | -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return a list of consumers that belong to the specified consumer group. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the consumer specified by the ``consumer_id``.
Return a list of consumers that belong to the specified consumer
group.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return a list of consumers that belong to the specified consumer group. + + +Return the consumer specified by the ``consumer_id``. ```sql SELECT +client_id, +cluster_id, +consumer_group_id, +consumer_id, +instance_id, assignments, +kind, +metadata +FROM confluent.kafka.consumers +; +``` + + + +Return a list of consumers that belong to the specified consumer
group. + +```sql +SELECT client_id, cluster_id, consumer_group_id, consumer_id, instance_id, +assignments, kind, metadata FROM confluent.kafka.consumers -WHERE cluster_id = '{{ cluster_id }}' -AND consumer_group_id = '{{ consumer_group_id }}'; -``` \ No newline at end of file +; +``` + + diff --git a/website/docs/services/kafka/consumers_lag_summary/index.md b/website/docs/services/kafka/consumers_lag_summary/index.md index c8894e5..5a66476 100644 --- a/website/docs/services/kafka/consumers_lag_summary/index.md +++ b/website/docs/services/kafka/consumers_lag_summary/index.md @@ -1,4 +1,4 @@ ---- +--- title: consumers_lag_summary hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,54 +23,174 @@ Creates, updates, deletes, gets or lists a consumers_lag_summary re ## Overview - +
Nameconsumers_lag_summary
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `integer` | | -| | `string` | | -| | `object` | | -| | `integer` | | + +The following fields are returned by `SELECT` queries: + + + + +The max and total consumer lag in a consumer group. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
integer
string
string
integer (int64)
object
object
object
integer (int64)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Available in dedicated clusters only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) Return the maximum and total lag of the consumers belonging to the specified consumer group. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the maximum and total lag of the consumers belonging to the
specified consumer group.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Available in dedicated clusters only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) Return the maximum and total lag of the consumers belonging to the specified consumer group. + + + Return the maximum and total lag of the consumers belonging to the
specified consumer group. ```sql SELECT cluster_id, consumer_group_id, -kind, -max_lag, max_lag_client_id, -max_lag_consumer, max_lag_consumer_id, max_lag_instance_id, -max_lag_partition, max_lag_partition_id, max_lag_topic_name, +kind, +max_lag, +max_lag_consumer, +max_lag_partition, metadata, total_lag FROM confluent.kafka.consumers_lag_summary -WHERE cluster_id = '{{ cluster_id }}' -AND consumer_group_id = '{{ consumer_group_id }}'; -``` \ No newline at end of file +; +``` + + diff --git a/website/docs/services/kafka/consumers_lags/index.md b/website/docs/services/kafka/consumers_lags/index.md index a48af2a..a136f39 100644 --- a/website/docs/services/kafka/consumers_lags/index.md +++ b/website/docs/services/kafka/consumers_lags/index.md @@ -1,4 +1,4 @@ ---- +--- title: consumers_lags hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,37 +23,236 @@ Creates, updates, deletes, gets or lists a consumers_lags resource. ## Overview - +
Nameconsumers_lags
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `object` | | -| | `integer` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +The consumer lag. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
integer
string
integer (int64)
string
integer (int64)
integer (int64)
object
+ + + +The list of consumer lags. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
integer
string
integer (int64)
string
integer (int64)
integer (int64)
object
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Available in dedicated clusters only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) Return the consumer lag on a partition with the given `partition_id`. | -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Available in dedicated clusters only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) Return a list of consumer lags of the consumers belonging to the specified consumer group. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the consumer lag on a partition with the given `partition_id`.
Return a list of consumer lags of the consumers belonging to the
specified consumer group.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Available in dedicated clusters only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) Return a list of consumer lags of the consumers belonging to the specified consumer group. + + + Return the consumer lag on a partition with the given `partition_id`. ```sql SELECT @@ -60,15 +260,38 @@ client_id, cluster_id, consumer_group_id, consumer_id, -current_offset, instance_id, +partition_id, +topic_name, +current_offset, kind, lag, log_end_offset, -metadata, +metadata +FROM confluent.kafka.consumers_lags +; +``` + + + + Return a list of consumer lags of the consumers belonging to the
specified consumer group. + +```sql +SELECT +client_id, +cluster_id, +consumer_group_id, +consumer_id, +instance_id, partition_id, -topic_name +topic_name, +current_offset, +kind, +lag, +log_end_offset, +metadata FROM confluent.kafka.consumers_lags -WHERE cluster_id = '{{ cluster_id }}' -AND consumer_group_id = '{{ consumer_group_id }}'; -``` \ No newline at end of file +; +``` + + diff --git a/website/docs/services/kafka/default_topic_configs/index.md b/website/docs/services/kafka/default_topic_configs/index.md index 2c66642..e78133a 100644 --- a/website/docs/services/kafka/default_topic_configs/index.md +++ b/website/docs/services/kafka/default_topic_configs/index.md @@ -1,4 +1,4 @@ ---- +--- title: default_topic_configs hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,34 +23,162 @@ Creates, updates, deletes, gets or lists a default_topic_configs re ## Overview - +
Namedefault_topic_configs
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `array` | | -| | `string` | | -| | `object` | | + +The following fields are returned by `SELECT` queries: + + + + +The list of cluster configs. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
boolean
boolean
string
object
string
array
string
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) List the default configuration parameters used if the topic were to be newly created. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
List the default configuration parameters used if the topic were to be newly created.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) List the default configuration parameters used if the topic were to be newly created. + + +List the default configuration parameters used if the topic were to be newly created. ```sql SELECT -data, +name, +cluster_id, +topic_name, +is_default, +is_read_only, +is_sensitive, kind, -metadata +metadata, +source, +synonyms, +value FROM confluent.kafka.default_topic_configs -WHERE cluster_id = '{{ cluster_id }}' -AND topic_name = '{{ topic_name }}'; -``` \ No newline at end of file +; +``` + + diff --git a/website/docs/services/kafka/group_configs/index.md b/website/docs/services/kafka/group_configs/index.md new file mode 100644 index 0000000..b175a76 --- /dev/null +++ b/website/docs/services/kafka/group_configs/index.md @@ -0,0 +1,380 @@ +--- +title: group_configs +hide_title: false +hide_table_of_contents: false +keywords: + - group_configs + - kafka + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a group_configs resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Config name and value for group configuration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
boolean
boolean
string
object
string
array
string
+ + + +Config name and value for group configurations. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
boolean
boolean
string
object
string
array
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Get the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups.
List all configurations for the specified group. This API supports consumer groups, share groups, and streams groups.
valueUpdate the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups.
Delete the dynamic configuration override with the specified name for the specified group. After deletion, the default group configuration will be applied. This API supports consumer groups, share groups, and streams groups.
datavalidate_onlyBatch alter configurations for the specified group. This API supports consumer groups, share groups, and streams groups.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanTo validate the action can be performed successfully or not. Default: false (example: false)
+ +## `SELECT` examples + + + + +Get the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups. + +```sql +SELECT +name, +cluster_id, +group_id, +is_default, +is_read_only, +is_sensitive, +kind, +metadata, +source, +synonyms, +value +FROM confluent.kafka.group_configs +; +``` + + + +List all configurations for the specified group. This API supports consumer groups, share groups, and streams groups. + +```sql +SELECT +name, +cluster_id, +group_id, +is_default, +is_read_only, +is_sensitive, +kind, +metadata, +source, +synonyms, +value +FROM confluent.kafka.group_configs +; +``` + + + + +## `REPLACE` examples + + + + +Update the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups. + +```sql +REPLACE confluent.kafka.group_configs +SET +value = '{{ value }}' +WHERE +value = '{{ value }}' --required; +``` + + + + +## `DELETE` examples + + + + +Delete the dynamic configuration override with the specified name for the specified group. After deletion, the default group configuration will be applied. This API supports consumer groups, share groups, and streams groups. + +```sql +DELETE FROM confluent.kafka.group_configs +; +``` + + + + +## Lifecycle Methods + + + + +Batch alter configurations for the specified group. This API supports consumer groups, share groups, and streams groups. + +```sql +EXEC confluent.kafka.group_configs.update_kafka_group_config_batch +@validate_only={{ validate_only }} +@@json= +'{ +"data": "{{ data }}", +"validate_only": {{ validate_only }} +}' +; +``` + + diff --git a/website/docs/services/kafka/index.md b/website/docs/services/kafka/index.md index 98b2313..f8cecb5 100644 --- a/website/docs/services/kafka/index.md +++ b/website/docs/services/kafka/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png kafka service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 15
-
-
+total resources: __16__ ::: @@ -41,6 +37,7 @@ kafka service documentation.
consumers_lags
default_topic_configs
+group_configs
mirror_topics
records
topic_configs
diff --git a/website/docs/services/kafka/mirror_topics/index.md b/website/docs/services/kafka/mirror_topics/index.md index 77f1cf1..6e42845 100644 --- a/website/docs/services/kafka/mirror_topics/index.md +++ b/website/docs/services/kafka/mirror_topics/index.md @@ -1,4 +1,4 @@ ---- +--- title: mirror_topics hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,132 +23,597 @@ Creates, updates, deletes, gets or lists a mirror_topics resource. ## Overview - +
Namemirror_topics
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `object` | | -| | `array` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `integer` | | + +The following fields are returned by `SELECT` queries: + + + + +Metadata of the mirror topic + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
array
array
string (ACTIVE, FAILED, LINK_FAILED, LINK_PAUSED, PAUSED, PENDING_STOPPED, SOURCE_UNAVAILABLE, STOPPED, PENDING_MIRROR, PENDING_SYNCHRONIZE, PENDING_SETUP_FOR_RESTORE, PENDING_RESTORE)
string
integer
integer (int64)
+ + + +Metadata of mirror topics + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
array
array
string (ACTIVE, FAILED, LINK_FAILED, LINK_PAUSED, PAUSED, PENDING_STOPPED, SOURCE_UNAVAILABLE, STOPPED, PENDING_MIRROR, PENDING_SYNCHRONIZE, PENDING_SETUP_FOR_RESTORE, PENDING_RESTORE)
string
integer
integer (int64)
+ + + +Metadata of mirror topics + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
array
array
string (ACTIVE, FAILED, LINK_FAILED, LINK_PAUSED, PAUSED, PENDING_STOPPED, SOURCE_UNAVAILABLE, STOPPED, PENDING_MIRROR, PENDING_SYNCHRONIZE, PENDING_SETUP_FOR_RESTORE, PENDING_RESTORE)
string
integer
integer (int64)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) List all mirror topics in the cluster | -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) List all mirror topics under the link | -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) | -| | `INSERT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Create a topic in the destination cluster mirroring a topic in the source cluster | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
include_state_transition_errors
mirror_statusList all mirror topics under the link
mirror_statusList all mirror topics in the cluster
source_topic_nameCreate a topic in the destination cluster mirroring a topic in
the source cluster
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether to include mirror state transition errors in the response. Default: false (example: false)
stringThe status of the mirror topic. If not specified, all mirror topics will be returned. (example: ACTIVE)
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) List all mirror topics in the cluster + + + ```sql SELECT -kind, link_name, +mirror_topic_name, +source_topic_name, +kind, metadata, mirror_lags, mirror_state_transition_errors, mirror_status, -mirror_topic_name, +mirror_topic_error, num_partitions, -source_topic_name, state_time_ms FROM confluent.kafka.mirror_topics -WHERE cluster_id = '{{ cluster_id }}'; +WHERE include_state_transition_errors = '{{ include_state_transition_errors }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new mirror_topics resource. +List all mirror topics under the link - - +```sql +SELECT +link_name, +mirror_topic_name, +source_topic_name, +kind, +metadata, +mirror_lags, +mirror_state_transition_errors, +mirror_status, +mirror_topic_error, +num_partitions, +state_time_ms +FROM confluent.kafka.mirror_topics +WHERE mirror_status = '{{ mirror_status }}' +; +``` + + + +List all mirror topics in the cluster ```sql -/*+ create */ -INSERT INTO confluent.kafka.mirror_topics ( -data__source_topic_name, -data__mirror_topic_name, -data__replication_factor, -data__configs, -cluster_id, -link_name -) -SELECT -'{{ source_topic_name }}', -'{{ mirror_topic_name }}', -'{{ replication_factor }}', -'{{ configs }}', -'{{ cluster_id }}', -'{{ link_name }}' +SELECT +link_name, +mirror_topic_name, +source_topic_name, +kind, +metadata, +mirror_lags, +mirror_state_transition_errors, +mirror_status, +mirror_topic_error, +num_partitions, +state_time_ms +FROM confluent.kafka.mirror_topics +WHERE mirror_status = '{{ mirror_status }}' ; ``` + + - +## `INSERT` examples + + + + +Create a topic in the destination cluster mirroring a topic in
the source cluster ```sql -/*+ create */ INSERT INTO confluent.kafka.mirror_topics ( -data__source_topic_name, -cluster_id, -link_name +source_topic_name, +mirror_topic_name, +replication_factor, +configs ) SELECT -'{{ source_topic_name }}', -'{{ cluster_id }}', -'{{ link_name }}' +'{{ source_topic_name }}' /* required */, +'{{ mirror_topic_name }}', +{{ replication_factor }}, +'{{ configs }}' ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: mirror_topics props: - - name: cluster_id - value: string - - name: link_name - value: string - - name: data__source_topic_name - value: string - name: source_topic_name - value: string + value: "{{ source_topic_name }}" - name: mirror_topic_name - value: string + value: "{{ mirror_topic_name }}" - name: replication_factor - value: integer + value: {{ replication_factor }} - name: configs - value: array + value: + - name: "{{ name }}" + value: "{{ value }}" +`} + + + + + +## Lifecycle Methods + + + + + + +```sql +EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_promote +@@json= +'{ +"mirror_topic_names": "{{ mirror_topic_names }}", +"mirror_topic_name_pattern": "{{ mirror_topic_name_pattern }}" +}' +; +``` + + + + + +```sql +EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_failover +@@json= +'{ +"mirror_topic_names": "{{ mirror_topic_names }}", +"mirror_topic_name_pattern": "{{ mirror_topic_name_pattern }}" +}' +; +``` + + + + +```sql +EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_pause +@@json= +'{ +"mirror_topic_names": "{{ mirror_topic_names }}", +"mirror_topic_name_pattern": "{{ mirror_topic_name_pattern }}" +}' +; +``` + + + + + +```sql +EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_resume +@@json= +'{ +"mirror_topic_names": "{{ mirror_topic_names }}", +"mirror_topic_name_pattern": "{{ mirror_topic_name_pattern }}" +}' +; +``` + + + + + +```sql +EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_reverse_and_start_mirror +@@json= +'{ +"mirror_topic_names": "{{ mirror_topic_names }}", +"mirror_topic_name_pattern": "{{ mirror_topic_name_pattern }}" +}' +; +``` + + + + + +```sql +EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_reverse_and_pause_mirror +@@json= +'{ +"mirror_topic_names": "{{ mirror_topic_names }}", +"mirror_topic_name_pattern": "{{ mirror_topic_name_pattern }}" +}' +; +``` + + + + + +```sql +EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_truncate_and_restore_mirror +@@json= +'{ +"mirror_topic_names": "{{ mirror_topic_names }}", +"mirror_topic_name_pattern": "{{ mirror_topic_name_pattern }}" +}' +; ``` diff --git a/website/docs/services/kafka/records/index.md b/website/docs/services/kafka/records/index.md index 243813c..5a16027 100644 --- a/website/docs/services/kafka/records/index.md +++ b/website/docs/services/kafka/records/index.md @@ -1,4 +1,4 @@ ---- +--- title: records hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,16 +23,121 @@ Creates, updates, deletes, gets or lists a records resource. ## Overview - +
Namerecords
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + `SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Produce records to the given topic, returning delivery reports for each record produced. This API can be used in streaming mode by setting "Transfer-Encoding: chunked" header. For as long as the connection is kept open, the server will keep accepting records. Records are streamed to and from the server as Concatenated JSON. For each record sent to the server, the server will asynchronously send back a delivery report, in the same order, each with its own error_code. An error_code of 200 indicates success. The HTTP status code will be HTTP 200 OK as long as the connection is successfully established. To identify records that have encountered an error, check the error_code of each delivery report. Note that the cluster_id is validated only when running in Confluent Cloud. This API currently does not support Schema Registry integration. Sending schemas is not supported. Only BINARY, JSON, and STRING formats are supported. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Produce records to the given topic, returning delivery reports for each
record produced. This API can be used in streaming mode by setting
"Transfer-Encoding: chunked" header. For as long as the connection is
kept open, the server will keep accepting records. Records are streamed
to and from the server as Concatenated JSON. For each record sent to the
server, the server will asynchronously send back a delivery report, in
the same order, each with its own error_code. An error_code of 200
indicates success. The HTTP status code will be HTTP 200 OK as long as
the connection is successfully established. To identify records that
have encountered an error, check the error_code of each delivery report.

Note that the cluster_id is validated only when running in Confluent Cloud.

This API currently does not support Schema Registry integration. Sending
schemas is not supported. Only BINARY, JSON, and STRING formats are
supported.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `INSERT` examples + + + + +Produce records to the given topic, returning delivery reports for each
record produced. This API can be used in streaming mode by setting
"Transfer-Encoding: chunked" header. For as long as the connection is
kept open, the server will keep accepting records. Records are streamed
to and from the server as Concatenated JSON. For each record sent to the
server, the server will asynchronously send back a delivery report, in
the same order, each with its own error_code. An error_code of 200
indicates success. The HTTP status code will be HTTP 200 OK as long as
the connection is successfully established. To identify records that
have encountered an error, check the error_code of each delivery report.

Note that the cluster_id is validated only when running in Confluent Cloud.

This API currently does not support Schema Registry integration. Sending
schemas is not supported. Only BINARY, JSON, and STRING formats are
supported. + +```sql +INSERT INTO confluent.kafka.records ( +partition_id, +headers, +key, +value, +timestamp +) +SELECT +{{ partition_id }}, +'{{ headers }}', +'{{ key }}', +'{{ value }}', +'{{ timestamp }}' +RETURNING +cluster_id, +partition_id, +topic_name, +error_code, +key, +message, +offset, +timestamp, +value +; +``` + + + +{`# Description fields are for documentation purposes +- name: records + props: + - name: partition_id + value: {{ partition_id }} + - name: headers + value: + - name: "{{ name }}" + value: "{{ value }}" + - name: key + value: + type: "{{ type }}" + data: "{{ data }}" + - name: value + value: + type: "{{ type }}" + data: "{{ data }}" + - name: timestamp + value: "{{ timestamp }}" +`} + + + diff --git a/website/docs/services/kafka/topic_configs/index.md b/website/docs/services/kafka/topic_configs/index.md index cd151ef..b849c7a 100644 --- a/website/docs/services/kafka/topic_configs/index.md +++ b/website/docs/services/kafka/topic_configs/index.md @@ -1,4 +1,4 @@ ---- +--- title: topic_configs hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,45 +23,354 @@ Creates, updates, deletes, gets or lists a topic_configs resource. ## Overview - +
Nametopic_configs
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +The topic configuration parameter. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
boolean
boolean
string
object
string
array
string
+ + + +The list of cluster configs. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
boolean
boolean
string
object
string
array
string
+ + + +The list of cluster configs. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
boolean
boolean
string
object
string
array
string
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the configuration parameter with the given `name`. | -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the list of configuration parameters for all topics hosted by the specified cluster. | -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the list of configuration parameters that belong to the specified topic. | -| | `DELETE` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Reset the configuration parameter with given `name` to its default value. | -| | `UPDATE` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Update or delete a set of topic configuration parameters. Also supports a dry-run mode that only validates whether the operation would succeed if the ``validate_only`` request property is explicitly specified and set to true. | -| | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Update the configuration parameter with given `name`. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the configuration parameter with the given `name`.
Return the list of configuration parameters that belong to the specified topic.
Return the list of configuration parameters for all topics hosted by the specified
cluster.
Update the configuration parameter with given `name`. To update the
number of partitions, see
https://docs.confluent.io/cloud/current/api.html#tag/Topic-(v3)/operation/updatePartitionCountKafkaTopic.
dataUpdate or delete a set of topic configuration parameters.
Also supports a dry-run mode that only validates whether the operation would succeed if the
``validate_only`` request property is explicitly specified and set to true.
Reset the configuration parameter with given `name` to its default value.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the list of configuration parameters for all topics hosted by the specified cluster. + + + +Return the configuration parameter with the given `name`. + +```sql +SELECT +name, +cluster_id, +topic_name, +is_default, +is_read_only, +is_sensitive, +kind, +metadata, +source, +synonyms, +value +FROM confluent.kafka.topic_configs +; +``` + + +Return the list of configuration parameters that belong to the specified topic. ```sql SELECT name, cluster_id, +topic_name, is_default, is_read_only, is_sensitive, @@ -68,35 +378,85 @@ kind, metadata, source, synonyms, +value +FROM confluent.kafka.topic_configs +; +``` + + + +Return the list of configuration parameters for all topics hosted by the specified
cluster. + +```sql +SELECT +name, +cluster_id, topic_name, +is_default, +is_read_only, +is_sensitive, +kind, +metadata, +source, +synonyms, value FROM confluent.kafka.topic_configs -WHERE cluster_id = '{{ cluster_id }}'; +; +``` + + + + +## `REPLACE` examples + + + + +Update the configuration parameter with given `name`. To update the
number of partitions, see
https://docs.confluent.io/cloud/current/api.html#tag/Topic-(v3)/operation/updatePartitionCountKafkaTopic. + +```sql +REPLACE confluent.kafka.topic_configs +SET +value = '{{ value }}'; ``` -## `UPDATE` example + + -Updates a topic_configs resource. +Update or delete a set of topic configuration parameters.
Also supports a dry-run mode that only validates whether the operation would succeed if the
``validate_only`` request property is explicitly specified and set to true. ```sql -/*+ update */ -UPDATE confluent.kafka.topic_configs +REPLACE confluent.kafka.topic_configs SET data = '{{ data }}', -validate_only = true|false +validate_only = {{ validate_only }} WHERE -cluster_id = '{{ cluster_id }}' -AND topic_name = '{{ topic_name }}' -AND data__data = '{{ data__data }}'; +data = '{{ data }}' --required; ``` + + + + +## `DELETE` examples -## `DELETE` example + + -Deletes the specified topic_configs resource. +Reset the configuration parameter with given `name` to its default value. ```sql -/*+ delete */ DELETE FROM confluent.kafka.topic_configs -WHERE cluster_id = '{{ cluster_id }}' -AND name = '{{ name }}' -AND topic_name = '{{ topic_name }}'; +; ``` + + diff --git a/website/docs/services/kafka/topic_partitions/index.md b/website/docs/services/kafka/topic_partitions/index.md index 1dbafbe..87e2a68 100644 --- a/website/docs/services/kafka/topic_partitions/index.md +++ b/website/docs/services/kafka/topic_partitions/index.md @@ -1,4 +1,4 @@ ---- +--- title: topic_partitions hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,45 +23,227 @@ Creates, updates, deletes, gets or lists a topic_partitions resourc ## Overview - +
Nametopic_partitions
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `object` | | -| | `object` | | -| | `integer` | | -| | `object` | | -| | `object` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +The partition + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integer
string
string
object
object
object
object
+ + + +The list of partitions. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integer
string
string
object
object
object
object
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the partition with the given `partition_id`. | -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the list of partitions that belong to the specified topic. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the partition with the given `partition_id`.
Return the list of partitions that belong to the specified topic.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the list of partitions that belong to the specified topic. + + +Return the partition with the given `partition_id`. ```sql SELECT cluster_id, +partition_id, +topic_name, kind, leader, metadata, +reassignment, +replicas +FROM confluent.kafka.topic_partitions +; +``` + + + +Return the list of partitions that belong to the specified topic. + +```sql +SELECT +cluster_id, partition_id, +topic_name, +kind, +leader, +metadata, reassignment, -replicas, -topic_name +replicas FROM confluent.kafka.topic_partitions -WHERE cluster_id = '{{ cluster_id }}' -AND topic_name = '{{ topic_name }}'; -``` \ No newline at end of file +; +``` + + diff --git a/website/docs/services/kafka/topics/index.md b/website/docs/services/kafka/topics/index.md index c36c3f0..681b872 100644 --- a/website/docs/services/kafka/topics/index.md +++ b/website/docs/services/kafka/topics/index.md @@ -1,4 +1,4 @@ ---- +--- title: topics hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,44 +23,258 @@ Creates, updates, deletes, gets or lists a topics resource. ## Overview - +
Nametopics
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `array` | | -| | `string` | | -| | `object` | | -| | `boolean` | | -| | `string` | | -| | `object` | | -| | `object` | | -| | `object` | | -| | `integer` | | -| | `integer` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +The topic. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
object
boolean
string
object
object
object
integer
integer
+ + + +The list of topics. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
object
boolean
string
object
object
object
integer
integer
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the topic with the given `topic_name`. | -| | `SELECT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the list of topics that belong to the specified Kafka cluster. | -| | `INSERT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Create a topic. Also supports a dry-run mode that only validates whether the topic creation would succeed if the ``validate_only`` request property is explicitly specified and set to true. Note that when dry-run mode is being used the response status would be 200 OK instead of 201 Created. | -| | `DELETE` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Delete the topic with the given `topic_name`. | -| | `UPDATE` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Increase the number of partitions for a topic. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
include_authorized_operationsReturn the topic with the given `topic_name`.
Return the list of topics that belong to the specified Kafka cluster.
topic_nameCreate a topic.
Also supports a dry-run mode that only validates whether the topic creation would succeed
if the ``validate_only`` request property is explicitly specified and set to true. Note that
when dry-run mode is being used the response status would be 200 OK instead of 201 Created.
partitions_countIncrease the number of partitions for a topic. To update other topic
configurations, see https://docs.confluent.io/cloud/current/api.html#tag/Configs-(v3)/operation/updateKafkaTopicConfig.
Delete the topic with the given `topic_name`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanSpecify if authorized operations should be included in the response.
## `SELECT` examples -[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the list of topics that belong to the specified Kafka cluster. + + +Return the topic with the given `topic_name`. ```sql SELECT -authorized_operations, cluster_id, +topic_name, +authorized_operations, configs, is_internal, kind, @@ -67,112 +282,151 @@ metadata, partition_reassignments, partitions, partitions_count, -replication_factor, -topic_name +replication_factor FROM confluent.kafka.topics -WHERE cluster_id = '{{ cluster_id }}'; +WHERE include_authorized_operations = '{{ include_authorized_operations }}' +; ``` -## `INSERT` example - -Use the following StackQL query and manifest file to create a new topics resource. + + - - +Return the list of topics that belong to the specified Kafka cluster. ```sql -/*+ create */ -INSERT INTO confluent.kafka.topics ( -data__topic_name, -data__partitions_count, -data__replication_factor, -data__configs, -data__validate_only, -cluster_id -) -SELECT -'{{ topic_name }}', -'{{ partitions_count }}', -'{{ replication_factor }}', -'{{ configs }}', -'{{ validate_only }}', -'{{ cluster_id }}' +SELECT +cluster_id, +topic_name, +authorized_operations, +configs, +is_internal, +kind, +metadata, +partition_reassignments, +partitions, +partitions_count, +replication_factor +FROM confluent.kafka.topics ; ``` + - + +## `INSERT` examples + + + + +Create a topic.
Also supports a dry-run mode that only validates whether the topic creation would succeed
if the ``validate_only`` request property is explicitly specified and set to true. Note that
when dry-run mode is being used the response status would be 200 OK instead of 201 Created. ```sql -/*+ create */ INSERT INTO confluent.kafka.topics ( -data__topic_name, -cluster_id +topic_name, +partitions_count, +replication_factor, +configs, +validate_only ) SELECT -'{{ topic_name }}', -'{{ cluster_id }}' +'{{ topic_name }}' /* required */, +{{ partitions_count }}, +{{ replication_factor }}, +'{{ configs }}', +{{ validate_only }} +RETURNING +cluster_id, +topic_name, +authorized_operations, +configs, +is_internal, +kind, +metadata, +partition_reassignments, +partitions, +partitions_count, +replication_factor ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: topics props: - - name: cluster_id - value: string - - name: data__topic_name - value: string - name: topic_name - value: string + value: "{{ topic_name }}" - name: partitions_count - value: integer + value: {{ partitions_count }} - name: replication_factor - value: integer + value: {{ replication_factor }} - name: configs - value: array - props: - - name: name - value: string - - name: value - value: string + value: + - name: "{{ name }}" + value: "{{ value }}" - name: validate_only - value: boolean + value: {{ validate_only }} +`} -``` -## `UPDATE` example -Updates a topics resource. +## `UPDATE` examples + + + + +Increase the number of partitions for a topic. To update other topic
configurations, see https://docs.confluent.io/cloud/current/api.html#tag/Configs-(v3)/operation/updateKafkaTopicConfig. ```sql -/*+ update */ UPDATE confluent.kafka.topics SET -partitions_count = '{{ partitions_count }}' +partitions_count = {{ partitions_count }} WHERE -cluster_id = '{{ cluster_id }}' -AND topic_name = '{{ topic_name }}' -AND data__partitions_count = '{{ data__partitions_count }}'; +partitions_count = '{{ partitions_count }}' --required +RETURNING +cluster_id, +topic_name, +authorized_operations, +configs, +is_internal, +kind, +metadata, +partition_reassignments, +partitions, +partitions_count, +replication_factor; ``` + + + + +## `DELETE` examples -## `DELETE` example + + -Deletes the specified topics resource. +Delete the topic with the given `topic_name`. ```sql -/*+ delete */ DELETE FROM confluent.kafka.topics -WHERE cluster_id = '{{ cluster_id }}' -AND topic_name = '{{ topic_name }}'; +; ``` + + diff --git a/website/docs/services/ksqldb_clusters/clusters/index.md b/website/docs/services/ksqldb_clusters/clusters/index.md index 98d9f99..d4e20ec 100644 --- a/website/docs/services/ksqldb_clusters/clusters/index.md +++ b/website/docs/services/ksqldb_clusters/clusters/index.md @@ -1,4 +1,4 @@ ---- +--- title: clusters hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,97 +23,326 @@ Creates, updates, deletes, gets or lists a clusters resource. ## Overview - +
Nameclusters
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Cluster | -| | `object` | The status of the Cluster | + +The following fields are returned by `SELECT` queries: + + + + +Cluster. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (ksqldbcm/v2)
stringKind defines the object this REST resource represents. (Cluster)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Cluster
objectThe status of the Cluster
+ + + +Cluster. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (ksqldbcm/v2)
stringKind defines the object this REST resource represents. (Cluster)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Cluster
objectThe status of the Cluster
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a cluster. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all clusters. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a cluster. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a cluster. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a cluster.
environmentpage_size, page_tokenRetrieve a sorted, filtered, paginated list of all clusters.
specMake a request to create a cluster.
environment, idMake a request to delete a cluster.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the cluster.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all clusters. + + +Make a request to read a cluster. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.ksqldb_clusters.clusters -WHERE environment = '{{ environment }}'; +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new clusters resource. +Retrieve a sorted, filtered, paginated list of all clusters. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.ksqldb_clusters.clusters +WHERE environment = '{{ environment }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples - + { label: 'create_ksqldbcm_v2_cluster', value: 'create_ksqldbcm_v2_cluster' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a cluster. ```sql -/*+ create */ INSERT INTO confluent.ksqldb_clusters.clusters ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: clusters props: - name: spec - props: - - name: kafka_cluster - value: string - - name: credential_identity - value: string - - name: environment - value: string + description: | + The desired state of the Cluster + value: + display_name: "{{ display_name }}" + use_detailed_processing_log: {{ use_detailed_processing_log }} + csu: {{ csu }} + kafka_cluster: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + credential_identity: + id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" + environment: + id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} -``` -## `DELETE` example -Deletes the specified clusters resource. +## `DELETE` examples + + + + +Make a request to delete a cluster. ```sql -/*+ delete */ DELETE FROM confluent.ksqldb_clusters.clusters -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/ksqldb_clusters/index.md b/website/docs/services/ksqldb_clusters/index.md index 82f5e36..190fd78 100644 --- a/website/docs/services/ksqldb_clusters/index.md +++ b/website/docs/services/ksqldb_clusters/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png ksqldb_clusters service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 1
-
-
+total resources: __1__ ::: diff --git a/website/docs/services/managed_kafka_clusters/clusters/index.md b/website/docs/services/managed_kafka_clusters/clusters/index.md index e15f818..c97df7a 100644 --- a/website/docs/services/managed_kafka_clusters/clusters/index.md +++ b/website/docs/services/managed_kafka_clusters/clusters/index.md @@ -1,4 +1,4 @@ ---- +--- title: clusters hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,208 +23,381 @@ Creates, updates, deletes, gets or lists a clusters resource. ## Overview - +
Nameclusters
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + - - -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `text` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `text` | field from the parent object | -| | `text` | APIVersion defines the schema version of this representation of a resource. | -| | `text` | field from the parent object | -| | `text` | field from the parent object | -| | `text` | field from the parent object | -| | `text` | field from the parent object | -| | `text` | field from the parent object | -| | `text` | field from the parent object | -| | `text` | field from the parent object | -| | `text` | field from the parent object | -| | `text` | field from the parent object | -| | `text` | field from the parent object | -| | `text` | field from the parent object | -| | `text` | Kind defines the object this REST resource represents. | -| | `text` | field from the parent object | -| | `text` | field from the parent object | -| | `text` | field from the parent object | -| | `text` | field from the parent object | -| | `text` | field from the parent object | + { label: 'get_cmk_v2_cluster', value: 'get_cmk_v2_cluster' }, + { label: 'list_cmk_v2_clusters', value: 'list_cmk_v2_clusters' } + ]} +> + + +Cluster. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (cmk/v2)
stringKind defines the object this REST resource represents. (Cluster)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Cluster
objectThe status of the Cluster
 - - -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Cluster | -| | `object` | The status of the Cluster | - + + +Cluster. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (cmk/v2)
stringKind defines the object this REST resource represents. (Cluster)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Cluster
objectThe status of the Cluster
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a cluster. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all clusters. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a cluster. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a cluster. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a cluster. | -## `SELECT` examples +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a cluster.
environmentspec.network, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all clusters.
specMake a request to create a cluster.
id, specMake a request to update a cluster.

environment, idMake a request to delete a cluster.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all clusters. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the cluster.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
arrayFilter the results by exact match for spec.network. Pass multiple times to see results matching any of the values. (example: [n-00000, n-00001])
+ +## `SELECT` examples - + { label: 'get_cmk_v2_cluster', value: 'get_cmk_v2_cluster' }, + { label: 'list_cmk_v2_clusters', value: 'list_cmk_v2_clusters' } + ]} +> + + +Make a request to read a cluster. ```sql SELECT id, -api_endpoint, api_version, -availability, -cloud, -config_kind, -created_at, -display_name, -environment, -environment_id, -environment_related, -environment_resource_name, -http_endpoint, -kafka_bootstrap_endpoint, kind, -region, -resource_name, -self, -status_phase, -updated_at -FROM confluent.managed_kafka_clusters.vw_clusters -WHERE environment = '{{ environment }}'; +metadata, +spec, +status +FROM confluent.managed_kafka_clusters.clusters +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; ``` - + +Retrieve a sorted, filtered, paginated list of all clusters. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.managed_kafka_clusters.clusters -WHERE environment = '{{ environment }}'; +WHERE environment = '{{ environment }}' -- required +AND spec.network = '{{ spec.network }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` - - + + -## `INSERT` example -Use the following StackQL query and manifest file to create a new clusters resource. +## `INSERT` examples - + { label: 'create_cmk_v2_cluster', value: 'create_cmk_v2_cluster' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a cluster. ```sql -/*+ create */ INSERT INTO confluent.managed_kafka_clusters.clusters ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: clusters props: - name: spec - props: - - name: display_name - value: string - - name: availability - value: string - - name: cloud - value: string - - name: region - value: string - - name: config - props: - - name: kind - value: string - - name: environment - props: - - name: id - value: string - - name: environment - value: string - - name: network - props: - - name: id - value: string - - name: environment - value: string - - name: byok - props: - - name: id - value: string + description: | + The desired state of the Cluster + value: + display_name: "{{ display_name }}" + availability: "{{ availability }}" + cloud: "{{ cloud }}" + region: "{{ region }}" + config: + kind: "{{ kind }}" + max_ecku: {{ max_ecku }} + cku: {{ cku }} + encryption_key: "{{ encryption_key }}" + zones: + - "{{ zones }}" + kafka_bootstrap_endpoint: "{{ kafka_bootstrap_endpoint }}" + http_endpoint: "{{ http_endpoint }}" + api_endpoint: "{{ api_endpoint }}" + endpoints: "{{ endpoints }}" + environment: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + network: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + byok: + id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} -``` -## `UPDATE` example -Updates a clusters resource. +## `UPDATE` examples + + + + +Make a request to update a cluster.

```sql -/*+ update */ UPDATE confluent.managed_kafka_clusters.clusters SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; ``` + + -## `DELETE` example -Deletes the specified clusters resource. +## `DELETE` examples + + + + +Make a request to delete a cluster. ```sql -/*+ delete */ DELETE FROM confluent.managed_kafka_clusters.clusters -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/managed_kafka_clusters/index.md b/website/docs/services/managed_kafka_clusters/index.md index e96be1b..6582c2d 100644 --- a/website/docs/services/managed_kafka_clusters/index.md +++ b/website/docs/services/managed_kafka_clusters/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png managed_kafka_clusters service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 1
-
-
+total resources: __1__ ::: diff --git a/website/docs/services/networking/access_points/index.md b/website/docs/services/networking/access_points/index.md index 340a6fc..6553a1c 100644 --- a/website/docs/services/networking/access_points/index.md +++ b/website/docs/services/networking/access_points/index.md @@ -1,4 +1,4 @@ ---- +--- title: access_points hide_title: false hide_table_of_contents: false @@ -15,116 +15,403 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a access_points resource. +Creates, updates, deletes, gets or lists an access_points resource. ## Overview - +
Nameaccess_points
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Access Point | -| | `object` | The status of the Access Point | + +The following fields are returned by `SELECT` queries: + + + + +Access Point. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (AccessPoint)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Access Point
objectThe status of the Access Point
+ + + +Access Point. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (AccessPoint)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Access Point
objectThe status of the Access Point
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read an access point. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all access points. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create an access point. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete an access point. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update an access point. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read an access point.
environmentspec.display_name, spec.gateway, id, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all access points.
specMake a request to create an access point.
id, specMake a request to update an access point.

environment, idMake a request to delete an access point.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the access point.
arrayFilter the results by exact match for id. Pass multiple times to see results matching any of the values. (example: [ap-1, ap-2])
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
arrayFilter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. (example: [prod-ap-egress-use1, prod-ap-egress-usw2])
arrayFilter the results by exact match for spec.gateway. Pass multiple times to see results matching any of the values. (example: [gw-00000, gw-00001])
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all access points. + + + +Make a request to read an access point. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.networking.access_points +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all access points. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.networking.access_points -WHERE environment = '{{ environment }}'; +WHERE environment = '{{ environment }}' -- required +AND spec.display_name = '{{ spec.display_name }}' +AND spec.gateway = '{{ spec.gateway }}' +AND id = '{{ id }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new access_points resource. + +## `INSERT` examples - + { label: 'create_networking_v1_access_point', value: 'create_networking_v1_access_point' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create an access point. ```sql -/*+ create */ INSERT INTO confluent.networking.access_points ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: access_points props: - name: spec - props: - - name: environment - value: string - - name: gateway - value: string + description: | + The desired state of the Access Point + value: + display_name: "{{ display_name }}" + config: + kind: "{{ kind }}" + vpc_endpoint_service_name: "{{ vpc_endpoint_service_name }}" + enable_high_availability: {{ enable_high_availability }} + target_system: "{{ target_system }}" + vpc_endpoint_id: "{{ vpc_endpoint_id }}" + private_link_service_resource_id: "{{ private_link_service_resource_id }}" + private_link_subresource_name: "{{ private_link_subresource_name }}" + private_endpoint_resource_id: "{{ private_endpoint_resource_id }}" + network_interfaces: + - "{{ network_interfaces }}" + account: "{{ account }}" + egress_routes: + - "{{ egress_routes }}" + private_service_connect_endpoint_target: "{{ private_service_connect_endpoint_target }}" + private_service_connect_connection_id: "{{ private_service_connect_connection_id }}" + environment: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" + gateway: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" +`} -``` -## `UPDATE` example -Updates a access_points resource. +## `UPDATE` examples + + + + +Make a request to update an access point.

```sql -/*+ update */ UPDATE confluent.networking.access_points SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified access_points resource. +Make a request to delete an access point. ```sql -/*+ delete */ DELETE FROM confluent.networking.access_points -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/networking/dns_forwarders/index.md b/website/docs/services/networking/dns_forwarders/index.md index 47e8b77..8bacadb 100644 --- a/website/docs/services/networking/dns_forwarders/index.md +++ b/website/docs/services/networking/dns_forwarders/index.md @@ -1,4 +1,4 @@ ---- +--- title: dns_forwarders hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,109 +23,367 @@ Creates, updates, deletes, gets or lists a dns_forwarders resource. ## Overview - +
Namedns_forwarders
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Dns Forwarder | -| | `object` | The status of the Dns Forwarder | + +The following fields are returned by `SELECT` queries: + + + + +DNS Forwarder. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (DnsForwarder)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Dns Forwarder
objectThe status of the Dns Forwarder
+ + + +DNS Forwarder. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (DnsForwarder)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Dns Forwarder
objectThe status of the Dns Forwarder
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a DNS forwarder. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all DNS forwarders. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a DNS forwarder. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a DNS forwarder. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a DNS forwarder. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a DNS forwarder.
environmentpage_size, page_tokenRetrieve a sorted, filtered, paginated list of all DNS forwarders.
specMake a request to create a DNS forwarder.
id, specMake a request to update a DNS forwarder.

environment, idMake a request to delete a DNS forwarder.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the DNS forwarder.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all DNS forwarders. + + + +Make a request to read a DNS forwarder. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.networking.dns_forwarders +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all DNS forwarders. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.networking.dns_forwarders -WHERE environment = '{{ environment }}'; +WHERE environment = '{{ environment }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new dns_forwarders resource. + +## `INSERT` examples - + { label: 'create_networking_v1_dns_forwarder', value: 'create_networking_v1_dns_forwarder' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a DNS forwarder. ```sql -/*+ create */ INSERT INTO confluent.networking.dns_forwarders ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: dns_forwarders props: - name: spec - props: - - name: environment - value: string - - name: gateway - value: string + description: | + The desired state of the Dns Forwarder + value: + display_name: "{{ display_name }}" + domains: + - "{{ domains }}" + config: + kind: "{{ kind }}" + dns_server_ips: + - "{{ dns_server_ips }}" + environment: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" + gateway: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" +`} -``` -## `UPDATE` example -Updates a dns_forwarders resource. +## `UPDATE` examples + + + + +Make a request to update a DNS forwarder.

```sql -/*+ update */ UPDATE confluent.networking.dns_forwarders SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified dns_forwarders resource. +Make a request to delete a DNS forwarder. ```sql -/*+ delete */ DELETE FROM confluent.networking.dns_forwarders -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/networking/dns_records/index.md b/website/docs/services/networking/dns_records/index.md index 32ca48f..918ec56 100644 --- a/website/docs/services/networking/dns_records/index.md +++ b/website/docs/services/networking/dns_records/index.md @@ -1,4 +1,4 @@ ---- +--- title: dns_records hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,109 +23,389 @@ Creates, updates, deletes, gets or lists a dns_records resource. ## Overview - +
Namedns_records
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Dns Record | -| | `object` | The status of the Dns Record | + +The following fields are returned by `SELECT` queries: + + + + +DNS Record. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (DnsRecord)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Dns Record
objectThe status of the Dns Record
+ + + +DNS Record. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (DnsRecord)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Dns Record
objectThe status of the Dns Record
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a DNS record. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all DNS records. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a DNS record. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a DNS record. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a DNS record. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a DNS record.
environmentspec.display_name, spec.domain, spec.gateway, resource, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all DNS records.
specMake a request to create a DNS record.
id, specMake a request to update a DNS record.

environment, idMake a request to delete a DNS record.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the DNS record.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
arrayFilter the results by exact match for resource. Pass multiple times to see results matching any of the values. (example: [ap-11111, ap-22222])
arrayFilter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. (example: [prod-dnsrec-1, prod-dnsrec-2])
arrayFilter the results by exact match for spec.domain. Pass multiple times to see results matching any of the values. (example: [example.com, example2.com])
arrayFilter the results by exact match for spec.gateway. Pass multiple times to see results matching any of the values. (example: [gw-00000, gw-00001])
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all DNS records. + + + +Make a request to read a DNS record. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.networking.dns_records +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all DNS records. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.networking.dns_records -WHERE environment = '{{ environment }}'; +WHERE environment = '{{ environment }}' -- required +AND spec.display_name = '{{ spec.display_name }}' +AND spec.domain = '{{ spec.domain }}' +AND spec.gateway = '{{ spec.gateway }}' +AND resource = '{{ resource }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new dns_records resource. + +## `INSERT` examples - + { label: 'create_networking_v1_dns_record', value: 'create_networking_v1_dns_record' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a DNS record. ```sql -/*+ create */ INSERT INTO confluent.networking.dns_records ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: dns_records props: - name: spec - props: - - name: environment - value: string - - name: gateway - value: string + description: | + The desired state of the Dns Record + value: + display_name: "{{ display_name }}" + domain: "{{ domain }}" + config: + kind: "{{ kind }}" + resource_id: "{{ resource_id }}" + environment: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" + gateway: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" +`} -``` -## `UPDATE` example -Updates a dns_records resource. +## `UPDATE` examples + + + + +Make a request to update a DNS record.

```sql -/*+ update */ UPDATE confluent.networking.dns_records SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified dns_records resource. +Make a request to delete a DNS record. ```sql -/*+ delete */ DELETE FROM confluent.networking.dns_records -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/networking/gateways/index.md b/website/docs/services/networking/gateways/index.md index 721bfca..ae16e51 100644 --- a/website/docs/services/networking/gateways/index.md +++ b/website/docs/services/networking/gateways/index.md @@ -1,4 +1,4 @@ ---- +--- title: gateways hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,42 +23,389 @@ Creates, updates, deletes, gets or lists a gateways resource. ## Overview - +
Namegateways
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Gateway | -| | `object` | The status of the Gateway | + +The following fields are returned by `SELECT` queries: + + + + +Gateway. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (Gateway)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Gateway
objectThe status of the Gateway
+ + + +Gateway. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (Gateway)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Gateway
objectThe status of the Gateway
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a gateway. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all gateways. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a gateway.
environmentgateway_type, id, spec.config.region, spec.display_name, status.phase, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all gateways.
specMake a request to create a gateway.
id, specMake a request to update a gateway.

environment, idMake a request to delete a gateway.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the gateway.
arrayFilter the results by exact match for gateway_type. Pass multiple times to see results matching any of the values. (example: [AwsEgressPrivateLink, AzureEgressPrivateLink])
arrayFilter the results by exact match for id. Pass multiple times to see results matching any of the values. (example: [gw-1, gw-2])
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
arrayFilter the results by exact match for spec.config.region. Pass multiple times to see results matching any of the values. (example: [us-east-1, us-west-2])
arrayFilter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. (example: [prod-gateway-ingress-use1, prod-gateway-ingress-use2])
arrayFilter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. (example: [PROVISIONING, READY])
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all gateways. + + +Make a request to read a gateway. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.networking.gateways -WHERE environment = '{{ environment }}'; -``` \ No newline at end of file +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all gateways. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.networking.gateways +WHERE environment = '{{ environment }}' -- required +AND gateway_type = '{{ gateway_type }}' +AND id = '{{ id }}' +AND spec.config.region = '{{ spec.config.region }}' +AND spec.display_name = '{{ spec.display_name }}' +AND status.phase = '{{ status.phase }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples + + + + +Make a request to create a gateway. + +```sql +INSERT INTO confluent.networking.gateways ( +spec +) +SELECT +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status +; +``` + + + +{`# Description fields are for documentation purposes +- name: gateways + props: + - name: spec + description: | + The desired state of the Gateway + value: + display_name: "{{ display_name }}" + config: + kind: "{{ kind }}" + region: "{{ region }}" + zones: + - "{{ zones }}" + environment: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" +`} + + + + + +## `UPDATE` examples + + + + +Make a request to update a gateway.

+ +```sql +UPDATE confluent.networking.gateways +SET +spec = '{{ spec }}' +WHERE +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; +``` + + + + +## `DELETE` examples + + + + +Make a request to delete a gateway. + +```sql +DELETE FROM confluent.networking.gateways +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; +``` + + diff --git a/website/docs/services/networking/index.md b/website/docs/services/networking/index.md index 7c0b4d0..9b599ad 100644 --- a/website/docs/services/networking/index.md +++ b/website/docs/services/networking/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png networking service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 14
-
-
+total resources: __14__ ::: diff --git a/website/docs/services/networking/ip_addresses/index.md b/website/docs/services/networking/ip_addresses/index.md index 01e1c0f..cebd127 100644 --- a/website/docs/services/networking/ip_addresses/index.md +++ b/website/docs/services/networking/ip_addresses/index.md @@ -1,4 +1,4 @@ ---- +--- title: ip_addresses hide_title: false hide_table_of_contents: false @@ -15,38 +15,164 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a ip_addresses resource. +Creates, updates, deletes, gets or lists an ip_addresses resource. ## Overview - +
Nameip_addresses
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | Whether the address is used for egress or ingress. | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | The cloud service provider in which the address exists. | -| | `string` | The IP Address range. | -| | `string` | Kind defines the object this REST resource represents. | -| | `string` | The region/location where the IP Address is in use. | -| | `array` | The service types that will use the address. | + +The following fields are returned by `SELECT` queries: + + + + +IP Address. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringWhether the address is used for egress or ingress. (example: EGRESS)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringThe cloud service provider in which the address exists. (example: AWS)
stringThe IP Address range. (pattern: ^\d+\.\d+\.\d+\.\d+/\d+$, example: 10.200.0.0/28)
stringKind defines the object this REST resource represents. (IpAddress)
stringThe region/location where the IP Address is in use. (example: us-east-1)
arrayThe service types that will use the address.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Related guide: [Use Public Egress IP addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) Retrieve a sorted, filtered, paginated list of all IP Addresses. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
cloud, region, services, address_type, page_size, page_tokenRelated guide: [Use Public Egress IP addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html)

Retrieve a sorted, filtered, paginated list of all IP Addresses.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayFilter the results by exact match for address_type. Pass multiple times to see results matching any of the values. (example: [INGRESS, EGRESS])
arrayFilter the results by exact match for cloud. Pass multiple times to see results matching any of the values. (example: [GCP, AWS])
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
arrayFilter the results by exact match for region. Pass multiple times to see results matching any of the values. (example: [us-central1, us-east-1])
arrayFilter the results by exact match for services. Pass multiple times to see results matching any of the values. (example: [KAFKA, CONNECT])
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Related guide: [Use Public Egress IP addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html) Retrieve a sorted, filtered, paginated list of all IP Addresses. + + +Related guide: [Use Public Egress IP addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html)

Retrieve a sorted, filtered, paginated list of all IP Addresses. ```sql SELECT @@ -58,5 +184,13 @@ kind, region, services FROM confluent.networking.ip_addresses +WHERE cloud = '{{ cloud }}' +AND region = '{{ region }}' +AND services = '{{ services }}' +AND address_type = '{{ address_type }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; -``` \ No newline at end of file +``` + + diff --git a/website/docs/services/networking/network_link_endpoints/index.md b/website/docs/services/networking/network_link_endpoints/index.md index 390e560..7b1194c 100644 --- a/website/docs/services/networking/network_link_endpoints/index.md +++ b/website/docs/services/networking/network_link_endpoints/index.md @@ -1,4 +1,4 @@ ---- +--- title: network_link_endpoints hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,111 +23,386 @@ Creates, updates, deletes, gets or lists a network_link_endpoints r ## Overview - +
Namenetwork_link_endpoints
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Network Link Endpoint | -| | `object` | The status of the Network Link Endpoint | + +The following fields are returned by `SELECT` queries: + + + + +Network Link Endpoint. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (NetworkLinkEndpoint)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Network Link Endpoint
objectThe status of the Network Link Endpoint
+ + + +Network Link Endpoint. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (NetworkLinkEndpoint)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Network Link Endpoint
objectThe status of the Network Link Endpoint
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a network link endpoint. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all network link endpoints. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a network link endpoint. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a network link endpoint. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a network link endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a network link endpoint.
environmentspec.display_name, status.phase, spec.network, spec.network_link_service, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all network link endpoints.
specMake a request to create a network link endpoint.
id, specMake a request to update a network link endpoint.

environment, idMake a request to delete a network link endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the network link endpoint.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
arrayFilter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. (example: [prod-net-1-nle, dev-net-1-nle])
arrayFilter the results by exact match for spec.network. Pass multiple times to see results matching any of the values. (example: [n-00000, n-00001])
arrayFilter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. (example: [READY, PENDING_ACCEPT])
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all network link endpoints. + + + +Make a request to read a network link endpoint. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.networking.network_link_endpoints +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all network link endpoints. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.networking.network_link_endpoints -WHERE environment = '{{ environment }}'; +WHERE environment = '{{ environment }}' -- required +AND spec.display_name = '{{ spec.display_name }}' +AND status.phase = '{{ status.phase }}' +AND spec.network = '{{ spec.network }}' +AND spec.network_link_service = '{{ spec.network_link_service }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new network_link_endpoints resource. + +## `INSERT` examples - + { label: 'create_networking_v1_network_link_endpoint', value: 'create_networking_v1_network_link_endpoint' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a network link endpoint. ```sql -/*+ create */ INSERT INTO confluent.networking.network_link_endpoints ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: network_link_endpoints props: - name: spec - props: - - name: environment - value: string - - name: network - value: string - - name: network_link_service - value: string + description: | + The desired state of the Network Link Endpoint + value: + display_name: "{{ display_name }}" + description: "{{ description }}" + environment: + id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + network: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + network_link_service: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} -``` -## `UPDATE` example -Updates a network_link_endpoints resource. +## `UPDATE` examples + + + + +Make a request to update a network link endpoint.

```sql -/*+ update */ UPDATE confluent.networking.network_link_endpoints SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified network_link_endpoints resource. +Make a request to delete a network link endpoint. ```sql -/*+ delete */ DELETE FROM confluent.networking.network_link_endpoints -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/networking/network_link_service_associations/index.md b/website/docs/services/networking/network_link_service_associations/index.md index f0dcfd7..2dd3edc 100644 --- a/website/docs/services/networking/network_link_service_associations/index.md +++ b/website/docs/services/networking/network_link_service_associations/index.md @@ -1,4 +1,4 @@ ---- +--- title: network_link_service_associations hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,43 +23,241 @@ Creates, updates, deletes, gets or lists a network_link_service_associatio ## Overview - +
Namenetwork_link_service_associations
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Network Link Service Association | -| | `object` | The status of the Network Link Service Association | + +The following fields are returned by `SELECT` queries: + + + + +Network Link Service Association. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (NetworkLinkServiceAssociation)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Network Link Service Association
objectThe status of the Network Link Service Association
+ + + +Network Link Service Association. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (NetworkLinkServiceAssociation)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Network Link Service Association
objectThe status of the Network Link Service Association
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a network link service association. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all network link service associations. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
spec.network_link_service, environment, idMake a request to read a network link service association.
spec.network_link_service, environmentstatus.phase, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all network link service associations.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringFilter the results by exact match for environment. (example: env-00000)
stringThe unique identifier for the network link service association.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
arrayFilter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. (example: [READY, PENDING_ACCEPT])
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all network link service associations. + + + +Make a request to read a network link service association. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.networking.network_link_service_associations +WHERE spec.network_link_service = '{{ spec.network_link_service }}' -- required +AND environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all network link service associations. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.networking.network_link_service_associations -WHERE environment = '{{ environment }}' -AND spec.network_link_service = '{{ spec.network_link_service }}'; -``` \ No newline at end of file +WHERE spec.network_link_service = '{{ spec.network_link_service }}' -- required +AND environment = '{{ environment }}' -- required +AND status.phase = '{{ status.phase }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + diff --git a/website/docs/services/networking/network_link_services/index.md b/website/docs/services/networking/network_link_services/index.md index c2893e4..77b7687 100644 --- a/website/docs/services/networking/network_link_services/index.md +++ b/website/docs/services/networking/network_link_services/index.md @@ -1,4 +1,4 @@ ---- +--- title: network_link_services hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,109 +23,380 @@ Creates, updates, deletes, gets or lists a network_link_services re ## Overview - +
Namenetwork_link_services
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Network Link Service | -| | `object` | The status of the Network Link Service | + +The following fields are returned by `SELECT` queries: + + + + +Network Link Service. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (NetworkLinkService)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Network Link Service
objectThe status of the Network Link Service
+ + + +Network Link Service. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (NetworkLinkService)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Network Link Service
objectThe status of the Network Link Service
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a network link service. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all network link services. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a network link service. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a network link service. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a network link service. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a network link service.
environmentspec.display_name, status.phase, spec.network, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all network link services.
specMake a request to create a network link service.
id, specMake a request to update a network link service.

environment, idMake a request to delete a network link service.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the network link service.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
arrayFilter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. (example: [prod-net-1-nls, dev-net-1-nls])
arrayFilter the results by exact match for spec.network. Pass multiple times to see results matching any of the values. (example: [n-00000, n-00001])
arrayFilter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. (example: [READY])
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all network link services. + + + +Make a request to read a network link service. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.networking.network_link_services +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all network link services. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.networking.network_link_services -WHERE environment = '{{ environment }}'; +WHERE environment = '{{ environment }}' -- required +AND spec.display_name = '{{ spec.display_name }}' +AND status.phase = '{{ status.phase }}' +AND spec.network = '{{ spec.network }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new network_link_services resource. + +## `INSERT` examples - + { label: 'create_networking_v1_network_link_service', value: 'create_networking_v1_network_link_service' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a network link service. ```sql -/*+ create */ INSERT INTO confluent.networking.network_link_services ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: network_link_services props: - name: spec - props: - - name: environment - value: string - - name: network - value: string + description: | + The desired state of the Network Link Service + value: + display_name: "{{ display_name }}" + description: "{{ description }}" + accept: + environments: + - "{{ environments }}" + networks: + - "{{ networks }}" + environment: + id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + network: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} -``` -## `UPDATE` example -Updates a network_link_services resource. +## `UPDATE` examples + + + + +Make a request to update a network link service.

```sql -/*+ update */ UPDATE confluent.networking.network_link_services SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified network_link_services resource. +Make a request to delete a network link service. ```sql -/*+ delete */ DELETE FROM confluent.networking.network_link_services -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/networking/networks/index.md b/website/docs/services/networking/networks/index.md index 12f0b8d..eb620eb 100644 --- a/website/docs/services/networking/networks/index.md +++ b/website/docs/services/networking/networks/index.md @@ -1,4 +1,4 @@ ---- +--- title: networks hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,107 +23,410 @@ Creates, updates, deletes, gets or lists a networks resource. ## Overview - +
Namenetworks
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Network | -| | `object` | The status of the Network | + +The following fields are returned by `SELECT` queries: + + + + +Network. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (Network)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Network
objectThe status of the Network
+ + + +Network. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (Network)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Network
objectThe status of the Network
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a network. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all networks. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a network. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a network. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a network. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a network.
environmentspec.display_name, spec.cloud, spec.region, spec.connection_types, spec.cidr, status.phase, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all networks.
specMake a request to create a network.
id, specMake a request to update a network.

environment, idMake a request to delete a network.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the network.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
arrayFilter the results by exact match for spec.cidr. Pass multiple times to see results matching any of the values. (example: [10.200.0.0/16])
arrayFilter the results by exact match for spec.cloud. Pass multiple times to see results matching any of the values. (example: [GCP, AWS])
arrayFilter the results by exact match for spec.connection_types. Pass multiple times to see results matching any of the values. (example: [peering, privatelink])
arrayFilter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. (example: [prod-gcp-us-central1, prod-aws-us-east1])
arrayFilter the results by exact match for spec.region. Pass multiple times to see results matching any of the values. (example: [us-central1, us-east-1])
arrayFilter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. (example: [PROVISIONING, READY])
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all networks. + + + +Make a request to read a network. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.networking.networks +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all networks. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.networking.networks -WHERE environment = '{{ environment }}'; +WHERE environment = '{{ environment }}' -- required +AND spec.display_name = '{{ spec.display_name }}' +AND spec.cloud = '{{ spec.cloud }}' +AND spec.region = '{{ spec.region }}' +AND spec.connection_types = '{{ spec.connection_types }}' +AND spec.cidr = '{{ spec.cidr }}' +AND status.phase = '{{ status.phase }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new networks resource. + +## `INSERT` examples - + { label: 'create_networking_v1_network', value: 'create_networking_v1_network' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a network. ```sql -/*+ create */ INSERT INTO confluent.networking.networks ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: networks props: - name: spec - props: - - name: environment - value: string + description: | + The desired state of the Network + value: + display_name: "{{ display_name }}" + cloud: "{{ cloud }}" + region: "{{ region }}" + connection_types: + - "{{ connection_types }}" + cidr: "{{ cidr }}" + zones: + - "{{ zones }}" + zones_info: + - zone_id: "{{ zone_id }}" + cidr: "{{ cidr }}" + dns_config: + resolution: "{{ resolution }}" + reserved_cidr: "{{ reserved_cidr }}" + environment: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" + gateway: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" +`} -``` -## `UPDATE` example -Updates a networks resource. +## `UPDATE` examples + + + + +Make a request to update a network.

```sql -/*+ update */ UPDATE confluent.networking.networks SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified networks resource. +Make a request to delete a network. ```sql -/*+ delete */ DELETE FROM confluent.networking.networks -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/networking/peerings/index.md b/website/docs/services/networking/peerings/index.md index a9ac1ba..f4630ce 100644 --- a/website/docs/services/networking/peerings/index.md +++ b/website/docs/services/networking/peerings/index.md @@ -1,4 +1,4 @@ ---- +--- title: peerings hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,109 +23,391 @@ Creates, updates, deletes, gets or lists a peerings resource. ## Overview - +
Namepeerings
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Peering | -| | `object` | The status of the Peering | + +The following fields are returned by `SELECT` queries: + + + + +Peering. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (Peering)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Peering
objectThe status of the Peering
+ + + +Peering. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (Peering)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Peering
objectThe status of the Peering
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a peering. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all peerings. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a peering. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a peering. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a peering. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a peering.
environmentspec.display_name, status.phase, spec.network, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all peerings.
specMake a request to create a peering.
id, specMake a request to update a peering.

environment, idMake a request to delete a peering.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the peering.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
arrayFilter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. (example: [prod-peering-uscentral1, prod-peering-use1])
arrayFilter the results by exact match for spec.network. Pass multiple times to see results matching any of the values. (example: [n-00000, n-00001])
arrayFilter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. (example: [PROVISIONING, READY])
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all peerings. + + + +Make a request to read a peering. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.networking.peerings +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all peerings. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.networking.peerings -WHERE environment = '{{ environment }}'; +WHERE environment = '{{ environment }}' -- required +AND spec.display_name = '{{ spec.display_name }}' +AND status.phase = '{{ status.phase }}' +AND spec.network = '{{ spec.network }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new peerings resource. + +## `INSERT` examples - + { label: 'create_networking_v1_peering', value: 'create_networking_v1_peering' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a peering. ```sql -/*+ create */ INSERT INTO confluent.networking.peerings ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: peerings props: - name: spec - props: - - name: environment - value: string - - name: network - value: string + description: | + The desired state of the Peering + value: + display_name: "{{ display_name }}" + cloud: + kind: "{{ kind }}" + account: "{{ account }}" + vpc: "{{ vpc }}" + routes: + - "{{ routes }}" + customer_region: "{{ customer_region }}" + project: "{{ project }}" + vpc_network: "{{ vpc_network }}" + import_custom_routes: {{ import_custom_routes }} + tenant: "{{ tenant }}" + vnet: "{{ vnet }}" + environment: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" + network: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" +`} -``` -## `UPDATE` example -Updates a peerings resource. +## `UPDATE` examples + + + + +Make a request to update a peering.

```sql -/*+ update */ UPDATE confluent.networking.peerings SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified peerings resource. +Make a request to delete a peering. ```sql -/*+ delete */ DELETE FROM confluent.networking.peerings -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/networking/private_link_accesses/index.md b/website/docs/services/networking/private_link_accesses/index.md index 83f9bf2..3de9a50 100644 --- a/website/docs/services/networking/private_link_accesses/index.md +++ b/website/docs/services/networking/private_link_accesses/index.md @@ -1,4 +1,4 @@ ---- +--- title: private_link_accesses hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,109 +23,384 @@ Creates, updates, deletes, gets or lists a private_link_accesses re ## Overview - +
Nameprivate_link_accesses
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Private Link Access | -| | `object` | The status of the Private Link Access | + +The following fields are returned by `SELECT` queries: + + + + +Private Link Access. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (PrivateLinkAccess)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Private Link Access
objectThe status of the Private Link Access
+ + + +Private Link Access. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (PrivateLinkAccess)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Private Link Access
objectThe status of the Private Link Access
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a private link access. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all private link accesses. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a private link access. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a private link access. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a private link access. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a private link access.
environmentspec.display_name, status.phase, spec.network, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all private link accesses.
specMake a request to create a private link access.
id, specMake a request to update a private link access.

environment, idMake a request to delete a private link access.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the private link access.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
arrayFilter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. (example: [prod-pl-use1, prod-pl-usw2])
arrayFilter the results by exact match for spec.network. Pass multiple times to see results matching any of the values. (example: [n-00000, n-00001])
arrayFilter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. (example: [PROVISIONING, READY])
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all private link accesses. + + + +Make a request to read a private link access. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.networking.private_link_accesses +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all private link accesses. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.networking.private_link_accesses -WHERE environment = '{{ environment }}'; +WHERE environment = '{{ environment }}' -- required +AND spec.display_name = '{{ spec.display_name }}' +AND status.phase = '{{ status.phase }}' +AND spec.network = '{{ spec.network }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new private_link_accesses resource. + +## `INSERT` examples - + { label: 'create_networking_v1_private_link_access', value: 'create_networking_v1_private_link_access' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a private link access. ```sql -/*+ create */ INSERT INTO confluent.networking.private_link_accesses ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: private_link_accesses props: - name: spec - props: - - name: environment - value: string - - name: network - value: string + description: | + The desired state of the Private Link Access + value: + display_name: "{{ display_name }}" + cloud: + kind: "{{ kind }}" + account: "{{ account }}" + subscription: "{{ subscription }}" + project: "{{ project }}" + environment: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" + network: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" +`} -``` -## `UPDATE` example -Updates a private_link_accesses resource. +## `UPDATE` examples + + + + +Make a request to update a private link access.

```sql -/*+ update */ UPDATE confluent.networking.private_link_accesses SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified private_link_accesses resource. +Make a request to delete a private link access. ```sql -/*+ delete */ DELETE FROM confluent.networking.private_link_accesses -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/networking/private_link_attachment_connections/index.md b/website/docs/services/networking/private_link_attachment_connections/index.md index 429b946..e2e8431 100644 --- a/website/docs/services/networking/private_link_attachment_connections/index.md +++ b/website/docs/services/networking/private_link_attachment_connections/index.md @@ -1,4 +1,4 @@ ---- +--- title: private_link_attachment_connections hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,109 +23,372 @@ Creates, updates, deletes, gets or lists a private_link_attachment_connect ## Overview - +
Nameprivate_link_attachment_connections
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Private Link Attachment Connection | -| | `object` | The status of the Private Link Attachment Connection | + +The following fields are returned by `SELECT` queries: + + + + +Private Link Attachment Connection. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (PrivateLinkAttachmentConnection)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Private Link Attachment Connection
objectThe status of the Private Link Attachment Connection
+ + + +Private Link Attachment Connection. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (PrivateLinkAttachmentConnection)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Private Link Attachment Connection
objectThe status of the Private Link Attachment Connection
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a private link attachment connection. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all private link attachment connections. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a private link attachment connection. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a private link attachment connection. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a private link attachment connection. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a private link attachment connection.
environmentspec.private_link_attachment, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all private link attachment connections.
specMake a request to create a private link attachment connection.
id, specMake a request to update a private link attachment connection.

environment, idMake a request to delete a private link attachment connection.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the private link attachment connection.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all private link attachment connections. + + + +Make a request to read a private link attachment connection. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.networking.private_link_attachment_connections +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all private link attachment connections. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.networking.private_link_attachment_connections -WHERE environment = '{{ environment }}'; +WHERE environment = '{{ environment }}' -- required +AND spec.private_link_attachment = '{{ spec.private_link_attachment }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new private_link_attachment_connections resource. + +## `INSERT` examples - + { label: 'create_networking_v1_private_link_attachment_connection', value: 'create_networking_v1_private_link_attachment_connection' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a private link attachment connection. ```sql -/*+ create */ INSERT INTO confluent.networking.private_link_attachment_connections ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: private_link_attachment_connections props: - name: spec - props: - - name: environment - value: string - - name: private_link_attachment - value: string + description: | + The desired state of the Private Link Attachment Connection + value: + display_name: "{{ display_name }}" + cloud: + kind: "{{ kind }}" + vpc_endpoint_id: "{{ vpc_endpoint_id }}" + private_endpoint_resource_id: "{{ private_endpoint_resource_id }}" + private_service_connect_connection_id: "{{ private_service_connect_connection_id }}" + environment: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" + private_link_attachment: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" +`} -``` -## `UPDATE` example -Updates a private_link_attachment_connections resource. +## `UPDATE` examples + + + + +Make a request to update a private link attachment connection.

```sql -/*+ update */ UPDATE confluent.networking.private_link_attachment_connections SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified private_link_attachment_connections resource. +Make a request to delete a private link attachment connection. ```sql -/*+ delete */ DELETE FROM confluent.networking.private_link_attachment_connections -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/networking/private_link_attachments/index.md b/website/docs/services/networking/private_link_attachments/index.md index b582723..22c0fea 100644 --- a/website/docs/services/networking/private_link_attachments/index.md +++ b/website/docs/services/networking/private_link_attachments/index.md @@ -1,4 +1,4 @@ ---- +--- title: private_link_attachments hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,107 +23,380 @@ Creates, updates, deletes, gets or lists a private_link_attachments ## Overview - +
Nameprivate_link_attachments
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Private Link Attachment | -| | `object` | The status of the Private Link Attachment | + +The following fields are returned by `SELECT` queries: + + + + +Private Link Attachment. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (PrivateLinkAttachment)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Private Link Attachment
objectThe status of the Private Link Attachment
+ + + +Private Link Attachment. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (PrivateLinkAttachment)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Private Link Attachment
objectThe status of the Private Link Attachment
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a private link attachment. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all private link attachments. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a private link attachment. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a private link attachment. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a private link attachment. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a private link attachment.
environmentspec.display_name, spec.cloud, spec.region, status.phase, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all private link attachments.
specMake a request to create a private link attachment.
id, specMake a request to update a private link attachment.

environment, idMake a request to delete a private link attachment.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the private link attachment.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
arrayFilter the results by exact match for spec.cloud. Pass multiple times to see results matching any of the values. (example: [GCP, AWS])
arrayFilter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. (example: [prod-gcp-us-central1, prod-aws-useast1])
arrayFilter the results by exact match for spec.region. Pass multiple times to see results matching any of the values. (example: [us-central1, us-east-1])
arrayFilter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. (example: [PROVISIONING, READY])
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all private link attachments. + + + +Make a request to read a private link attachment. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.networking.private_link_attachments +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all private link attachments. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.networking.private_link_attachments -WHERE environment = '{{ environment }}'; +WHERE environment = '{{ environment }}' -- required +AND spec.display_name = '{{ spec.display_name }}' +AND spec.cloud = '{{ spec.cloud }}' +AND spec.region = '{{ spec.region }}' +AND status.phase = '{{ status.phase }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new private_link_attachments resource. + +## `INSERT` examples - + { label: 'create_networking_v1_private_link_attachment', value: 'create_networking_v1_private_link_attachment' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a private link attachment. ```sql -/*+ create */ INSERT INTO confluent.networking.private_link_attachments ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: private_link_attachments props: - name: spec - props: - - name: environment - value: string + description: | + The desired state of the Private Link Attachment + value: + display_name: "{{ display_name }}" + cloud: "{{ cloud }}" + region: "{{ region }}" + environment: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" +`} -``` -## `UPDATE` example -Updates a private_link_attachments resource. +## `UPDATE` examples + + + + +Make a request to update a private link attachment.

```sql -/*+ update */ UPDATE confluent.networking.private_link_attachments SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified private_link_attachments resource. +Make a request to delete a private link attachment. ```sql -/*+ delete */ DELETE FROM confluent.networking.private_link_attachments -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/networking/transit_gateway_attachments/index.md b/website/docs/services/networking/transit_gateway_attachments/index.md index 25bade6..22ed0a9 100644 --- a/website/docs/services/networking/transit_gateway_attachments/index.md +++ b/website/docs/services/networking/transit_gateway_attachments/index.md @@ -1,4 +1,4 @@ ---- +--- title: transit_gateway_attachments hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,109 +23,385 @@ Creates, updates, deletes, gets or lists a transit_gateway_attachments -Nametransit_gateway_attachments +Name TypeResource Id ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Transit Gateway Attachment | -| | `object` | The status of the Transit Gateway Attachment | + +The following fields are returned by `SELECT` queries: + + + + +Transit Gateway Attachment. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (TransitGatewayAttachment)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Transit Gateway Attachment
objectThe status of the Transit Gateway Attachment
+ + + +Transit Gateway Attachment. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (networking/v1)
stringKind defines the object this REST resource represents. (TransitGatewayAttachment)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Transit Gateway Attachment
objectThe status of the Transit Gateway Attachment
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a transit gateway attachment. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all transit gateway attachments. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a transit gateway attachment. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a transit gateway attachment. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a transit gateway attachment. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a transit gateway attachment.
environmentspec.display_name, status.phase, spec.network, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all transit gateway attachments.
specMake a request to create a transit gateway attachment.
id, specMake a request to update a transit gateway attachment.

environment, idMake a request to delete a transit gateway attachment.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the transit gateway attachment.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
arrayFilter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. (example: [prod-tgw-use1, prod-tgw-usw2])
arrayFilter the results by exact match for spec.network. Pass multiple times to see results matching any of the values. (example: [n-00000, n-00001])
arrayFilter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. (example: [PROVISIONING, READY])
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all transit gateway attachments. + + + +Make a request to read a transit gateway attachment. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.networking.transit_gateway_attachments +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all transit gateway attachments. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.networking.transit_gateway_attachments -WHERE environment = '{{ environment }}'; +WHERE environment = '{{ environment }}' -- required +AND spec.display_name = '{{ spec.display_name }}' +AND status.phase = '{{ status.phase }}' +AND spec.network = '{{ spec.network }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new transit_gateway_attachments resource. + +## `INSERT` examples - + { label: 'create_networking_v1_transit_gateway_attachment', value: 'create_networking_v1_transit_gateway_attachment' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a transit gateway attachment. ```sql -/*+ create */ INSERT INTO confluent.networking.transit_gateway_attachments ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: transit_gateway_attachments props: - name: spec - props: - - name: environment - value: string - - name: network - value: string + description: | + The desired state of the Transit Gateway Attachment + value: + display_name: "{{ display_name }}" + cloud: + kind: "{{ kind }}" + ram_share_arn: "{{ ram_share_arn }}" + transit_gateway_id: "{{ transit_gateway_id }}" + routes: + - "{{ routes }}" + environment: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" + network: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" +`} -``` -## `UPDATE` example -Updates a transit_gateway_attachments resource. +## `UPDATE` examples + + + + +Make a request to update a transit gateway attachment.

```sql -/*+ update */ UPDATE confluent.networking.transit_gateway_attachments SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified transit_gateway_attachments resource. +Make a request to delete a transit gateway attachment. ```sql -/*+ delete */ DELETE FROM confluent.networking.transit_gateway_attachments -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/notifications/index.md b/website/docs/services/notifications/index.md index 22cd04f..f1dd137 100644 --- a/website/docs/services/notifications/index.md +++ b/website/docs/services/notifications/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png notifications service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 3
-
-
+total resources: __5__ ::: @@ -30,9 +26,11 @@ notifications service documentation.
integrations
-notification_types +notification_types
+resource_preferences
+resource_subscriptions
subscriptions
\ No newline at end of file diff --git a/website/docs/services/notifications/integrations/index.md b/website/docs/services/notifications/integrations/index.md index a27088b..9f3b5c7 100644 --- a/website/docs/services/notifications/integrations/index.md +++ b/website/docs/services/notifications/integrations/index.md @@ -1,4 +1,4 @@ ---- +--- title: integrations hide_title: false hide_table_of_contents: false @@ -15,141 +15,414 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a integrations resource. +Creates, updates, deletes, gets or lists an integrations resource. ## Overview - +
Nameintegrations
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | A human readable description for the particular integration | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | A human readable name for the particular integration | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `` | Integration-specific details (integration targets) | + +The following fields are returned by `SELECT` queries: + + + + +Integration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringA human readable name for the particular integration (example: Slack integration)
stringAPIVersion defines the schema version of this representation of a resource. (notifications/v1)
stringA human readable description for the particular integration (example: A Slack channel integration)
stringKind defines the object this REST resource represents. (Integration)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectIntegration-specific details (integration targets)
+ + + +Integration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringA human readable name for the particular integration (example: Slack integration)
stringAPIVersion defines the schema version of this representation of a resource. (notifications/v1)
stringA human readable description for the particular integration (example: A Slack channel integration)
stringKind defines the object this REST resource represents. (Integration)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectIntegration-specific details (integration targets)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read an integration. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all integrations. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create an integration. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete an integration. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update an integration. | -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Sends a test notification to validate the integration. This is supported only for Webhook, Slack and MsTeams targets | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read an integration.
page_size, page_tokenRetrieve a sorted, filtered, paginated list of all integrations.
display_name, targetMake a request to create an integration.
idMake a request to update an integration.

idMake a request to delete an integration.
display_name, targetSends a test notification to validate the integration. This is supported only for Webhook, Slack
and MsTeams targets
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the integration.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all integrations. + + +Make a request to read an integration. ```sql SELECT id, -description, -api_version, display_name, +api_version, +description, kind, metadata, target FROM confluent.notifications.integrations +WHERE id = '{{ id }}' -- required ; ``` -## `INSERT` example - -Use the following StackQL query and manifest file to create a new integrations resource. + + - - +Retrieve a sorted, filtered, paginated list of all integrations. ```sql -/*+ create */ -INSERT INTO confluent.notifications.integrations ( -data__display_name, -data__description, -data__target -) -SELECT -'{{ display_name }}', -'{{ description }}', -'{{ target }}' +SELECT +id, +display_name, +api_version, +description, +kind, +metadata, +target +FROM confluent.notifications.integrations +WHERE page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` + + + +## `INSERT` examples + + + - +Make a request to create an integration. ```sql -/*+ create */ INSERT INTO confluent.notifications.integrations ( -data__display_name, -data__target +display_name, +description, +target ) SELECT -'{{ display_name }}', -'{{ target }}' +'{{ display_name }}' /* required */, +'{{ description }}', +'{{ target }}' /* required */ +RETURNING +id, +display_name, +api_version, +description, +kind, +metadata, +target ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: integrations props: - name: display_name - value: string + value: "{{ display_name }}" + description: | + A human readable name for the particular integration - name: description - value: string + value: "{{ description }}" + description: | + A human readable description for the particular integration - name: target - props: - - name: kind - value: string - - name: webhook_url - value: string + description: | + Integration-specific details (integration targets) + value: + kind: "{{ kind }}" + webhook_url: "{{ webhook_url }}" + role_name: "{{ role_name }}" + user: + id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + url: "{{ url }}" +`} -``` -## `UPDATE` example -Updates a integrations resource. +## `UPDATE` examples + + + + +Make a request to update an integration.

```sql -/*+ update */ UPDATE confluent.notifications.integrations SET display_name = '{{ display_name }}', description = '{{ description }}', target = '{{ target }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +RETURNING +id, +display_name, +api_version, +description, +kind, +metadata, +target; ``` + + -## `DELETE` example -Deletes the specified integrations resource. +## `DELETE` examples + + + + +Make a request to delete an integration. ```sql -/*+ delete */ DELETE FROM confluent.notifications.integrations -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Sends a test notification to validate the integration. This is supported only for Webhook, Slack
and MsTeams targets
+ +```sql +EXEC confluent.notifications.integrations.test_notifications_v1_integration +@@json= +'{ +"display_name": "{{ display_name }}", +"description": "{{ description }}", +"target": "{{ target }}" +}' +; ``` + + diff --git a/website/docs/services/notifications/notification_types/index.md b/website/docs/services/notifications/notification_types/index.md index cf7f8bb..f32dd5d 100644 --- a/website/docs/services/notifications/notification_types/index.md +++ b/website/docs/services/notifications/notification_types/index.md @@ -1,4 +1,4 @@ ---- +--- title: notification_types hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,48 +23,275 @@ Creates, updates, deletes, gets or lists a notification_types resou ## Overview - +
Namenotification_types
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | Human readable description of the notification type | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Represents the group with which the notification is associated. Notifications are grouped under certain categories for better organization. - BILLING_LICENSING: All billing, payments or licensing related notifications are grouped here. - SECURITY: All Confluent Cloud and Platform security related notifications are grouped here. - SERVICE: All Confluent services (eg. Kafka, Schema Registry, Connect etc.) related notifications are grouped here. - ACCOUNT: All Confluent account related notifications are grouped here. For example: Billing, payment or license related notifications are grouped in BILLING_LICENSING category. | -| | `string` | Human readable display name of the notification type | -| | `boolean` | Whether this notification is available to subscribe or not as per the user's current billing plan. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `string` | Severity indicates the impact of this notification. - CRITICAL: a high impact notification which needs immediate attention. - WARN: a warning notification which can be addressed now or later. - INFO: an informational notification. | -| | `string` | Indicates whether the notification is auto-subscribed and if the user can opt-out. - REQUIRED: the user is auto-subscribed to this notification and can't opt-out. - RECOMMENDED: the user is auto-subscribed to this notification and can opt-out. - OPTIONAL: the user is not auto-subscribed to this notification but can explicitly subscribe to it. | + +The following fields are returned by `SELECT` queries: + + + + +Notification Type. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringHuman readable display name of the notification type (example: Cluster Shrink)
stringAPIVersion defines the schema version of this representation of a resource. (notifications/v1)
stringRepresents the group with which the notification is associated. Notifications are grouped under certain categories for better organization. - BILLING_LICENSING: All billing, payments or licensing related notifications are grouped here. - SECURITY: All Confluent Cloud and Platform security related notifications are grouped here. - SERVICE: All Confluent services (eg. Kafka, Schema Registry, Connect etc.) related notifications are grouped here. - ACCOUNT: All Confluent account related notifications are grouped here. For example: Billing, payment or license related notifications are grouped in BILLING_LICENSING category. (example: BILLING_LICENSING)
stringHuman readable description of the notification type (example: Cluster shrink operation is completed)
booleanWhether this notification is available to subscribe or not as per the user's current billing plan.
stringKind defines the object this REST resource represents. (NotificationType)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringSeverity indicates the impact of this notification. - CRITICAL: a high impact notification which needs immediate attention. - WARN: a warning notification which can be addressed now or later. - INFO: an informational notification. (example: INFO)
stringIndicates whether the notification is auto-subscribed and if the user can opt-out. - REQUIRED: the user is auto-subscribed to this notification and can't opt-out. - RECOMMENDED: the user is auto-subscribed to this notification and can opt-out. - OPTIONAL: the user is not auto-subscribed to this notification but can explicitly subscribe to it. (example: REQUIRED)
+ + + +List of Notification Type. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringHuman readable display name of the notification type (example: Cluster Shrink)
stringAPIVersion defines the schema version of this representation of a resource. (notifications/v1)
stringRepresents the group with which the notification is associated. Notifications are grouped under certain categories for better organization. - BILLING_LICENSING: All billing, payments or licensing related notifications are grouped here. - SECURITY: All Confluent Cloud and Platform security related notifications are grouped here. - SERVICE: All Confluent services (eg. Kafka, Schema Registry, Connect etc.) related notifications are grouped here. - ACCOUNT: All Confluent account related notifications are grouped here. For example: Billing, payment or license related notifications are grouped in BILLING_LICENSING category. (example: BILLING_LICENSING)
stringHuman readable description of the notification type (example: Cluster shrink operation is completed)
booleanWhether this notification is available to subscribe or not as per the user's current billing plan.
stringKind defines the object this REST resource represents. (NotificationType)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringSeverity indicates the impact of this notification. - CRITICAL: a high impact notification which needs immediate attention. - WARN: a warning notification which can be addressed now or later. - INFO: an informational notification. (example: INFO)
stringIndicates whether the notification is auto-subscribed and if the user can opt-out. - REQUIRED: the user is auto-subscribed to this notification and can't opt-out. - RECOMMENDED: the user is auto-subscribed to this notification and can opt-out. - OPTIONAL: the user is not auto-subscribed to this notification but can explicitly subscribe to it. (example: REQUIRED)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a notification type. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all notification types. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a notification type.
resource_type, page_size, page_tokenMake a request to list_by_resource_type a notification type.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the notification type.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringConfluent Cloud resource type
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all notification types. + + +Make a request to read a notification type. ```sql SELECT id, -description, +display_name, api_version, category, +description, +is_included_in_plan, +kind, +metadata, +severity, +subscription_priority +FROM confluent.notifications.notification_types +WHERE id = '{{ id }}' -- required +; +``` + + + +Make a request to list_by_resource_type a notification type. + +```sql +SELECT +id, display_name, +api_version, +category, +description, is_included_in_plan, kind, metadata, severity, subscription_priority FROM confluent.notifications.notification_types +WHERE resource_type = '{{ resource_type }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; -``` \ No newline at end of file +``` + + diff --git a/website/docs/services/notifications/resource_preferences/index.md b/website/docs/services/notifications/resource_preferences/index.md new file mode 100644 index 0000000..0891f4e --- /dev/null +++ b/website/docs/services/notifications/resource_preferences/index.md @@ -0,0 +1,402 @@ +--- +title: resource_preferences +hide_title: false +hide_table_of_contents: false +keywords: + - resource_preferences + - notifications + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a resource_preferences resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Resource Preference. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (notifications/v1)
stringDenotes the state of the resource preference. When the resource preference is ENABLED, the user will receive notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not receive any notification for the resource. Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. (example: ENABLED)
stringKind defines the object this REST resource represents. (ResourcePreference)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringDenotes the Confluent Cloud resource definition. (example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector)
stringDenotes the Confluent Cloud resource type. (example: CONNECTOR)
+ + + +Resource Preference. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (notifications/v1)
stringDenotes the state of the resource preference. When the resource preference is ENABLED, the user will receive notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not receive any notification for the resource. Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. (example: ENABLED)
stringKind defines the object this REST resource represents. (ResourcePreference)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringDenotes the Confluent Cloud resource definition. (example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector)
stringDenotes the Confluent Cloud resource type. (example: CONNECTOR)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a resource preference.
resource, resource_typepage_size, page_tokenMake a request to read_by_filter a resource preference.
resource, resource_typeMake a request to create a resource preference.
idMake a request to update a resource preference.

idMake a request to delete a resource preference.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the resource preference.
stringConfluent Cloud resource definition
stringConfluent Cloud resource type
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
+ +## `SELECT` examples + + + + +Make a request to read a resource preference. + +```sql +SELECT +id, +api_version, +current_state, +kind, +metadata, +resource, +resource_type +FROM confluent.notifications.resource_preferences +WHERE id = '{{ id }}' -- required +; +``` + + + +Make a request to read_by_filter a resource preference. + +```sql +SELECT +id, +api_version, +current_state, +kind, +metadata, +resource, +resource_type +FROM confluent.notifications.resource_preferences +WHERE resource = '{{ resource }}' -- required +AND resource_type = '{{ resource_type }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples + + + + +Make a request to create a resource preference. + +```sql +INSERT INTO confluent.notifications.resource_preferences ( +resource, +resource_type, +current_state +) +SELECT +'{{ resource }}' /* required */, +'{{ resource_type }}' /* required */, +'{{ current_state }}' +RETURNING +id, +api_version, +current_state, +kind, +metadata, +resource, +resource_type +; +``` + + + +{`# Description fields are for documentation purposes +- name: resource_preferences + props: + - name: resource + value: "{{ resource }}" + description: | + Denotes the Confluent Cloud resource definition. + - name: resource_type + value: "{{ resource_type }}" + description: | + Denotes the Confluent Cloud resource type. + - name: current_state + value: "{{ current_state }}" + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for \`REQUIRED\` notification type even when it is DISABLED. +`} + + + + + +## `UPDATE` examples + + + + +Make a request to update a resource preference.

+ +```sql +UPDATE confluent.notifications.resource_preferences +SET +resource = '{{ resource }}', +resource_type = '{{ resource_type }}', +current_state = '{{ current_state }}' +WHERE +id = '{{ id }}' --required +RETURNING +id, +api_version, +current_state, +kind, +metadata, +resource, +resource_type; +``` + + + + +## `DELETE` examples + + + + +Make a request to delete a resource preference. + +```sql +DELETE FROM confluent.notifications.resource_preferences +WHERE id = '{{ id }}' --required +; +``` + + diff --git a/website/docs/services/notifications/resource_subscriptions/index.md b/website/docs/services/notifications/resource_subscriptions/index.md new file mode 100644 index 0000000..9f6853b --- /dev/null +++ b/website/docs/services/notifications/resource_subscriptions/index.md @@ -0,0 +1,450 @@ +--- +title: resource_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - resource_subscriptions + - notifications + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a resource_subscriptions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Resource Subscription. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (notifications/v1)
stringDenotes the state of the resource preference. When the resource preference is ENABLED, the user will receive notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not receive any notification for the resource. Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. (example: ENABLED)
arrayIntegrations to which notifications are to be sent.
stringKind defines the object this REST resource represents. (ResourceSubscription)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe type of notification to subscribe to.
stringDenotes the Confluent Cloud resource definition. (example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector)
stringDenotes the Confluent Cloud resource type. (example: CONNECTOR)
+ + + +List of ResourceSubscriptions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (notifications/v1)
stringDenotes the state of the resource preference. When the resource preference is ENABLED, the user will receive notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not receive any notification for the resource. Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED. (example: ENABLED)
arrayIntegrations to which notifications are to be sent.
stringKind defines the object this REST resource represents. (ResourceSubscription)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe type of notification to subscribe to.
stringDenotes the Confluent Cloud resource definition. (example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector)
stringDenotes the Confluent Cloud resource type. (example: CONNECTOR)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a resource subscription.
resource, resource_typepage_size, page_tokenMake a request to list_by_filter a resource subscription.
resource, resource_type, notification_type, integrationsMake a request to create a resource subscription.
idMake a request to update a resource subscription.

idMake a request to delete a resource subscription.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the resource subscription.
stringConfluent Cloud resource definition
stringConfluent Cloud resource type
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
+ +## `SELECT` examples + + + + +Make a request to read a resource subscription. + +```sql +SELECT +id, +api_version, +current_state, +integrations, +kind, +metadata, +notification_type, +resource, +resource_type +FROM confluent.notifications.resource_subscriptions +WHERE id = '{{ id }}' -- required +; +``` + + + +Make a request to list_by_filter a resource subscription. + +```sql +SELECT +id, +api_version, +current_state, +integrations, +kind, +metadata, +notification_type, +resource, +resource_type +FROM confluent.notifications.resource_subscriptions +WHERE resource = '{{ resource }}' -- required +AND resource_type = '{{ resource_type }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples + + + + +Make a request to create a resource subscription. + +```sql +INSERT INTO confluent.notifications.resource_subscriptions ( +resource, +resource_type, +current_state, +notification_type, +integrations +) +SELECT +'{{ resource }}' /* required */, +'{{ resource_type }}' /* required */, +'{{ current_state }}', +'{{ notification_type }}' /* required */, +'{{ integrations }}' /* required */ +RETURNING +id, +api_version, +current_state, +integrations, +kind, +metadata, +notification_type, +resource, +resource_type +; +``` + + + +{`# Description fields are for documentation purposes +- name: resource_subscriptions + props: + - name: resource + value: "{{ resource }}" + description: | + Denotes the Confluent Cloud resource definition. + - name: resource_type + value: "{{ resource_type }}" + description: | + Denotes the Confluent Cloud resource type. + - name: current_state + value: "{{ current_state }}" + description: | + Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive + notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not + receive any notification for the resource. + Note that, you will still receive notifications for \`REQUIRED\` notification type even when it is DISABLED. + - name: notification_type + description: | + The type of notification to subscribe to. + value: + id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + - name: integrations + description: | + Integrations to which notifications are to be sent. + value: + - id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} + + + + + +## `UPDATE` examples + + + + +Make a request to update a resource subscription.

+ +```sql +UPDATE confluent.notifications.resource_subscriptions +SET +resource = '{{ resource }}', +resource_type = '{{ resource_type }}', +current_state = '{{ current_state }}', +notification_type = '{{ notification_type }}', +integrations = '{{ integrations }}' +WHERE +id = '{{ id }}' --required +RETURNING +id, +api_version, +current_state, +integrations, +kind, +metadata, +notification_type, +resource, +resource_type; +``` + + + + +## `DELETE` examples + + + + +Make a request to delete a resource subscription. + +```sql +DELETE FROM confluent.notifications.resource_subscriptions +WHERE id = '{{ id }}' --required +; +``` + + diff --git a/website/docs/services/notifications/subscriptions/index.md b/website/docs/services/notifications/subscriptions/index.md index a4a95da..4b75e7a 100644 --- a/website/docs/services/notifications/subscriptions/index.md +++ b/website/docs/services/notifications/subscriptions/index.md @@ -1,4 +1,4 @@ ---- +--- title: subscriptions hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,35 +23,222 @@ Creates, updates, deletes, gets or lists a subscriptions resource. ## Overview - +
Namesubscriptions
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Denotes the state of the subscription. When the subscription is ENABLED, the user will receive notification on the configured Integrations. If the subscription is DISABLED, the user will not recieve any notification for the configured notification type. Note that, you cannot disable a subscription for `REQUIRED` notification type. | -| | `array` | Integrations to which notifications are to be sent. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The type of notification to subscribe to. | + +The following fields are returned by `SELECT` queries: + + + + +Subscription. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (notifications/v1)
stringDenotes the state of the subscription. When the subscription is ENABLED, the user will receive notification on the configured Integrations. If the subscription is DISABLED, the user will not recieve any notification for the configured notification type. Note that, you cannot disable a subscription for `REQUIRED` notification type. (example: ENABLED)
arrayIntegrations to which notifications are to be sent.
stringKind defines the object this REST resource represents. (Subscription)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe type of notification to subscribe to.
+ + + +Subscription. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (notifications/v1)
stringDenotes the state of the subscription. When the subscription is ENABLED, the user will receive notification on the configured Integrations. If the subscription is DISABLED, the user will not recieve any notification for the configured notification type. Note that, you cannot disable a subscription for `REQUIRED` notification type. (example: ENABLED)
arrayIntegrations to which notifications are to be sent.
stringKind defines the object this REST resource represents. (Subscription)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe type of notification to subscribe to.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a subscription. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all subscriptions. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a subscription. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a subscription. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a subscription. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a subscription.
page_size, page_tokenRetrieve a sorted, filtered, paginated list of all subscriptions.
notification_type, integrationsMake a request to create a subscription.
idMake a request to update a subscription.

idMake a request to delete a subscription.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the subscription.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all subscriptions. + + +Make a request to read a subscription. ```sql SELECT @@ -62,93 +250,147 @@ kind, metadata, notification_type FROM confluent.notifications.subscriptions +WHERE id = '{{ id }}' -- required ; ``` -## `INSERT` example - -Use the following StackQL query and manifest file to create a new subscriptions resource. + + - - +Retrieve a sorted, filtered, paginated list of all subscriptions. ```sql -/*+ create */ -INSERT INTO confluent.notifications.subscriptions ( -data__current_state, -data__notification_type, -data__integrations -) -SELECT -'{{ current_state }}', -'{{ notification_type }}', -'{{ integrations }}' +SELECT +id, +api_version, +current_state, +integrations, +kind, +metadata, +notification_type +FROM confluent.notifications.subscriptions +WHERE page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` + + + +## `INSERT` examples - + + + +Make a request to create a subscription. ```sql -/*+ create */ INSERT INTO confluent.notifications.subscriptions ( -data__notification_type, -data__integrations +current_state, +notification_type, +integrations ) SELECT -'{{ notification_type }}', -'{{ integrations }}' +'{{ current_state }}', +'{{ notification_type }}' /* required */, +'{{ integrations }}' /* required */ +RETURNING +id, +api_version, +current_state, +integrations, +kind, +metadata, +notification_type ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: subscriptions props: - name: current_state - value: string + value: "{{ current_state }}" + description: | + Denotes the state of the subscription. When the subscription is ENABLED, the user will receive + notification on the configured Integrations. If the subscription is DISABLED, the user will not + recieve any notification for the configured notification type. Note that, you cannot disable + a subscription for \`REQUIRED\` notification type. - name: notification_type - props: - - name: id - value: string + description: | + The type of notification to subscribe to. + value: + id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" - name: integrations - value: array - props: - - name: id - value: string + description: | + Integrations to which notifications are to be sent. + value: + - id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} -``` -## `UPDATE` example -Updates a subscriptions resource. +## `UPDATE` examples + + + + +Make a request to update a subscription.

```sql -/*+ update */ UPDATE confluent.notifications.subscriptions SET current_state = '{{ current_state }}', +notification_type = '{{ notification_type }}', integrations = '{{ integrations }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +RETURNING +id, +api_version, +current_state, +integrations, +kind, +metadata, +notification_type; ``` + + + -## `DELETE` example +## `DELETE` examples -Deletes the specified subscriptions resource. + + + +Make a request to delete a subscription. ```sql -/*+ delete */ DELETE FROM confluent.notifications.subscriptions -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/org/environments/index.md b/website/docs/services/org/environments/index.md index 156aa71..0a6e2d3 100644 --- a/website/docs/services/org/environments/index.md +++ b/website/docs/services/org/environments/index.md @@ -1,4 +1,4 @@ ---- +--- title: environments hide_title: false hide_table_of_contents: false @@ -15,182 +15,353 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a environments resource. +Creates, updates, deletes, gets or lists an environments resource. ## Overview - +
Nameenvironments
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + - - -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `text` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `text` | APIVersion defines the schema version of this representation of a resource. | -| | `text` | field from the parent object | -| | `text` | A human-readable name for the Environment | -| | `text` | Kind defines the object this REST resource represents. | -| | `text` | field from the parent object | -| | `text` | field from the parent object | -| | `text` | field from the parent object | -| | `text` | field from the parent object | + { label: 'get_org_v2_environment', value: 'get_org_v2_environment' }, + { label: 'list_org_v2_environments', value: 'list_org_v2_environments' } + ]} +> + + +Environment. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringA human-readable name for the Environment (example: prod-finance01)
stringAPIVersion defines the schema version of this representation of a resource. (org/v2)
stringKind defines the object this REST resource represents. (Environment)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectStream Governance configurations for the environment
+ + + +Environment. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringA human-readable name for the Environment (example: prod-finance01)
stringAPIVersion defines the schema version of this representation of a resource. (org/v2)
stringKind defines the object this REST resource represents. (Environment)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectStream Governance configurations for the environment
 - - -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | A human-readable name for the Environment | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | Stream Governance configurations for the environment | - + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read an environment. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all environments. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create an environment. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete an environment. If successful, this request will also recursively delete all of the environment's associated resources, including all Kafka clusters, connectors, etc. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update an environment. | -## `SELECT` examples +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read an environment.
page_size, page_tokenRetrieve a sorted, filtered, paginated list of all environments.
display_nameMake a request to create an environment.
idMake a request to update an environment.

idMake a request to delete an environment.

If successful, this request will also recursively delete all of the environment's associated resources,
including all Kafka clusters, connectors, etc.
+ +## Parameters -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all environments. +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the environment.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
+ +## `SELECT` examples - + { label: 'get_org_v2_environment', value: 'get_org_v2_environment' }, + { label: 'list_org_v2_environments', value: 'list_org_v2_environments' } + ]} +> + + +Make a request to read an environment. ```sql SELECT id, -api_version, -created_at, display_name, +api_version, kind, -resource_name, -self, -stream_governance_package, -updated_at -FROM confluent.org.vw_environments +metadata, +stream_governance_config +FROM confluent.org.environments +WHERE id = '{{ id }}' -- required ; ``` - + +Retrieve a sorted, filtered, paginated list of all environments. ```sql SELECT id, -api_version, display_name, +api_version, kind, metadata, stream_governance_config FROM confluent.org.environments +WHERE page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` - - + + -## `INSERT` example -Use the following StackQL query and manifest file to create a new environments resource. +## `INSERT` examples - - -```sql -/*+ create */ -INSERT INTO confluent.org.environments ( -data__display_name, -data__stream_governance_config -) -SELECT -'{{ display_name }}', -'{{ stream_governance_config }}' -; -``` - + { label: 'create_org_v2_environment', value: 'create_org_v2_environment' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + - +Make a request to create an environment. ```sql -/*+ create */ INSERT INTO confluent.org.environments ( -data__display_name +display_name, +stream_governance_config ) SELECT -'{{ display_name }}' +'{{ display_name }}' /* required */, +'{{ stream_governance_config }}' +RETURNING +id, +display_name, +api_version, +kind, +metadata, +stream_governance_config ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: environments props: - name: display_name - value: string + value: "{{ display_name }}" + description: | + A human-readable name for the Environment - name: stream_governance_config - props: - - name: package - value: string + description: | + Stream Governance configurations for the environment + value: + package: "{{ package }}" +`} -``` -## `UPDATE` example -Updates a environments resource. +## `UPDATE` examples + + + + +Make a request to update an environment.

```sql -/*+ update */ UPDATE confluent.org.environments SET display_name = '{{ display_name }}', stream_governance_config = '{{ stream_governance_config }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +RETURNING +id, +display_name, +api_version, +kind, +metadata, +stream_governance_config; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified environments resource. +Make a request to delete an environment.

If successful, this request will also recursively delete all of the environment's associated resources,
including all Kafka clusters, connectors, etc.
```sql -/*+ delete */ DELETE FROM confluent.org.environments -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/org/index.md b/website/docs/services/org/index.md index 51f6ce1..02195d5 100644 --- a/website/docs/services/org/index.md +++ b/website/docs/services/org/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png org service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 2
-
-
+total resources: __2__ ::: diff --git a/website/docs/services/org/organizations/index.md b/website/docs/services/org/organizations/index.md index 82acd85..4e582a3 100644 --- a/website/docs/services/org/organizations/index.md +++ b/website/docs/services/org/organizations/index.md @@ -1,4 +1,4 @@ ---- +--- title: organizations hide_title: false hide_table_of_contents: false @@ -15,112 +15,267 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a organizations resource. +Creates, updates, deletes, gets or lists an organizations resource. ## Overview - +
Nameorganizations
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + - - -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `text` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `text` | APIVersion defines the schema version of this representation of a resource. | -| | `text` | field from the parent object | -| | `text` | A human-readable name for the Organization | -| | `boolean` | The flag to toggle Just-In-Time user provisioning for SSO-enabled organization. Available for early access only. | -| | `text` | Kind defines the object this REST resource represents. | -| | `text` | field from the parent object | -| | `text` | field from the parent object | + { label: 'get_org_v2_organization', value: 'get_org_v2_organization' }, + { label: 'list_org_v2_organizations', value: 'list_org_v2_organizations' } + ]} +> + + +Organization. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringA human-readable name for the Organization (example: Finance Org, pattern: ^[^<>#%'*^`{|}~\"]{1,31}$)
stringAPIVersion defines the schema version of this representation of a resource. (org/v2)
booleanThe flag to toggle Just-In-Time user provisioning for SSO-enabled organization. Available for early access only.
stringKind defines the object this REST resource represents. (Organization)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+ + + +Organization. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringA human-readable name for the Organization (example: Finance Org, pattern: ^[^<>#%'*^`{|}~\"]{1,31}$)
stringAPIVersion defines the schema version of this representation of a resource. (org/v2)
booleanThe flag to toggle Just-In-Time user provisioning for SSO-enabled organization. Available for early access only.
stringKind defines the object this REST resource represents. (Organization)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
 - - -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | A human-readable name for the Organization | -| | `boolean` | The flag to toggle Just-In-Time user provisioning for SSO-enabled organization. Available for early access only. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | - + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read an organization. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all organizations. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update an organization. | -## `SELECT` examples +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read an organization.
page_size, page_tokenRetrieve a sorted, filtered, paginated list of all organizations.
idMake a request to update an organization.

+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all organizations. + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the organization.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
+ +## `SELECT` examples - + { label: 'get_org_v2_organization', value: 'get_org_v2_organization' }, + { label: 'list_org_v2_organizations', value: 'list_org_v2_organizations' } + ]} +> + + +Make a request to read an organization. ```sql SELECT id, -api_version, -created_at, display_name, +api_version, jit_enabled, kind, -resource_name, -updated_at -FROM confluent.org.vw_organizations +metadata +FROM confluent.org.organizations +WHERE id = '{{ id }}' -- required ; ``` - + +Retrieve a sorted, filtered, paginated list of all organizations. ```sql SELECT id, -api_version, display_name, +api_version, jit_enabled, kind, metadata FROM confluent.org.organizations +WHERE page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` - + + -## `UPDATE` example +## `UPDATE` examples -Updates a organizations resource. + + + +Make a request to update an organization.

```sql -/*+ update */ UPDATE confluent.org.organizations SET display_name = '{{ display_name }}', -jit_enabled = true|false +jit_enabled = {{ jit_enabled }} WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +RETURNING +id, +display_name, +api_version, +jit_enabled, +kind, +metadata; ``` + + diff --git a/website/docs/services/partner/entitlements/index.md b/website/docs/services/partner/entitlements/index.md index 36ceff6..9c4c1da 100644 --- a/website/docs/services/partner/entitlements/index.md +++ b/website/docs/services/partner/entitlements/index.md @@ -1,4 +1,4 @@ ---- +--- title: entitlements hide_title: false hide_table_of_contents: false @@ -15,141 +15,395 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a entitlements resource. +Creates, updates, deletes, gets or lists an entitlements resource. ## Overview - +
Nameentitlements
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | The name of the entitlement | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | The unique external ID of the entitlement (this should be unique to customer) | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The organization associated with this object. | -| | `string` | The plan ID the entitlement | -| | `string` | The product ID of the entitlement | -| | `string` | The resource ID of the entitlement | -| | `string` | The usage reporting ID of the entitlement (if usage reporting uses a different ID, otherwise, same as external_id) | + +The following fields are returned by `SELECT` queries: + + + + +Entitlement. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe name of the entitlement (example: Acme Prod Entitlement)
stringThe unique external ID of the entitlement (this should be unique to customer) (example: 1111-2222-3333-4444)
stringThe plan ID the entitlement (example: confluent-cloud-payg-prod)
stringThe product ID of the entitlement (example: confluent-cloud-kafka-service-azure)
stringThe resource ID of the entitlement (example: 1111-2222-3333-4444)
stringThe usage reporting ID of the entitlement (if usage reporting uses a different ID, otherwise, same as external_id) (example: 1111-2222-3333-4444)
stringAPIVersion defines the schema version of this representation of a resource. (partner/v2)
stringKind defines the object this REST resource represents. (Entitlement)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe organization associated with this object.
+ + + +Entitlement. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe name of the entitlement (example: Acme Prod Entitlement)
stringThe unique external ID of the entitlement (this should be unique to customer) (example: 1111-2222-3333-4444)
stringThe plan ID the entitlement (example: confluent-cloud-payg-prod)
stringThe product ID of the entitlement (example: confluent-cloud-kafka-service-azure)
stringThe resource ID of the entitlement (example: 1111-2222-3333-4444)
stringThe usage reporting ID of the entitlement (if usage reporting uses a different ID, otherwise, same as external_id) (example: 1111-2222-3333-4444)
stringAPIVersion defines the schema version of this representation of a resource. (partner/v2)
stringKind defines the object this REST resource represents. (Entitlement)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe organization associated with this object.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Make a request to read an entitlement. | -| | `SELECT` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Retrieve a sorted, filtered, paginated list of all entitlements. | -| | `INSERT` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Make a request to create an entitlement. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idorganization.id Make a request to read an entitlement.
organization.id, page_size, page_token Retrieve a sorted, filtered, paginated list of all entitlements.
external_id, name, plan_id, product_id Make a request to create an entitlement.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the entitlement.
stringFilter the results by exact match for organization.id. (example: b3a17773-05cc-4431-9560-433fb4613da8)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Retrieve a sorted, filtered, paginated list of all entitlements. + + + Make a request to read an entitlement. ```sql SELECT id, name, -api_version, external_id, +plan_id, +product_id, +resource_id, +usage_reporting_id, +api_version, kind, metadata, -organization, +organization +FROM confluent.partner.entitlements +WHERE id = '{{ id }}' -- required +AND organization.id = '{{ organization.id }}' +; +``` + + + + Retrieve a sorted, filtered, paginated list of all entitlements. + +```sql +SELECT +id, +name, +external_id, plan_id, product_id, resource_id, -usage_reporting_id +usage_reporting_id, +api_version, +kind, +metadata, +organization FROM confluent.partner.entitlements +WHERE organization.id = '{{ organization.id }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` -## `INSERT` example + + + -Use the following StackQL query and manifest file to create a new entitlements resource. +## `INSERT` examples - + { label: 'create_partner_v2_entitlement', value: 'create_partner_v2_entitlement' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + + Make a request to create an entitlement. ```sql -/*+ create */ INSERT INTO confluent.partner.entitlements ( -data__external_id, -data__name, -data__plan_id, -data__product_id, -data__usage_reporting_id, -data__resource_id, -data__organization +external_id, +name, +plan_id, +product_id, +usage_reporting_id, +resource_id, +organization ) SELECT -'{{ external_id }}', -'{{ name }}', -'{{ plan_id }}', -'{{ product_id }}', +'{{ external_id }}' /* required */, +'{{ name }}' /* required */, +'{{ plan_id }}' /* required */, +'{{ product_id }}' /* required */, '{{ usage_reporting_id }}', '{{ resource_id }}', '{{ organization }}' +RETURNING +id, +name, +external_id, +plan_id, +product_id, +resource_id, +usage_reporting_id, +api_version, +kind, +metadata, +organization ; ``` - - - -```sql -/*+ create */ -INSERT INTO confluent.partner.entitlements ( -data__external_id, -data__name, -data__plan_id, -data__product_id -) -SELECT -'{{ external_id }}', -'{{ name }}', -'{{ plan_id }}', -'{{ product_id }}' -; -``` - - -```yaml +{`# Description fields are for documentation purposes - name: entitlements props: - name: external_id - value: string + value: "{{ external_id }}" + description: | + The unique external ID of the entitlement (this should be unique to customer) - name: name - value: string + value: "{{ name }}" + description: | + The name of the entitlement - name: plan_id - value: string + value: "{{ plan_id }}" + description: | + The plan ID the entitlement - name: product_id - value: string + value: "{{ product_id }}" + description: | + The product ID of the entitlement - name: usage_reporting_id - value: string + value: "{{ usage_reporting_id }}" + description: | + The usage reporting ID of the entitlement (if usage reporting uses + a different ID, otherwise, same as external_id) - name: resource_id - value: string + value: "{{ resource_id }}" + description: | + The resource ID of the entitlement - name: organization - props: - - name: id - value: string - - name: environment - value: string + description: | + The organization associated with this object. + value: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" +`} -``` diff --git a/website/docs/services/partner/index.md b/website/docs/services/partner/index.md index 2d77db7..ed68a00 100644 --- a/website/docs/services/partner/index.md +++ b/website/docs/services/partner/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png partner service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 3
-
-
+total resources: __3__ ::: diff --git a/website/docs/services/partner/organizations/index.md b/website/docs/services/partner/organizations/index.md index 05cdc47..261b2ef 100644 --- a/website/docs/services/partner/organizations/index.md +++ b/website/docs/services/partner/organizations/index.md @@ -1,4 +1,4 @@ ---- +--- title: organizations hide_title: false hide_table_of_contents: false @@ -15,39 +15,227 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a organizations resource. +Creates, updates, deletes, gets or lists an organizations resource. ## Overview - +
Nameorganizations
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | The name of the organization | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `` | | -| | `string` | The login URL for the customer to access Confluent Cloud | + +The following fields are returned by `SELECT` queries: + + + + +Organization. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe name of the organization (example: Acme Organization, pattern: ^[^<>#%'*^`{|}~\"]{1,31}$)
stringAPIVersion defines the schema version of this representation of a resource. (partner/v2)
stringKind defines the object this REST resource represents. (Organization)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
object
string (uri)The login URL for the customer to access Confluent Cloud (example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn)
+ + + +Organization. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe name of the organization (example: Acme Organization, pattern: ^[^<>#%'*^`{|}~\"]{1,31}$)
stringAPIVersion defines the schema version of this representation of a resource. (partner/v2)
stringKind defines the object this REST resource represents. (Organization)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
object
string (uri)The login URL for the customer to access Confluent Cloud (example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Make a request to read an organization. | -| | `SELECT` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Retrieve a sorted, filtered, paginated list of all organizations. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id Make a request to read an organization.
page_size, page_token Retrieve a sorted, filtered, paginated list of all organizations.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the organization.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Retrieve a sorted, filtered, paginated list of all organizations. + + + + Make a request to read an organization. + +```sql +SELECT +id, +name, +api_version, +kind, +metadata, +sso_config, +sso_url +FROM confluent.partner.organizations +WHERE id = '{{ id }}' -- required +; +``` + + + Retrieve a sorted, filtered, paginated list of all organizations. ```sql SELECT @@ -59,5 +247,9 @@ metadata, sso_config, sso_url FROM confluent.partner.organizations +WHERE page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; -``` \ No newline at end of file +``` + + diff --git a/website/docs/services/partner/signups/index.md b/website/docs/services/partner/signups/index.md index 63b2c3c..86c05e4 100644 --- a/website/docs/services/partner/signups/index.md +++ b/website/docs/services/partner/signups/index.md @@ -1,4 +1,4 @@ ---- +--- title: signups hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,18 +23,132 @@ Creates, updates, deletes, gets or lists a signups resource. ## Overview - +
Namesignups
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + `SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `EXEC` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Creates a user in the organization previously created in `/partner/v2/signup`. This completes the signup process if you did not pass in user details to `/partner/v2/signup`. Calling this endpoint if the signup process has been completed will result in a `409 Conflict` error. | -| | `EXEC` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Create an organization for a customer. You must pass in either an entitlement object reference (a url to a previously created entitlement) or entitlement details. If you pass in an entitlement object reference, we will link with the created entitlement. If you pass in the entitlement details, we will create the entitlement with the organization in a single transaction. If you pass in user details (email, given name, and family name), we will create a user as well. If you do not pass in user details, you MUST call `/partner/v2/signup/activate` with user details to complete signup. | -| | `EXEC` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Partner v2](https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540)](mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Signup a customer by linking a new entitlement to an existing Confluent Cloud organization. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
organization, entitlementdry_run Create an organization for a customer. You must pass in either an entitlement object reference (a url to
a previously created entitlement) or entitlement details. If you pass in an entitlement object reference, we will link with the
created entitlement. If you pass in the entitlement details, we will create the entitlement with the organization
in a single transaction. If you pass in user details (email, given name, and family name), we will
create a user as well. If you do not pass in user details, you MUST call `/partner/v2/signup/activate`
with user details to complete signup.
user, organization_id Creates a user in the organization previously created in `/partner/v2/signup`. This completes the signup
process if you did not pass in user details to `/partner/v2/signup`. Calling this endpoint if the signup
process has been completed will result in a `409 Conflict` error.
token, organization, entitlementdry_run Signup a customer by linking a new entitlement to an existing Confluent Cloud organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanIf true, only perform validation of signup
+ +## Lifecycle Methods + + + + + Create an organization for a customer. You must pass in either an entitlement object reference (a url to
a previously created entitlement) or entitlement details. If you pass in an entitlement object reference, we will link with the
created entitlement. If you pass in the entitlement details, we will create the entitlement with the organization
in a single transaction. If you pass in user details (email, given name, and family name), we will
create a user as well. If you do not pass in user details, you MUST call `/partner/v2/signup/activate`
with user details to complete signup. + +```sql +EXEC confluent.partner.signups.signup +@dry_run={{ dry_run }} +@@json= +'{ +"organization": "{{ organization }}", +"user": "{{ user }}", +"entitlement": "{{ entitlement }}" +}' +; +``` + + + + Creates a user in the organization previously created in `/partner/v2/signup`. This completes the signup
process if you did not pass in user details to `/partner/v2/signup`. Calling this endpoint if the signup
process has been completed will result in a `409 Conflict` error. + +```sql +EXEC confluent.partner.signups.activate_signup +@@json= +'{ +"user": "{{ user }}", +"organization_id": "{{ organization_id }}" +}' +; +``` + + + + Signup a customer by linking a new entitlement to an existing Confluent Cloud organization. + +```sql +EXEC confluent.partner.signups.signup_partner_v2_link +@dry_run={{ dry_run }} +@@json= +'{ +"token": "{{ token }}", +"organization": "{{ organization }}", +"entitlement": "{{ entitlement }}" +}' +; +``` + + diff --git a/website/docs/services/pipelines/pipelines/index.md b/website/docs/services/pipelines/pipelines/index.md deleted file mode 100644 index 7cf6103..0000000 --- a/website/docs/services/pipelines/pipelines/index.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -title: pipelines -hide_title: false -hide_table_of_contents: false -keywords: - - pipelines - - pipelines - - confluent - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage confluent resources using SQL -custom_edit_url: null -image: /img/stackql-confluent-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a pipelines resource. - -## Overview - - - - -
Namepipelines
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Pipeline | -| | `object` | The status of the Pipeline | - -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a pipeline. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all pipelines. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a pipeline. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a pipeline. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a pipeline. | - -## `SELECT` examples - -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all pipelines. - - -```sql -SELECT -id, -_spec, -api_version, -kind, -metadata, -spec, -status -FROM confluent.pipelines.pipelines -WHERE environment = '{{ environment }}' -AND spec.kafka_cluster = '{{ spec.kafka_cluster }}'; -``` -## `INSERT` example - -Use the following StackQL query and manifest file to create a new pipelines resource. - - - - -```sql -/*+ create */ -INSERT INTO confluent.pipelines.pipelines ( -data__spec -) -SELECT -'{{ spec }}' -; -``` - - - - -```yaml -- name: pipelines - props: - - name: spec - props: - - name: environment - value: string - - name: kafka_cluster - value: string - -``` - - - -## `UPDATE` example - -Updates a pipelines resource. - -```sql -/*+ update */ -UPDATE confluent.pipelines.pipelines -SET -spec = '{{ spec }}' -WHERE -id = '{{ id }}'; -``` - -## `DELETE` example - -Deletes the specified pipelines resource. - -```sql -/*+ delete */ -DELETE FROM confluent.pipelines.pipelines -WHERE environment = '{{ environment }}' -AND id = '{{ id }}' -AND spec.kafka_cluster = '{{ spec.kafka_cluster }}'; -``` diff --git a/website/docs/services/provider_integrations/index.md b/website/docs/services/provider_integrations/index.md index 13c7bba..99c6360 100644 --- a/website/docs/services/provider_integrations/index.md +++ b/website/docs/services/provider_integrations/index.md @@ -16,22 +16,19 @@ image: /img/stackql-confluent-provider-featured-image.png provider_integrations service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 1
-
-
+total resources: __3__ ::: ## Resources
-integrations +integrations
+integrations_v1
- +integrations_v2
\ No newline at end of file diff --git a/website/docs/services/provider_integrations/integrations/index.md b/website/docs/services/provider_integrations/integrations/index.md index 1cb7085..1311c74 100644 --- a/website/docs/services/provider_integrations/integrations/index.md +++ b/website/docs/services/provider_integrations/integrations/index.md @@ -1,4 +1,4 @@ ---- +--- title: integrations hide_title: false hide_table_of_contents: false @@ -15,133 +15,137 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a integrations resource. +Creates, updates, deletes, gets or lists an integrations resource. ## Overview - +
Nameintegrations
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `object` | Cloud provider specific configs for provider integration | -| | `string` | Display name of Provider Integration. | -| | `object` | The environment to which this belongs. | -| | `string` | Kind defines the object this REST resource represents. | -| | `string` | Cloud provider to which access is provided through provider integration. | -| | `array` | List of resource crns where this integration is being used. | + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v1-early-access@confluent.io?subject=Request%20to%20join%20pim/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Make a request to read an integration. | -| | `SELECT` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v1-early-access@confluent.io?subject=Request%20to%20join%20pim/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Retrieve a sorted, filtered, paginated list of all integrations. If no `provider` filter is specified, returns provider integrations from all clouds. | -| | `INSERT` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v1-early-access@confluent.io?subject=Request%20to%20join%20pim/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Make a request to create an integration. | -| | `DELETE` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v1-early-access@confluent.io?subject=Request%20to%20join%20pim/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Make a request to delete an integration. This request fails if existing workloads are using this CSP integration. | -## `SELECT` examples +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
id, environment Make a request to update an integration.

This request only works for integrations with `DRAFT` status.


id, environment Validate the provider integration configuration.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the integration.
+ +## `UPDATE` examples -[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Provider Integration](https://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540)](mailto:ccloud-api-access+pim-v1-early-access@confluent.io?subject=Request%20to%20join%20pim/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Retrieve a sorted, filtered, paginated list of all integrations. If no `provider` filter is specified, returns provider integrations from all clouds. + + + Make a request to update an integration.

This request only works for integrations with `DRAFT` status.


```sql -SELECT +UPDATE confluent.provider_integrations.integrations +SET +display_name = '{{ display_name }}', +provider = '{{ provider }}', +config = '{{ config }}', +environment = '{{ environment }}' +WHERE +id = '{{ id }}' --required +AND environment = '{{ environment }}' --required +RETURNING id, -_environment, +display_name, api_version, config, -display_name, environment, kind, provider, -usages -FROM confluent.provider_integrations.integrations -WHERE environment = '{{ environment }}'; +status, +usages; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new integrations resource. + +## Lifecycle Methods - + { label: 'validate_pim_v2_integration', value: 'validate_pim_v2_integration' } + ]} +> + -```sql -/*+ create */ -INSERT INTO confluent.provider_integrations.integrations ( -data__display_name, -data__provider, -data__config, -data__environment -) -SELECT -'{{ display_name }}', -'{{ provider }}', -'{{ config }}', -'{{ environment }}' -; -``` - - - + Validate the provider integration configuration.
```sql -/*+ create */ -INSERT INTO confluent.provider_integrations.integrations ( -data__config, -data__environment -) -SELECT -'{{ config }}', -'{{ environment }}' +EXEC confluent.provider_integrations.integrations.validate_pim_v2_integration +@@json= +'{ +"id": "{{ id }}", +"config": "{{ config }}", +"environment": "{{ environment }}" +}' ; ``` - - - -```yaml -- name: integrations - props: - - name: display_name - value: string - - name: provider - value: string - - name: config - props: - - name: customer_iam_role_arn - value: string - - name: kind - value: string - - name: environment - value: string - -``` - - -## `DELETE` example - -Deletes the specified integrations resource. - -```sql -/*+ delete */ -DELETE FROM confluent.provider_integrations.integrations -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; -``` diff --git a/website/docs/services/provider_integrations/integrations_v1/index.md b/website/docs/services/provider_integrations/integrations_v1/index.md new file mode 100644 index 0000000..e9e04aa --- /dev/null +++ b/website/docs/services/provider_integrations/integrations_v1/index.md @@ -0,0 +1,388 @@ +--- +title: integrations_v1 +hide_title: false +hide_table_of_contents: false +keywords: + - integrations_v1 + - provider_integrations + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an integrations_v1 resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Integration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringDisplay name of Provider Integration. (example: s3_provider_integration)
stringAPIVersion defines the schema version of this representation of a resource. (pim/v1)
objectCloud provider specific configs for provider integration
objectThe environment to which this belongs. (x-immutable: true')
stringKind defines the object this REST resource represents. (Integration)
stringCloud provider to which access is provided through provider integration. (example: AWS, default: AWS)
arrayList of resource crns where this integration is being used.
+ + + +Integration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringDisplay name of Provider Integration. (example: s3_provider_integration)
stringAPIVersion defines the schema version of this representation of a resource. (pim/v1)
objectCloud provider specific configs for provider integration
objectThe environment to which this belongs. (x-immutable: true')
stringKind defines the object this REST resource represents. (Integration)
stringCloud provider to which access is provided through provider integration. (example: AWS, default: AWS)
arrayList of resource crns where this integration is being used.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read an integration.
environmentprovider, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all integrations.

If no `provider` filter is specified, returns provider integrations from all clouds.
config, environmentMake a request to create an integration.
environment, idMake a request to delete an integration.

This request fails if existing workloads are using this CSP integration.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the integration.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for provider. (example: AWS)
+ +## `SELECT` examples + + + + +Make a request to read an integration. + +```sql +SELECT +id, +display_name, +api_version, +config, +environment, +kind, +provider, +usages +FROM confluent.provider_integrations.integrations_v1 +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all integrations.

If no `provider` filter is specified, returns provider integrations from all clouds.
+ +```sql +SELECT +id, +display_name, +api_version, +config, +environment, +kind, +provider, +usages +FROM confluent.provider_integrations.integrations_v1 +WHERE environment = '{{ environment }}' -- required +AND provider = '{{ provider }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples + + + + +Make a request to create an integration. + +```sql +INSERT INTO confluent.provider_integrations.integrations_v1 ( +display_name, +provider, +config, +environment +) +SELECT +'{{ display_name }}', +'{{ provider }}', +'{{ config }}' /* required */, +'{{ environment }}' /* required */ +RETURNING +id, +display_name, +api_version, +config, +environment, +kind, +provider, +usages +; +``` + + + +{`# Description fields are for documentation purposes +- name: integrations_v1 + props: + - name: display_name + value: "{{ display_name }}" + description: | + Display name of Provider Integration. + - name: provider + value: "{{ provider }}" + description: | + Cloud provider to which access is provided through provider integration. + default: AWS + - name: config + description: | + Cloud provider specific configs for provider integration + value: + iam_role_arn: "{{ iam_role_arn }}" + external_id: "{{ external_id }}" + customer_iam_role_arn: "{{ customer_iam_role_arn }}" + kind: "{{ kind }}" + - name: environment + description: | + The environment to which this belongs. + value: + id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} + + + + + +## `DELETE` examples + + + + +Make a request to delete an integration.

This request fails if existing workloads are using this CSP integration.
+ +```sql +DELETE FROM confluent.provider_integrations.integrations_v1 +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; +``` + + diff --git a/website/docs/services/provider_integrations/integrations_v2/index.md b/website/docs/services/provider_integrations/integrations_v2/index.md new file mode 100644 index 0000000..a8b1223 --- /dev/null +++ b/website/docs/services/provider_integrations/integrations_v2/index.md @@ -0,0 +1,421 @@ +--- +title: integrations_v2 +hide_title: false +hide_table_of_contents: false +keywords: + - integrations_v2 + - provider_integrations + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an integrations_v2 resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Integration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringDisplay name of Provider Integration. (example: bigquery_provider_integration)
stringAPIVersion defines the schema version of this representation of a resource. (pim/v2)
objectCloud provider specific configuration for the provider integration. Required only when updating integrations with `DRAFT` status. Not required during creation.
objectThe environment to which this belongs.
stringKind defines the object this REST resource represents. (Integration)
stringCloud provider to which access is provided through provider integration. (example: GCP, default: GCP)
stringStatus of the provider integration. - `DRAFT`: Integration exists but is not associated with customer configuration - `CREATED`: Integration has been associated with customer configuration - `ACTIVE`: Integration is in use by Confluent resources (example: CREATED)
arrayList of resource crns where this integration is being used.
+ + + +Integration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringDisplay name of Provider Integration. (example: bigquery_provider_integration)
stringAPIVersion defines the schema version of this representation of a resource. (pim/v2)
objectCloud provider specific configuration for the provider integration. Required only when updating integrations with `DRAFT` status. Not required during creation.
objectThe environment to which this belongs.
stringKind defines the object this REST resource represents. (Integration)
stringCloud provider to which access is provided through provider integration. (example: GCP, default: GCP)
stringStatus of the provider integration. - `DRAFT`: Integration exists but is not associated with customer configuration - `CREATED`: Integration has been associated with customer configuration - `ACTIVE`: Integration is in use by Confluent resources (example: CREATED)
arrayList of resource crns where this integration is being used.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, id Make a request to read an integration.
environmentdisplay_name, provider, status, page_size, page_token Retrieve a sorted, filtered, paginated list of all integrations.

If no `provider` filter is specified, returns provider integrations from all clouds.
environment Make a request to create an integration.
environment, id Make a request to delete an integration.

This request fails if existing workloads are using this CSP integration.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the integration.
stringFilter the results by a partial search of display_name. (example: bigquery_provider_integration)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for provider. (example: GCP)
stringFilter the results by exact match for status. (example: CREATED)
+ +## `SELECT` examples + + + + + Make a request to read an integration. + +```sql +SELECT +id, +display_name, +api_version, +config, +environment, +kind, +provider, +status, +usages +FROM confluent.provider_integrations.integrations_v2 +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + + + Retrieve a sorted, filtered, paginated list of all integrations.

If no `provider` filter is specified, returns provider integrations from all clouds.
+ +```sql +SELECT +id, +display_name, +api_version, +config, +environment, +kind, +provider, +status, +usages +FROM confluent.provider_integrations.integrations_v2 +WHERE environment = '{{ environment }}' -- required +AND display_name = '{{ display_name }}' +AND provider = '{{ provider }}' +AND status = '{{ status }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples + + + + + Make a request to create an integration. + +```sql +INSERT INTO confluent.provider_integrations.integrations_v2 ( +display_name, +provider, +config, +environment +) +SELECT +'{{ display_name }}', +'{{ provider }}', +'{{ config }}', +'{{ environment }}' /* required */ +RETURNING +id, +display_name, +api_version, +config, +environment, +kind, +provider, +status, +usages +; +``` + + + +{`# Description fields are for documentation purposes +- name: integrations_v2 + props: + - name: display_name + value: "{{ display_name }}" + description: | + Display name of Provider Integration. + - name: provider + value: "{{ provider }}" + description: | + Cloud provider to which access is provided through provider integration. + default: GCP + - name: config + description: | + Cloud provider specific configuration for the provider integration. + Required only when updating integrations with \`DRAFT\` status. Not required during creation. + value: + google_service_account: "{{ google_service_account }}" + customer_google_service_account: "{{ customer_google_service_account }}" + kind: "{{ kind }}" + confluent_multi_tenant_app_id: "{{ confluent_multi_tenant_app_id }}" + customer_azure_tenant_id: "{{ customer_azure_tenant_id }}" + iam_role_arn: "{{ iam_role_arn }}" + external_id: "{{ external_id }}" + customer_iam_role_arn: "{{ customer_iam_role_arn }}" + - name: environment + description: | + The environment to which this belongs. + value: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + api_version: "{{ api_version }}" + kind: "{{ kind }}" +`} + + + + + +## `DELETE` examples + + + + + Make a request to delete an integration.

This request fails if existing workloads are using this CSP integration.
+ +```sql +DELETE FROM confluent.provider_integrations.integrations_v2 +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; +``` + + diff --git a/website/docs/services/quotas/applied_quotas/index.md b/website/docs/services/quotas/applied_quotas/index.md index 16c434a..4edbe62 100644 --- a/website/docs/services/quotas/applied_quotas/index.md +++ b/website/docs/services/quotas/applied_quotas/index.md @@ -1,4 +1,4 @@ ---- +--- title: applied_quotas hide_title: false hide_table_of_contents: false @@ -15,64 +15,340 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a applied_quotas resource. +Creates, updates, deletes, gets or lists an applied_quotas resource. ## Overview - +
Nameapplied_quotas
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `` | | -| | `` | | -| | `` | | -| | `` | | -| | `` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `integer` | The latest applied service quota value, taking into account any limit adjustments. | -| | `integer` | The default service quota value. | -| | `string` | A human-readable name for the quota type name. | -| | `object` | The environment ID the quota is associated with. | -| | `object` | The kafka cluster ID the quota is associated with. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The network ID the quota is associated with. | -| | `object` | A unique organization id to associate a specific organization to this quota. | -| | `string` | The applied scope that this quota belongs to. | -| | `integer` | Show the quota usage value if the quota usage is available for this quota. | -| | `object` | The user associated with this object. | + +The following fields are returned by `SELECT` queries: + + + + +Applied Quota. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringA human-readable name for the quota type name. (example: Kafka Cluster Per Organization)
stringAPIVersion defines the schema version of this representation of a resource. (service-quota/v1)
integer (int32)The latest applied service quota value, taking into account any limit adjustments.
integer (int32)The default service quota value.
objectThe environment ID the quota is associated with.
objectThe kafka cluster ID the quota is associated with.
stringKind defines the object this REST resource represents. (AppliedQuota)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe network ID the quota is associated with.
objectA unique organization id to associate a specific organization to this quota.
stringThe applied scope that this quota belongs to. (example: ORGANIZATION)
integer (int32)Show the quota usage value if the quota usage is available for this quota.
objectThe user associated with this object.
+ + + +Applied Quota. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringA human-readable name for the quota type name. (example: Kafka Cluster Per Organization)
stringAPIVersion defines the schema version of this representation of a resource. (service-quota/v1)
integer (int32)The latest applied service quota value, taking into account any limit adjustments.
integer (int32)The default service quota value.
objectThe environment ID the quota is associated with.
objectThe kafka cluster ID the quota is associated with.
stringKind defines the object this REST resource represents. (AppliedQuota)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe network ID the quota is associated with.
objectA unique organization id to associate a specific organization to this quota.
stringThe applied scope that this quota belongs to. (example: ORGANIZATION)
integer (int32)Show the quota usage value if the quota usage is available for this quota.
objectThe user associated with this object.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read an applied quota. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all applied quotas. Shows all quotas for a given scope. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idenvironment, network, kafka_clusterMake a request to read an applied quota.
scopeenvironment, network, kafka_cluster, id, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all applied quotas.

Shows all quotas for a given scope.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the applied quota.
stringThe applied scope the quota belongs to. (example: ORGANIZATION)
stringThe environment ID the quota is associated with. (example: env-00000)
stringThe id (quota code) that this quota belongs to. (example: iam.max_environments.per_org)
stringThe kafka cluster ID the quota is associated with. (example: lkc-00000)
stringThe network ID the quota is associated with. (example: n-12034)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read an applied quota. + + +Make a request to read an applied quota. ```sql SELECT id, -_environment, -_kafka_cluster, -_network, -_organization, -_user, +display_name, api_version, applied_limit, default_limit, +environment, +kafka_cluster, +kind, +metadata, +network, +organization, +scope, +usage, +user +FROM confluent.quotas.applied_quotas +WHERE id = '{{ id }}' -- required +AND environment = '{{ environment }}' +AND network = '{{ network }}' +AND kafka_cluster = '{{ kafka_cluster }}' +; +``` + + + +Retrieve a sorted, filtered, paginated list of all applied quotas.

Shows all quotas for a given scope.
+ +```sql +SELECT +id, display_name, +api_version, +applied_limit, +default_limit, environment, kafka_cluster, kind, @@ -83,5 +359,14 @@ scope, usage, user FROM confluent.quotas.applied_quotas -WHERE id = '{{ id }}'; -``` \ No newline at end of file +WHERE scope = '{{ scope }}' -- required +AND environment = '{{ environment }}' +AND network = '{{ network }}' +AND kafka_cluster = '{{ kafka_cluster }}' +AND id = '{{ id }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + diff --git a/website/docs/services/quotas/client_quotas/index.md b/website/docs/services/quotas/client_quotas/index.md index f03d782..08b4e59 100644 --- a/website/docs/services/quotas/client_quotas/index.md +++ b/website/docs/services/quotas/client_quotas/index.md @@ -1,4 +1,4 @@ ---- +--- title: client_quotas hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,106 +23,332 @@ Creates, updates, deletes, gets or lists a client_quotas resource. ## Overview - +
Nameclient_quotas
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Client Quota | + +The following fields are returned by `SELECT` queries: + + + + +Client Quota. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (kafka-quotas/v1)
stringKind defines the object this REST resource represents. (ClientQuota)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Client Quota
+ + + +Client Quota. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (kafka-quotas/v1)
stringKind defines the object this REST resource represents. (ClientQuota)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Client Quota
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a client quota. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all client quotas. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a client quota. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a client quota. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a client quota. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a client quota.
spec.cluster, environmentpage_size, page_tokenRetrieve a sorted, filtered, paginated list of all client quotas.
Make a request to create a client quota.
id, specMake a request to update a client quota.

idMake a request to delete a client quota.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringFilter the results by exact match for environment. (example: env-xxxxx)
stringThe unique identifier for the client quota.
stringFilter the results by exact match for spec.cluster. (example: lkc-xxxxx)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a client quota. + + +Make a request to read a client quota. ```sql SELECT id, -_spec, api_version, kind, metadata, spec FROM confluent.quotas.client_quotas -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' -- required +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new client_quotas resource. +Retrieve a sorted, filtered, paginated list of all client quotas. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec +FROM confluent.quotas.client_quotas +WHERE spec.cluster = '{{ spec.cluster }}' -- required +AND environment = '{{ environment }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples - + { label: 'create_kafka_quotas_v1_client_quota', value: 'create_kafka_quotas_v1_client_quota' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a client quota. ```sql -/*+ create */ INSERT INTO confluent.quotas.client_quotas ( -data__spec + ) SELECT -'{{ spec }}' + +RETURNING +id, +api_version, +kind, +metadata, +spec ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: client_quotas props: - - name: spec - props: - - name: cluster - value: string - - name: environment - value: string +`} -``` -## `UPDATE` example -Updates a client_quotas resource. +## `UPDATE` examples + + + + +Make a request to update a client quota.

```sql -/*+ update */ UPDATE confluent.quotas.client_quotas SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec; ``` + + -## `DELETE` example -Deletes the specified client_quotas resource. +## `DELETE` examples + + + + +Make a request to delete a client quota. ```sql -/*+ delete */ DELETE FROM confluent.quotas.client_quotas -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/quotas/index.md b/website/docs/services/quotas/index.md index a3dd12e..2a16f3c 100644 --- a/website/docs/services/quotas/index.md +++ b/website/docs/services/quotas/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png quotas service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 3
-
-
+total resources: __3__ ::: diff --git a/website/docs/services/quotas/scopes/index.md b/website/docs/services/quotas/scopes/index.md index a0885b5..e081d32 100644 --- a/website/docs/services/quotas/scopes/index.md +++ b/website/docs/services/quotas/scopes/index.md @@ -1,4 +1,4 @@ ---- +--- title: scopes hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,38 +23,209 @@ Creates, updates, deletes, gets or lists a scopes resource. ## Overview - +
Namescopes
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | the quota scope for listing quotas queries | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | + +The following fields are returned by `SELECT` queries: + + + + +Scope. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (service-quota/v1)
stringthe quota scope for listing quotas queries (example: ORGANIZATION scope that quotas would be applied to)
stringKind defines the object this REST resource represents. (Scope)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+ + + +Scope. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (service-quota/v1)
stringthe quota scope for listing quotas queries (example: ORGANIZATION scope that quotas would be applied to)
stringKind defines the object this REST resource represents. (Scope)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a scope. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all scopes. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a scope.
page_size, page_tokenRetrieve a sorted, filtered, paginated list of all scopes.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the scope.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all scopes. + + +Make a request to read a scope. ```sql SELECT id, +api_version, description, +kind, +metadata +FROM confluent.quotas.scopes +WHERE id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all scopes. + +```sql +SELECT +id, api_version, +description, kind, metadata FROM confluent.quotas.scopes +WHERE page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; -``` \ No newline at end of file +``` + + diff --git a/website/docs/services/schema_registry/cluster_config/index.md b/website/docs/services/schema_registry/cluster_config/index.md index 50f81e8..0b5aafd 100644 --- a/website/docs/services/schema_registry/cluster_config/index.md +++ b/website/docs/services/schema_registry/cluster_config/index.md @@ -1,4 +1,4 @@ ---- +--- title: cluster_config hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,26 +23,101 @@ Creates, updates, deletes, gets or lists a cluster_config resource. ## Overview - +
Namecluster_config
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Maximum number of allowed requests per second | -| | `integer` | Maximum number of registered schemas allowed | + +The following fields are returned by `SELECT` queries: + + + + +The cluster config + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int32)Maximum number of allowed requests per second
integer (int32)Maximum number of registered schemas allowed
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieves cluster config information. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Retrieves cluster config information.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -Retrieves cluster config information. + + +Retrieves cluster config information. ```sql SELECT @@ -49,4 +125,6 @@ maxRequestsPerSec, maxSchemas FROM confluent.schema_registry.cluster_config ; -``` \ No newline at end of file +``` + + diff --git a/website/docs/services/schema_registry/compatibilities/index.md b/website/docs/services/schema_registry/compatibilities/index.md index 02ed03a..0118e9c 100644 --- a/website/docs/services/schema_registry/compatibilities/index.md +++ b/website/docs/services/schema_registry/compatibilities/index.md @@ -1,4 +1,4 @@ ---- +--- title: compatibilities hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,17 +23,143 @@ Creates, updates, deletes, gets or lists a compatibilities resource ## Overview - +
Namecompatibilities
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + `SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `EXEC` | | Test input schema against a particular version of a subject's schema for compatibility. The compatibility level applied for the check is the configured compatibility level for the subject (http:get:: /config/(string: subject)). If this subject's compatibility level was never changed, then the global compatibility level applies (http:get:: /config). | -| | `EXEC` | | Test input schema against a subject's schemas for compatibility, based on the configured compatibility level of the subject. In other words, it will perform the same compatibility check as register for that subject. The compatibility level applied for the check is the configured compatibility level for the subject (http:get:: /config/(string: subject)). If this subject's compatibility level was never changed, then the global compatibility level applies (http:get:: /config). | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
subject, versionnormalize, verboseTest input schema against a particular version of a subject's schema for compatibility. The compatibility level applied for the check is the configured compatibility level for the subject (http:get:: /config/(string: subject)). If this subject's compatibility level was never changed, then the global compatibility level applies (http:get:: /config).
subjectverboseTest input schema against a subject's schemas for compatibility, based on the configured compatibility level of the subject. In other words, it will perform the same compatibility check as register for that subject. The compatibility level applied for the check is the configured compatibility level for the subject (http:get:: /config/(string: subject)). If this subject's compatibility level was never changed, then the global compatibility level applies (http:get:: /config).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSubject of the schema version against which compatibility is to be tested
stringVersion of the subject's schema against which compatibility is to be tested. Valid values for versionId are between [1,2^31-1] or the string "latest"."latest" checks compatibility of the input schema with the last registered schema under the specified subject
booleanWhether to normalize the given schema
booleanWhether to return detailed error messages
+ +## Lifecycle Methods + + + + +Test input schema against a particular version of a subject's schema for compatibility. The compatibility level applied for the check is the configured compatibility level for the subject (http:get:: /config/(string: subject)). If this subject's compatibility level was never changed, then the global compatibility level applies (http:get:: /config). + +```sql +EXEC confluent.schema_registry.compatibilities.test_compatibility_by_subject_name +@subject='{{ subject }}' --required, +@version='{{ version }}' --required, +@normalize={{ normalize }}, +@verbose={{ verbose }} +@@json= +'{ +"version": {{ version }}, +"id": {{ id }}, +"schemaType": "{{ schemaType }}", +"references": "{{ references }}", +"schema": "{{ schema }}", +"metadata": "{{ metadata }}", +"ruleSet": "{{ ruleSet }}", +"schemaTagsToAdd": "{{ schemaTagsToAdd }}", +"schemaTagsToRemove": "{{ schemaTagsToRemove }}", +"propagateSchemaTags": {{ propagateSchemaTags }} +}' +; +``` + + + +Test input schema against a subject's schemas for compatibility, based on the configured compatibility level of the subject. In other words, it will perform the same compatibility check as register for that subject. The compatibility level applied for the check is the configured compatibility level for the subject (http:get:: /config/(string: subject)). If this subject's compatibility level was never changed, then the global compatibility level applies (http:get:: /config). + +```sql +EXEC confluent.schema_registry.compatibilities.test_compatibility_for_subject +@subject='{{ subject }}' --required, +@verbose={{ verbose }} +@@json= +'{ +"version": {{ version }}, +"id": {{ id }}, +"schemaType": "{{ schemaType }}", +"references": "{{ references }}", +"schema": "{{ schema }}", +"metadata": "{{ metadata }}", +"ruleSet": "{{ ruleSet }}", +"schemaTagsToAdd": "{{ schemaTagsToAdd }}", +"schemaTagsToRemove": "{{ schemaTagsToRemove }}", +"propagateSchemaTags": {{ propagateSchemaTags }} +}' +; +``` + + diff --git a/website/docs/services/schema_registry/contexts/index.md b/website/docs/services/schema_registry/contexts/index.md index 98fffae..9f9f554 100644 --- a/website/docs/services/schema_registry/contexts/index.md +++ b/website/docs/services/schema_registry/contexts/index.md @@ -1,4 +1,4 @@ ---- +--- title: contexts hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,29 +23,109 @@ Creates, updates, deletes, gets or lists a contexts resource. ## Overview - +
Namecontexts
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +The contexts. + + + + + + + + + + + +
NameDatatypeDescription
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieves a list of contexts. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
offset, limitRetrieves a list of contexts.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int32)Pagination size for results. Ignored if negative
integer (int32)Pagination offset for results
## `SELECT` examples -Retrieves a list of contexts. + + +Retrieves a list of contexts. ```sql SELECT -column_anon +* FROM confluent.schema_registry.contexts +WHERE offset = '{{ offset }}' +AND limit = '{{ limit }}' ; -``` \ No newline at end of file +``` + + diff --git a/website/docs/services/schema_registry/exporter_configs/index.md b/website/docs/services/schema_registry/exporter_configs/index.md index 45197f6..b00ab6b 100644 --- a/website/docs/services/schema_registry/exporter_configs/index.md +++ b/website/docs/services/schema_registry/exporter_configs/index.md @@ -1,4 +1,4 @@ ---- +--- title: exporter_configs hide_title: false hide_table_of_contents: false @@ -15,35 +15,126 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a exporter_configs resource. +Creates, updates, deletes, gets or lists an exporter_configs resource. ## Overview - +
Nameexporter_configs
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | Config SR Auth | -| | `string` | Config SR User Info | -| | `string` | Config SR URL | + +The following fields are returned by `SELECT` queries: + + + + +The original request + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringConfig SR Auth (example: USER_INFO)
stringConfig SR User Info
stringConfig SR URL (example: <Physical SR Endpoint>)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieves the config of the schema exporter. | -| | `EXEC` | | Retrieves the config of the schema exporter. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
nameRetrieves the config of the schema exporter.
nameUpdates the configuration of the schema exporter.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the exporter
## `SELECT` examples -Retrieves the config of the schema exporter. + + +Retrieves the config of the schema exporter. ```sql SELECT @@ -51,5 +142,35 @@ basic.auth.credentials.source, basic.auth.user.info, schema.registry.url FROM confluent.schema_registry.exporter_configs -WHERE name = '{{ name }}'; -``` \ No newline at end of file +WHERE name = '{{ name }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Updates the configuration of the schema exporter. + +```sql +REPLACE confluent.schema_registry.exporter_configs +SET +schema.registry.url = '{{ schema.registry.url }}', +basic.auth.credentials.source = '{{ basic.auth.credentials.source }}', +basic.auth.user.info = '{{ basic.auth.user.info }}' +WHERE +name = '{{ name }}' --required +RETURNING +name; +``` + + diff --git a/website/docs/services/schema_registry/exporter_status/index.md b/website/docs/services/schema_registry/exporter_status/index.md index 8a8f98a..9a818cf 100644 --- a/website/docs/services/schema_registry/exporter_status/index.md +++ b/website/docs/services/schema_registry/exporter_status/index.md @@ -1,4 +1,4 @@ ---- +--- title: exporter_status hide_title: false hide_table_of_contents: false @@ -15,36 +15,129 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a exporter_status resource. +Creates, updates, deletes, gets or lists an exporter_status resource. ## Overview - +
Nameexporter_status
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | Name of exporter. | -| | `integer` | Offset of the exporter | -| | `string` | State of the exporter. Could be STARTING, RUNNING or PAUSED | -| | `string` | Error trace of the exporter | -| | `integer` | Timestamp of the exporter | + +The following fields are returned by `SELECT` queries: + + + + +The original request. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of exporter. (example: test-exporter)
integer (int64)Offset of the exporter
stringState of the exporter. Could be STARTING, RUNNING or PAUSED (example: RUNNING)
stringError trace of the exporter (example: )
integer (int64)Timestamp of the exporter
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieves the status of the schema exporter. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
nameRetrieves the status of the schema exporter.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the exporter
## `SELECT` examples -Retrieves the status of the schema exporter. + + +Retrieves the status of the schema exporter. ```sql SELECT @@ -54,5 +147,8 @@ state, trace, ts FROM confluent.schema_registry.exporter_status -WHERE name = '{{ name }}'; -``` \ No newline at end of file +WHERE name = '{{ name }}' -- required +; +``` + + diff --git a/website/docs/services/schema_registry/exporters/index.md b/website/docs/services/schema_registry/exporters/index.md index f5e3943..ab4f8de 100644 --- a/website/docs/services/schema_registry/exporters/index.md +++ b/website/docs/services/schema_registry/exporters/index.md @@ -1,4 +1,4 @@ ---- +--- title: exporters hide_title: false hide_table_of_contents: false @@ -15,44 +15,206 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a exporters resource. +Creates, updates, deletes, gets or lists an exporters resource. ## Overview - +
Nameexporters
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | Name of the exporter | -| | `object` | The map containing exporter’s configurations | -| | `string` | Customized context of the exporter if contextType equals CUSTOM. | -| | `string` | Context type of the exporter. One of CUSTOM, NONE or AUTO (default) | -| | `string` | Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders. | -| | `array` | Name of each exporter subject | + +The following fields are returned by `SELECT` queries: + + + + +The original request. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the exporter (example: test-exporter)
objectThe map containing exporter's configurations
stringCustomized context of the exporter if contextType equals CUSTOM. (example: User)
stringContext type of the exporter. One of CUSTOM, NONE or AUTO (default) (example: CUSTOM)
stringFormat string for the KEK name in the destination cluster, which may contain ${kek} as a placeholder for the originating KEK name. For example, dc_${kek} for the KEK aws_key will map to the destination KEK name dc_aws_key.
stringFormat string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.
arrayName of each exporter subject
+ + + +Name of the exporter + + + + + + + + + + + +
NameDatatypeDescription
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieves the information of the schema exporter. | -| | `DELETE` | | Deletes the schema exporter. | -| | `EXEC` | | Retrieves a list of schema exporters that have been created. | -| | `EXEC` | | Pauses the state of the schema exporter. | -| | `EXEC` | | Creates a new schema exporter. All attributes in request body are optional except config. | -| | `EXEC` | | Reset the state of the schema exporter. | -| | `EXEC` | | Resume running of the schema exporter. | -| | `EXEC` | | Updates the information or configurations of the schema exporter. All attributes in request body are optional. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
nameRetrieves the information of the schema exporter.
Retrieves a list of schema exporters that have been created.
Creates a new schema exporter. All attributes in request body are optional except config.
nameUpdates the information or configurations of the schema exporter. All attributes in request body are optional.
nameDeletes the schema exporter.
namePauses the state of the schema exporter.
nameReset the state of the schema exporter.
nameResume running of the schema exporter.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the exporter
## `SELECT` examples -Retrieves the information of the schema exporter. + + +Retrieves the information of the schema exporter. ```sql SELECT @@ -60,17 +222,193 @@ name, config, context, contextType, +kekRenameFormat, subjectRenameFormat, subjects FROM confluent.schema_registry.exporters -WHERE name = '{{ name }}'; +WHERE name = '{{ name }}' -- required +; +``` + + + +Retrieves a list of schema exporters that have been created. + +```sql +SELECT +* +FROM confluent.schema_registry.exporters +; +``` + + + + +## `INSERT` examples + + + + +Creates a new schema exporter. All attributes in request body are optional except config. + +```sql +INSERT INTO confluent.schema_registry.exporters ( +name, +contextType, +context, +subjects, +kekRenameFormat, +subjectRenameFormat, +config +) +SELECT +'{{ name }}', +'{{ contextType }}', +'{{ context }}', +'{{ subjects }}', +'{{ kekRenameFormat }}', +'{{ subjectRenameFormat }}', +'{{ config }}' +RETURNING +name +; ``` -## `DELETE` example + + + +{`# Description fields are for documentation purposes +- name: exporters + props: + - name: name + value: "{{ name }}" + description: | + Name of the exporter + - name: contextType + value: "{{ contextType }}" + description: | + Context type of the exporter. One of CUSTOM, NONE or AUTO (default) + - name: context + value: "{{ context }}" + description: | + Customized context of the exporter if contextType equals CUSTOM. + - name: subjects + value: + - "{{ subjects }}" + description: | + Name of each exporter subject + - name: kekRenameFormat + value: "{{ kekRenameFormat }}" + description: | + Format string for the KEK name in the destination cluster, which may contain \${kek} as a placeholder for the originating KEK name. For example, dc_\${kek} for the KEK aws_key will map to the destination KEK name dc_aws_key. + - name: subjectRenameFormat + value: "{{ subjectRenameFormat }}" + description: | + Format string for the subject name in the destination cluster, which may contain \${subject} as a placeholder for the originating subject name. For example, dc_\${subject} for the subject orders will map to the destination subject name dc_orders. + - name: config + value: "{{ config }}" + description: | + The map containing exporter's configurations +`} + + + -Deletes the specified exporters resource. + +## `REPLACE` examples + + + + +Updates the information or configurations of the schema exporter. All attributes in request body are optional. + +```sql +REPLACE confluent.schema_registry.exporters +SET +contextType = '{{ contextType }}', +context = '{{ context }}', +subjects = '{{ subjects }}', +kekRenameFormat = '{{ kekRenameFormat }}', +subjectRenameFormat = '{{ subjectRenameFormat }}', +config = '{{ config }}' +WHERE +name = '{{ name }}' --required +RETURNING +name; +``` + + + + +## `DELETE` examples + + + + +Deletes the schema exporter. ```sql -/*+ delete */ DELETE FROM confluent.schema_registry.exporters -WHERE name = '{{ name }}'; +WHERE name = '{{ name }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Pauses the state of the schema exporter. + +```sql +EXEC confluent.schema_registry.exporters.pause_exporter_by_name +@name='{{ name }}' --required +; +``` + + + +Reset the state of the schema exporter. + +```sql +EXEC confluent.schema_registry.exporters.reset_exporter_by_name +@name='{{ name }}' --required +; +``` + + + +Resume running of the schema exporter. + +```sql +EXEC confluent.schema_registry.exporters.resume_exporter_by_name +@name='{{ name }}' --required +; ``` + + diff --git a/website/docs/services/schema_registry/index.md b/website/docs/services/schema_registry/index.md index f9e517d..21522d7 100644 --- a/website/docs/services/schema_registry/index.md +++ b/website/docs/services/schema_registry/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png schema_registry service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 14
-
-
+total resources: __15__ ::: @@ -35,13 +31,14 @@ schema_registry service documentation. exporter_configs
exporter_status
exporters
+latest_version
modes
-schema_subjects
schemas
subject_level_config
subjects
+subjects_referenced_by
top_level_config
types
versions diff --git a/website/docs/services/schema_registry/latest_version/index.md b/website/docs/services/schema_registry/latest_version/index.md new file mode 100644 index 0000000..78c2601 --- /dev/null +++ b/website/docs/services/schema_registry/latest_version/index.md @@ -0,0 +1,202 @@ +--- +title: latest_version +hide_title: false +hide_table_of_contents: false +keywords: + - latest_version + - schema_registry + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a latest_version resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The schema. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int32)Globally unique identifier of the schema
objectUser-defined metadata
arrayReferences to other schemas
objectSchema rule set
stringSchema definition string (example: {"schema": "{"type": "string"}"})
arraySchema tags
stringSchema type (example: AVRO)
stringName of the subject (example: User)
integer (int32)Version number
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
subjectkey, value, format, deletedRetrieve the latest version with the given metadata.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSubject under which the schema will be registered
booleanWhether to lookup deleted schemas
stringDesired output format, dependent on schema type. For AVRO schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, valid values are: " " (default), "ignore_extensions", or "serialized" (The parameter does not apply to JSON schemas.)
stringThe metadata key. Add "?key=key" at the end of the request to match a metadata key. This query parameter can appear multiple times. Each instance is matched with a corresponding value query parameter, in order.
stringThe metadata value. Add "?value=value" at the end of the request to match a metadata value. This query parameter can appear multiple times. Each instance is matched with a corresponding key query parameter, in order.
+ +## `SELECT` examples + + + + +Retrieve the latest version with the given metadata. + +```sql +SELECT +id, +metadata, +references, +ruleSet, +schema, +schemaTags, +schemaType, +subject, +version +FROM confluent.schema_registry.latest_version +WHERE subject = '{{ subject }}' -- required +AND key = '{{ key }}' +AND value = '{{ value }}' +AND format = '{{ format }}' +AND deleted = '{{ deleted }}' +; +``` + + diff --git a/website/docs/services/schema_registry/modes/index.md b/website/docs/services/schema_registry/modes/index.md index 2f09913..59d3742 100644 --- a/website/docs/services/schema_registry/modes/index.md +++ b/website/docs/services/schema_registry/modes/index.md @@ -1,4 +1,4 @@ ---- +--- title: modes hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,42 +23,243 @@ Creates, updates, deletes, gets or lists a modes resource. ## Overview - +
Namemodes
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | Schema Registry operating mode | + +The following fields are returned by `SELECT` queries: + + + + +The subject mode. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSchema Registry operating mode (example: READWRITE)
+ + + +The global mode + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSchema Registry operating mode (example: READWRITE)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieves the subject mode. | -| | `SELECT` | | Retrieves global mode. | -| | `DELETE` | | Deletes the specified subject-level mode and reverts to the global default. | -| | `EXEC` | | Update mode for the specified subject. On success, echoes the original request back to the client. | -| | `EXEC` | | Update global mode. On success, echoes the original request back to the client. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
subjectdefaultToGlobalRetrieves the subject mode.
Retrieves global mode.
subjectforceUpdate mode for the specified subject. On success, echoes the original request back to the client.
forceUpdate global mode. On success, echoes the original request back to the client.
subjectDeletes the specified subject-level mode and reverts to the global default.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the subject
booleanWhether to return the global mode if subject mode not found
booleanWhether to force update if setting mode to IMPORT and schemas currently exist
## `SELECT` examples -Retrieves global mode. + + +Retrieves the subject mode. ```sql SELECT mode FROM confluent.schema_registry.modes +WHERE subject = '{{ subject }}' -- required +AND defaultToGlobal = '{{ defaultToGlobal }}' ; ``` -## `DELETE` example + + -Deletes the specified modes resource. +Retrieves global mode. + +```sql +SELECT +mode +FROM confluent.schema_registry.modes +; +``` + + + + +## `REPLACE` examples + + + + +Update mode for the specified subject. On success, echoes the original request back to the client. + +```sql +REPLACE confluent.schema_registry.modes +SET +mode = '{{ mode }}' +WHERE +subject = '{{ subject }}' --required +AND force = {{ force}} +RETURNING +mode; +``` + + + +Update global mode. On success, echoes the original request back to the client. + +```sql +REPLACE confluent.schema_registry.modes +SET +mode = '{{ mode }}' +WHERE +force = {{ force}} +RETURNING +mode; +``` + + + + +## `DELETE` examples + + + + +Deletes the specified subject-level mode and reverts to the global default. ```sql -/*+ delete */ DELETE FROM confluent.schema_registry.modes -WHERE subject = '{{ subject }}'; +WHERE subject = '{{ subject }}' --required +; ``` + + diff --git a/website/docs/services/schema_registry/schema_subjects/index.md b/website/docs/services/schema_registry/schema_subjects/index.md deleted file mode 100644 index 0c5dfed..0000000 --- a/website/docs/services/schema_registry/schema_subjects/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: schema_subjects -hide_title: false -hide_table_of_contents: false -keywords: - - schema_subjects - - schema_registry - - confluent - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage confluent resources using SQL -custom_edit_url: null -image: /img/stackql-confluent-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a schema_subjects resource. - -## Overview - - - - -
Nameschema_subjects
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | - -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieves all the subjects associated with a particular schema ID. | - -## `SELECT` examples - -Retrieves all the subjects associated with a particular schema ID. - - -```sql -SELECT -column_anon -FROM confluent.schema_registry.schema_subjects -WHERE id = '{{ id }}'; -``` \ No newline at end of file diff --git a/website/docs/services/schema_registry/schemas/index.md b/website/docs/services/schema_registry/schemas/index.md index 6177705..98eaa7b 100644 --- a/website/docs/services/schema_registry/schemas/index.md +++ b/website/docs/services/schema_registry/schemas/index.md @@ -1,4 +1,4 @@ ---- +--- title: schemas hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,37 +23,347 @@ Creates, updates, deletes, gets or lists a schemas resource. ## Overview - +
Nameschemas
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Maximum ID | -| | `array` | References to other schemas | -| | `string` | Schema string identified by the ID | -| | `string` | Schema type | + +The following fields are returned by `SELECT` queries: + + + + +The schema string. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int32)Maximum ID
objectUser-defined metadata
arrayReferences to other schemas
objectSchema rule set
stringSchema string identified by the ID (example: {"schema": "{"type": "string"}"})
arraySchema tags
stringSchema type (example: AVRO)
+ + + +List of schemas matching the specified parameters. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int32)Globally unique identifier of the schema
objectUser-defined metadata
arrayReferences to other schemas
objectSchema rule set
stringSchema definition string (example: {"schema": "{"type": "string"}"})
arraySchema tags
stringSchema type (example: AVRO)
stringName of the subject (example: User)
integer (int32)Version number
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieves the schema string identified by the input ID. | -| | `SELECT` | | Get the schemas matching the specified parameters. | -| | `EXEC` | | Retrieves the schema identified by the input ID. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idsubject, formatRetrieves the schema string identified by the input ID.
subjectPrefix, aliases, deleted, latestOnly, ruleType, offset, limitGet the schemas matching the specified parameters.
idsubject, formatRetrieves the schema identified by the input ID.
subject, versiondeletedRetrieves the schema for the specified version of this subject. Only the unescaped schema string is returned.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int32)Globally unique identifier of the schema
stringName of the subject
stringVersion of the schema to be returned. Valid values for versionId are between [1,2^31-1] or the string "latest". "latest" returns the last registered schema under the specified subject. Note that there may be a new latest schema that gets registered right after this request is served.
booleanWhether to include aliases in the search
booleanWhether to include deleted schema
stringDesired output format, dependent on schema type. For AVRO schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, valid values are: " " (default), "ignore_extensions", or "serialized" (The parameter does not apply to JSON schemas.)
booleanWhether to return latest schema versions only for each matching subject
integer (int32)Pagination size for results. Ignored if negative
integer (int32)Pagination offset for results
stringFilters results by the given rule type
stringName of the subject
stringFilters results by the respective subject prefix
## `SELECT` examples -Get the schemas matching the specified parameters. + + +Retrieves the schema string identified by the input ID. ```sql SELECT maxId, +metadata, references, +ruleSet, schema, +schemaTags, schemaType FROM confluent.schema_registry.schemas +WHERE id = '{{ id }}' -- required +AND subject = '{{ subject }}' +AND format = '{{ format }}' +; +``` + + + +Get the schemas matching the specified parameters. + +```sql +SELECT +id, +metadata, +references, +ruleSet, +schema, +schemaTags, +schemaType, +subject, +version +FROM confluent.schema_registry.schemas +WHERE subjectPrefix = '{{ subjectPrefix }}' +AND aliases = '{{ aliases }}' +AND deleted = '{{ deleted }}' +AND latestOnly = '{{ latestOnly }}' +AND ruleType = '{{ ruleType }}' +AND offset = '{{ offset }}' +AND limit = '{{ limit }}' +; +``` + + + + +## Lifecycle Methods + + + + +Retrieves the schema identified by the input ID. + +```sql +EXEC confluent.schema_registry.schemas.get_schema_only +@id='{{ id }}' --required, +@subject='{{ subject }}', +@format='{{ format }}' +; +``` + + + +Retrieves the schema for the specified version of this subject. Only the unescaped schema string is returned. + +```sql +EXEC confluent.schema_registry.schemas.get_schema_only_1 +@subject='{{ subject }}' --required, +@version='{{ version }}' --required, +@deleted={{ deleted }} ; -``` \ No newline at end of file +``` + + diff --git a/website/docs/services/schema_registry/subject_level_config/index.md b/website/docs/services/schema_registry/subject_level_config/index.md index 24b0b24..1568495 100644 --- a/website/docs/services/schema_registry/subject_level_config/index.md +++ b/website/docs/services/schema_registry/subject_level_config/index.md @@ -1,4 +1,4 @@ ---- +--- title: subject_level_config hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,34 +23,155 @@ Creates, updates, deletes, gets or lists a subject_level_config res ## Overview - +
Namesubject_level_config
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | If alias is specified, then this subject is an alias for the subject named by the alias. That means that any reference to this subject will be replaced by the alias. | -| | `string` | Only schemas that belong to the same compatibility group will be checked for compatibility. | -| | `string` | Compatibility Level | -| | `object` | Default value for the metadata to be used during schema registration. | -| | `object` | Default value for the ruleSet to be used during schema registration. | -| | `boolean` | If true, then schemas are automatically normalized when registered or when passed during lookups. This means that clients do not have to pass the "normalize" query parameter to have normalization occur. | -| | `object` | Override value for the metadata to be used during schema registration. | -| | `object` | Override value for the ruleSet to be used during schema registration. | + +The following fields are returned by `SELECT` queries: + + + + +The subject compatibility level. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringIf alias is specified, then this subject is an alias for the subject named by the alias. That means that any reference to this subject will be replaced by the alias.
stringOnly schemas that belong to the same compatibility group will be checked for compatibility.
stringCompatibility Level (example: FULL_TRANSITIVE)
objectDefault value for the metadata to be used during schema registration.
objectDefault value for the ruleSet to be used during schema registration.
booleanIf true, then schemas are automatically normalized when registered or when passed during lookups. This means that clients do not have to pass the "normalize" query parameter to have normalization occur.
objectOverride value for the metadata to be used during schema registration.
objectOverride value for the ruleSet to be used during schema registration.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieves compatibility level, compatibility group, normalization, default metadata, and rule set for a subject. | -| | `DELETE` | | Deletes the specified subject-level compatibility level config and reverts to the global default. | -| | `EXEC` | | Update compatibility level, compatibility group, normalization, default metadata, and rule set for the specified subject. On success, echoes the original request back to the client. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
subjectdefaultToGlobalRetrieves compatibility level, compatibility group, normalization,
default metadata, and rule set for a subject.
subjectUpdate compatibility level, compatibility group, normalization,
default metadata, and rule set for the specified subject. On success,
echoes the original request back to the client.
subjectDeletes the specified subject-level compatibility level config and reverts to the global default.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the subject
booleanWhether to return the global compatibility level if subject compatibility level not found
## `SELECT` examples -Retrieves compatibility level, compatibility group, normalization, default metadata, and rule set for a subject. + + +Retrieves compatibility level, compatibility group, normalization,
default metadata, and rule set for a subject. ```sql SELECT @@ -62,14 +184,69 @@ normalize, overrideMetadata, overrideRuleSet FROM confluent.schema_registry.subject_level_config -WHERE subject = '{{ subject }}'; +WHERE subject = '{{ subject }}' -- required +AND defaultToGlobal = '{{ defaultToGlobal }}' +; +``` + + + + +## `REPLACE` examples + + + + +Update compatibility level, compatibility group, normalization,
default metadata, and rule set for the specified subject. On success,
echoes the original request back to the client. + +```sql +REPLACE confluent.schema_registry.subject_level_config +SET +alias = '{{ alias }}', +normalize = {{ normalize }}, +compatibility = '{{ compatibility }}', +compatibilityGroup = '{{ compatibilityGroup }}', +defaultMetadata = '{{ defaultMetadata }}', +overrideMetadata = '{{ overrideMetadata }}', +defaultRuleSet = '{{ defaultRuleSet }}', +overrideRuleSet = '{{ overrideRuleSet }}' +WHERE +subject = '{{ subject }}' --required +RETURNING +alias, +compatibility, +compatibilityGroup, +defaultMetadata, +defaultRuleSet, +normalize, +overrideMetadata, +overrideRuleSet; ``` -## `DELETE` example + + + + +## `DELETE` examples + + + -Deletes the specified subject_level_config resource. +Deletes the specified subject-level compatibility level config and reverts to the global default. ```sql -/*+ delete */ DELETE FROM confluent.schema_registry.subject_level_config -WHERE subject = '{{ subject }}'; +WHERE subject = '{{ subject }}' --required +; ``` + + diff --git a/website/docs/services/schema_registry/subjects/index.md b/website/docs/services/schema_registry/subjects/index.md index de00b38..b136bb4 100644 --- a/website/docs/services/schema_registry/subjects/index.md +++ b/website/docs/services/schema_registry/subjects/index.md @@ -1,4 +1,4 @@ ---- +--- title: subjects hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,59 +23,272 @@ Creates, updates, deletes, gets or lists a subjects resource. ## Overview - +
Namesubjects
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Globally unique identifier of the schema | -| | `object` | User-defined metadata | -| | `array` | References to other schemas | -| | `object` | Schema rule set | -| | `string` | Schema definition string | -| | `string` | Schema type | -| | `string` | Name of the subject | -| | `integer` | Version number | + +The following fields are returned by `SELECT` queries: + + + + +List of subjects matching the specified parameters. + + + + + + + + + + + +
NameDatatypeDescription
+ + + +List of subjects matching the specified parameters. + + + + + + + + + + + +
NameDatatypeDescription
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieves a specific version of the schema registered under this subject. | -| | `SELECT` | | Retrieves a list of registered subjects matching specified parameters. | -| | `DELETE` | | Deletes a specific version of the schema registered under this subject. This only deletes the version and the schema ID remains intact making it still possible to decode data using the schema ID. This API is recommended to be used only in development environments or under extreme circumstances where-in, its required to delete a previously registered schema for compatibility purposes or re-register previously registered schema. | -| | `DELETE` | | Deletes the specified subject and its associated compatibility level if registered. It is recommended to use this API only when a topic needs to be recycled or in development environment. | -| | `EXEC` | | Retrieves the IDs of schemas that reference the specified schema. | -| | `EXEC` | | Retrieves the schema for the specified version of this subject. Only the unescaped schema string is returned. | -| | `EXEC` | | Check if a schema has already been registered under the specified subject. If so, this returns the schema string along with its globally unique identifier, its version under this subject and the subject name. | -| | `EXEC` | | Register a new schema under the specified subject. If successfully registered, this returns the unique identifier of this schema in the registry. The returned identifier should be used to retrieve this schema from the schemas resource and is different from the schema's version which is associated with the subject. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects. A schema should be compatible with the previously registered schema or schemas (if there are any) as per the configured compatibility level. The configured compatibility level can be obtained by issuing a GET http:get:: /config/(string: subject). If that returns null, then GET http:get:: /config When there are multiple instances of Schema Registry running in the same cluster, the schema registration request will be forwarded to one of the instances designated as the primary. If the primary is not available, the client will get an error code indicating that the forwarding has failed. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idsubject, format, deleted, offset, limitRetrieves all the subjects associated with a particular schema ID.
subjectPrefix, deleted, deletedOnly, offset, limitRetrieves a list of registered subjects matching specified parameters.
subjectpermanentDeletes the specified subject and its associated compatibility level if registered. It is recommended to use this API only when a topic needs to be recycled or in development environment.
subjectnormalize, format, deletedCheck if a schema has already been registered under the specified subject. If so, this returns the schema string along with its globally unique identifier, its version under this subject and the subject name.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int32)Globally unique identifier of the schema
stringSubject under which the schema will be registered
booleanWhether to lookup deleted schemas
booleanWhether to return deleted subjects only
stringDesired output format, dependent on schema type. For AVRO schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, valid values are: " " (default), "ignore_extensions", or "serialized" (The parameter does not apply to JSON schemas.)
integer (int32)Pagination size for results. Ignored if negative
booleanWhether to lookup the normalized schema
integer (int32)Pagination offset for results
booleanWhether to perform a permanent delete
stringFilters results by the respective subject
stringSubject name prefix
## `SELECT` examples -Retrieves a list of registered subjects matching specified parameters. + + +Retrieves all the subjects associated with a particular schema ID. ```sql SELECT -id, -metadata, -references, -ruleSet, -schema, -schemaType, -subject, -version +* FROM confluent.schema_registry.subjects +WHERE id = '{{ id }}' -- required +AND subject = '{{ subject }}' +AND format = '{{ format }}' +AND deleted = '{{ deleted }}' +AND offset = '{{ offset }}' +AND limit = '{{ limit }}' ; ``` -## `DELETE` example + + -Deletes the specified subjects resource. +Retrieves a list of registered subjects matching specified parameters. + +```sql +SELECT +* +FROM confluent.schema_registry.subjects +WHERE subjectPrefix = '{{ subjectPrefix }}' +AND deleted = '{{ deleted }}' +AND deletedOnly = '{{ deletedOnly }}' +AND offset = '{{ offset }}' +AND limit = '{{ limit }}' +; +``` + + + + +## `DELETE` examples + + + + +Deletes the specified subject and its associated compatibility level if registered. It is recommended to use this API only when a topic needs to be recycled or in development environment. ```sql -/*+ delete */ DELETE FROM confluent.schema_registry.subjects -WHERE subject = '{{ subject }}'; +WHERE subject = '{{ subject }}' --required +AND permanent = '{{ permanent }}' +; +``` + + + + +## Lifecycle Methods + + + + +Check if a schema has already been registered under the specified subject. If so, this returns the schema string along with its globally unique identifier, its version under this subject and the subject name. + +```sql +EXEC confluent.schema_registry.subjects.look_up_schema_under_subject +@subject='{{ subject }}' --required, +@normalize={{ normalize }}, +@format='{{ format }}', +@deleted={{ deleted }} +@@json= +'{ +"version": {{ version }}, +"id": {{ id }}, +"schemaType": "{{ schemaType }}", +"references": "{{ references }}", +"schema": "{{ schema }}", +"metadata": "{{ metadata }}", +"ruleSet": "{{ ruleSet }}", +"schemaTagsToAdd": "{{ schemaTagsToAdd }}", +"schemaTagsToRemove": "{{ schemaTagsToRemove }}", +"propagateSchemaTags": {{ propagateSchemaTags }} +}' +; ``` + + diff --git a/website/docs/services/schema_registry/subjects_referenced_by/index.md b/website/docs/services/schema_registry/subjects_referenced_by/index.md new file mode 100644 index 0000000..f6f6e5f --- /dev/null +++ b/website/docs/services/schema_registry/subjects_referenced_by/index.md @@ -0,0 +1,143 @@ +--- +title: subjects_referenced_by +hide_title: false +hide_table_of_contents: false +keywords: + - subjects_referenced_by + - schema_registry + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a subjects_referenced_by resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +List of IDs for schemas that reference the specified schema. + + + + + + + + + + + +
NameDatatypeDescription
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
subject, versionoffset, limitRetrieves the IDs of schemas that reference the specified schema.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the subject
stringVersion of the schema to be returned. Valid values for versionId are between [1,2^31-1] or the string "latest". "latest" returns the last registered schema under the specified subject. Note that there may be a new latest schema that gets registered right after this request is served.
integer (int32)Pagination size for results. Ignored if negative
integer (int32)Pagination offset for results
+ +## `SELECT` examples + + + + +Retrieves the IDs of schemas that reference the specified schema. + +```sql +SELECT +* +FROM confluent.schema_registry.subjects_referenced_by +WHERE subject = '{{ subject }}' -- required +AND version = '{{ version }}' -- required +AND offset = '{{ offset }}' +AND limit = '{{ limit }}' +; +``` + + diff --git a/website/docs/services/schema_registry/top_level_config/index.md b/website/docs/services/schema_registry/top_level_config/index.md index c997b88..ee48945 100644 --- a/website/docs/services/schema_registry/top_level_config/index.md +++ b/website/docs/services/schema_registry/top_level_config/index.md @@ -1,4 +1,4 @@ ---- +--- title: top_level_config hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,34 +23,145 @@ Creates, updates, deletes, gets or lists a top_level_config resourc ## Overview - +
Nametop_level_config
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | If alias is specified, then this subject is an alias for the subject named by the alias. That means that any reference to this subject will be replaced by the alias. | -| | `string` | Only schemas that belong to the same compatibility group will be checked for compatibility. | -| | `string` | Compatibility Level | -| | `object` | Default value for the metadata to be used during schema registration. | -| | `object` | Default value for the ruleSet to be used during schema registration. | -| | `boolean` | If true, then schemas are automatically normalized when registered or when passed during lookups. This means that clients do not have to pass the "normalize" query parameter to have normalization occur. | -| | `object` | Override value for the metadata to be used during schema registration. | -| | `object` | Override value for the ruleSet to be used during schema registration. | + +The following fields are returned by `SELECT` queries: + + + + +The global compatibility level. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringIf alias is specified, then this subject is an alias for the subject named by the alias. That means that any reference to this subject will be replaced by the alias.
stringOnly schemas that belong to the same compatibility group will be checked for compatibility.
stringCompatibility Level (example: FULL_TRANSITIVE)
objectDefault value for the metadata to be used during schema registration.
objectDefault value for the ruleSet to be used during schema registration.
booleanIf true, then schemas are automatically normalized when registered or when passed during lookups. This means that clients do not have to pass the "normalize" query parameter to have normalization occur.
objectOverride value for the metadata to be used during schema registration.
objectOverride value for the ruleSet to be used during schema registration.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieves the global compatibility level, compatibility group, normalization, default metadata, and rule set. | -| | `DELETE` | | Deletes the global compatibility level config and reverts to the default. | -| | `EXEC` | | Updates the global compatibility level, compatibility group, schema normalization, default metadata, and rule set. On success, echoes the original request back to the client. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Retrieves the global compatibility level, compatibility group,
normalization, default metadata, and rule set.
Updates the global compatibility level, compatibility group,
schema normalization, default metadata, and rule set. On success, echoes the
original request back to the client.
Deletes the global compatibility level config and reverts to the default.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -Retrieves the global compatibility level, compatibility group, normalization, default metadata, and rule set. + + +Retrieves the global compatibility level, compatibility group,
normalization, default metadata, and rule set. ```sql SELECT @@ -64,12 +176,62 @@ overrideRuleSet FROM confluent.schema_registry.top_level_config ; ``` -## `DELETE` example + + + -Deletes the specified top_level_config resource. +## `REPLACE` examples + + + + +Updates the global compatibility level, compatibility group,
schema normalization, default metadata, and rule set. On success, echoes the
original request back to the client. + +```sql +REPLACE confluent.schema_registry.top_level_config +SET +alias = '{{ alias }}', +normalize = {{ normalize }}, +compatibility = '{{ compatibility }}', +compatibilityGroup = '{{ compatibilityGroup }}', +defaultMetadata = '{{ defaultMetadata }}', +overrideMetadata = '{{ overrideMetadata }}', +defaultRuleSet = '{{ defaultRuleSet }}', +overrideRuleSet = '{{ overrideRuleSet }}' +RETURNING +alias, +compatibility, +compatibilityGroup, +defaultMetadata, +defaultRuleSet, +normalize, +overrideMetadata, +overrideRuleSet; +``` + + + + +## `DELETE` examples + + + + +Deletes the global compatibility level config and reverts to the default. ```sql -/*+ delete */ DELETE FROM confluent.schema_registry.top_level_config -WHERE = '{{ }}'; +; ``` + + diff --git a/website/docs/services/schema_registry/types/index.md b/website/docs/services/schema_registry/types/index.md index ca52478..18a9f12 100644 --- a/website/docs/services/schema_registry/types/index.md +++ b/website/docs/services/schema_registry/types/index.md @@ -1,4 +1,4 @@ ---- +--- title: types hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,29 +23,97 @@ Creates, updates, deletes, gets or lists a types resource. ## Overview - +
Nametypes
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +List of supported schema types. + + + + + + + + + + + +
NameDatatypeDescription
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieve the schema types supported by this registry. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Retrieve the schema types supported by this registry.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -Retrieve the schema types supported by this registry. + + +Retrieve the schema types supported by this registry. ```sql SELECT -column_anon +* FROM confluent.schema_registry.types ; -``` \ No newline at end of file +``` + + diff --git a/website/docs/services/schema_registry/versions/index.md b/website/docs/services/schema_registry/versions/index.md index 3a38be8..f79594e 100644 --- a/website/docs/services/schema_registry/versions/index.md +++ b/website/docs/services/schema_registry/versions/index.md @@ -1,4 +1,4 @@ ---- +--- title: versions hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,32 +23,482 @@ Creates, updates, deletes, gets or lists a versions resource. ## Overview - +
Nameversions
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | Name of the subject | -| | `integer` | Version number | + +The following fields are returned by `SELECT` queries: + + + + +The schema. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int32)Globally unique identifier of the schema
objectUser-defined metadata
arrayReferences to other schemas
objectSchema rule set
stringSchema definition string (example: {"schema": "{"type": "string"}"})
arraySchema tags
stringSchema type (example: AVRO)
stringName of the subject (example: User)
integer (int32)Version number
+ + + +List of subject versions matching the specified parameters. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the subject (example: User)
integer (int32)Version number
+ + + +List of version numbers matching the specified parameters. + + + + + + + + + + + +
NameDatatypeDescription
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Get all the subject-version pairs associated with the input ID. | -| | `SELECT` | | Retrieves a list of versions registered under the specified subject. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
subject, versionformat, deletedRetrieves a specific version of the schema registered under this subject.
idsubject, deleted, offset, limitGet all the subject-version pairs associated with the input ID.
subjectdeleted, deletedOnly, offset, limitRetrieves a list of versions registered under the specified subject.
subjectnormalize, formatRegister a new schema under the specified subject. If successfully registered, this returns the unique identifier of this schema in the registry. The returned identifier should be used to retrieve this schema from the schemas resource and is different from the schema's version which is associated with the subject. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.
A schema should be compatible with the previously registered schema or schemas (if there are any) as per the configured compatibility level. The configured compatibility level can be obtained by issuing a GET http:get:: /config/(string: subject). If that returns null, then GET http:get:: /config
When there are multiple instances of Schema Registry running in the same cluster, the schema registration request will be forwarded to one of the instances designated as the primary. If the primary is not available, the client will get an error code indicating that the forwarding has failed.
subject, versionpermanentDeletes a specific version of the schema registered under this subject. This only deletes the version and the schema ID remains intact making it still possible to decode data using the schema ID. This API is recommended to be used only in development environments or under extreme circumstances where-in, its required to delete a previously registered schema for compatibility purposes or re-register previously registered schema.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int32)Globally unique identifier of the schema
stringName of the subject
stringVersion of the schema to be returned. Valid values for versionId are between [1,2^31-1] or the string "latest". "latest" returns the last registered schema under the specified subject. Note that there may be a new latest schema that gets registered right after this request is served.
booleanWhether to include deleted schemas
booleanWhether to return deleted schemas only
stringDesired output format, dependent on schema type. For AVRO schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, valid values are: " " (default), "ignore_extensions", or "serialized" (The parameter does not apply to JSON schemas.)
integer (int32)Pagination size for results. Ignored if negative
booleanWhether to register the normalized schema
integer (int32)Pagination offset for results
booleanWhether to perform a permanent delete
stringFilters results by the respective subject
## `SELECT` examples -Get all the subject-version pairs associated with the input ID. + + +Retrieves a specific version of the schema registered under this subject. ```sql SELECT +id, +metadata, +references, +ruleSet, +schema, +schemaTags, +schemaType, subject, version FROM confluent.schema_registry.versions -WHERE id = '{{ id }}'; -``` \ No newline at end of file +WHERE subject = '{{ subject }}' -- required +AND version = '{{ version }}' -- required +AND format = '{{ format }}' +AND deleted = '{{ deleted }}' +; +``` + + + +Get all the subject-version pairs associated with the input ID. + +```sql +SELECT +subject, +version +FROM confluent.schema_registry.versions +WHERE id = '{{ id }}' -- required +AND subject = '{{ subject }}' +AND deleted = '{{ deleted }}' +AND offset = '{{ offset }}' +AND limit = '{{ limit }}' +; +``` + + + +Retrieves a list of versions registered under the specified subject. + +```sql +SELECT +* +FROM confluent.schema_registry.versions +WHERE subject = '{{ subject }}' -- required +AND deleted = '{{ deleted }}' +AND deletedOnly = '{{ deletedOnly }}' +AND offset = '{{ offset }}' +AND limit = '{{ limit }}' +; +``` + + + + +## `INSERT` examples + + + + +Register a new schema under the specified subject. If successfully registered, this returns the unique identifier of this schema in the registry. The returned identifier should be used to retrieve this schema from the schemas resource and is different from the schema's version which is associated with the subject. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.
A schema should be compatible with the previously registered schema or schemas (if there are any) as per the configured compatibility level. The configured compatibility level can be obtained by issuing a GET http:get:: /config/(string: subject). If that returns null, then GET http:get:: /config
When there are multiple instances of Schema Registry running in the same cluster, the schema registration request will be forwarded to one of the instances designated as the primary. If the primary is not available, the client will get an error code indicating that the forwarding has failed. + +```sql +INSERT INTO confluent.schema_registry.versions ( +version, +id, +schemaType, +references, +schema, +metadata, +ruleSet, +schemaTagsToAdd, +schemaTagsToRemove, +propagateSchemaTags, +subject, +normalize, +format +) +SELECT +{{ version }}, +{{ id }}, +'{{ schemaType }}', +'{{ references }}', +'{{ schema }}', +'{{ metadata }}', +'{{ ruleSet }}', +'{{ schemaTagsToAdd }}', +'{{ schemaTagsToRemove }}', +{{ propagateSchemaTags }}, +'{{ subject }}', +'{{ normalize }}', +'{{ format }}' +RETURNING +id +; +``` + + + +{`# Description fields are for documentation purposes +- name: versions + props: + - name: subject + value: "{{ subject }}" + description: Required parameter for the versions resource. + - name: version + value: {{ version }} + description: | + Version number + - name: id + value: {{ id }} + description: | + Globally unique identifier of the schema + - name: schemaType + value: "{{ schemaType }}" + description: | + Schema type + - name: references + description: | + References to other schemas + value: + - name: "{{ name }}" + subject: "{{ subject }}" + version: {{ version }} + - name: schema + value: "{{ schema }}" + description: | + Schema definition string + - name: metadata + description: | + User-defined metadata + value: + tags: "{{ tags }}" + properties: "{{ properties }}" + sensitive: + - "{{ sensitive }}" + - name: ruleSet + description: | + Schema rule set + value: + migrationRules: + - name: "{{ name }}" + doc: "{{ doc }}" + kind: "{{ kind }}" + mode: "{{ mode }}" + type: "{{ type }}" + tags: "{{ tags }}" + params: "{{ params }}" + expr: "{{ expr }}" + onSuccess: "{{ onSuccess }}" + onFailure: "{{ onFailure }}" + disabled: {{ disabled }} + domainRules: + - name: "{{ name }}" + doc: "{{ doc }}" + kind: "{{ kind }}" + mode: "{{ mode }}" + type: "{{ type }}" + tags: "{{ tags }}" + params: "{{ params }}" + expr: "{{ expr }}" + onSuccess: "{{ onSuccess }}" + onFailure: "{{ onFailure }}" + disabled: {{ disabled }} + - name: schemaTagsToAdd + value: + - schemaEntity: + entityPath: "{{ entityPath }}" + entityType: "{{ entityType }}" + tags: "{{ tags }}" + - name: schemaTagsToRemove + value: + - schemaEntity: + entityPath: "{{ entityPath }}" + entityType: "{{ entityType }}" + tags: "{{ tags }}" + - name: propagateSchemaTags + value: {{ propagateSchemaTags }} + - name: normalize + value: {{ normalize }} + description: Whether to register the normalized schema + description: Whether to register the normalized schema + - name: format + value: "{{ format }}" + description: Desired output format, dependent on schema type. For AVRO schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, valid values are: " " (default), "ignore_extensions", or "serialized" (The parameter does not apply to JSON schemas.) + description: Desired output format, dependent on schema type. For AVRO schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, valid values are: " " (default), "ignore_extensions", or "serialized" (The parameter does not apply to JSON schemas.) +`} + + + + + +## `DELETE` examples + + + + +Deletes a specific version of the schema registered under this subject. This only deletes the version and the schema ID remains intact making it still possible to decode data using the schema ID. This API is recommended to be used only in development environments or under extreme circumstances where-in, its required to delete a previously registered schema for compatibility purposes or re-register previously registered schema. + +```sql +DELETE FROM confluent.schema_registry.versions +WHERE subject = '{{ subject }}' --required +AND version = '{{ version }}' --required +AND permanent = '{{ permanent }}' +; +``` + + diff --git a/website/docs/services/schema_registry_clusters/index.md b/website/docs/services/schema_registry_clusters/index.md index 2000558..5c33e89 100644 --- a/website/docs/services/schema_registry_clusters/index.md +++ b/website/docs/services/schema_registry_clusters/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png schema_registry_clusters service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 3
-
-
+total resources: __3__ ::: diff --git a/website/docs/services/schema_registry_clusters/regions/index.md b/website/docs/services/schema_registry_clusters/regions/index.md index cb2b151..8b6bab7 100644 --- a/website/docs/services/schema_registry_clusters/regions/index.md +++ b/website/docs/services/schema_registry_clusters/regions/index.md @@ -1,4 +1,4 @@ ---- +--- title: regions hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,40 +23,227 @@ Creates, updates, deletes, gets or lists a regions resource. ## Overview - +
Nameregions
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Region | + +The following fields are returned by `SELECT` queries: + + + + +Region. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (srcm/v2)
stringKind defines the object this REST resource represents. (Region)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Region
+ + + +Region. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (srcm/v2)
stringKind defines the object this REST resource represents. (Region)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Region
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a region. | -| | `SELECT` | | [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all regions. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a region.
spec.cloud, spec.region_name, spec.packages, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all regions.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the region.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for spec.cloud. (example: AWS)
arrayFilter the results by exact match for spec.packages. Pass multiple times to see results matching any of the values. (example: [ESSENTIALS, ADVANCED])
stringFilter the results by exact match for spec.region_name. (example: us-east-2)
## `SELECT` examples -[![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all regions. + + + +Make a request to read a region. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec +FROM confluent.schema_registry_clusters.regions +WHERE id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all regions. ```sql SELECT id, -_spec, api_version, kind, metadata, spec FROM confluent.schema_registry_clusters.regions +WHERE spec.cloud = '{{ spec.cloud }}' +AND spec.region_name = '{{ spec.region_name }}' +AND spec.packages = '{{ spec.packages }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; -``` \ No newline at end of file +``` + + diff --git a/website/docs/services/schema_registry_clusters/v2_clusters/index.md b/website/docs/services/schema_registry_clusters/v2_clusters/index.md index 56ee179..1970311 100644 --- a/website/docs/services/schema_registry_clusters/v2_clusters/index.md +++ b/website/docs/services/schema_registry_clusters/v2_clusters/index.md @@ -1,4 +1,4 @@ ---- +--- title: v2_clusters hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,109 +23,357 @@ Creates, updates, deletes, gets or lists a v2_clusters resource. ## Overview - +
Namev2_clusters
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Cluster | -| | `object` | The status of the Cluster | + +The following fields are returned by `SELECT` queries: + + + + +Cluster. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (srcm/v2)
stringKind defines the object this REST resource represents. (Cluster)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Cluster
objectThe status of the Cluster
+ + + +Cluster. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (srcm/v2)
stringKind defines the object this REST resource represents. (Cluster)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Cluster
objectThe status of the Cluster
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a cluster. | -| | `SELECT` | | [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all clusters. | -| | `INSERT` | | [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a cluster. | -| | `DELETE` | | [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a cluster. | -| | `UPDATE` | | [![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a cluster. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a cluster.
environmentpage_size, page_tokenRetrieve a sorted, filtered, paginated list of all clusters.
specMake a request to create a cluster.
id, specMake a request to update a cluster.

environment, idMake a request to delete a cluster.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the cluster.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![Deprecated](https://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005c)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all clusters. + + + +Make a request to read a cluster. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.schema_registry_clusters.v2_clusters +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all clusters. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.schema_registry_clusters.v2_clusters -WHERE environment = '{{ environment }}'; +WHERE environment = '{{ environment }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new v2_clusters resource. + +## `INSERT` examples - + { label: 'create_srcm_v2_cluster', value: 'create_srcm_v2_cluster' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a cluster. ```sql -/*+ create */ INSERT INTO confluent.schema_registry_clusters.v2_clusters ( -data__spec +spec ) SELECT -'{{ spec }}' +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: v2_clusters props: - name: spec - props: - - name: environment - value: string - - name: region - value: string + description: | + The desired state of the Cluster + value: + display_name: "{{ display_name }}" + package: "{{ package }}" + http_endpoint: "{{ http_endpoint }}" + environment: + id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + region: + id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} -``` -## `UPDATE` example -Updates a v2_clusters resource. +## `UPDATE` examples + + + + +Make a request to update a cluster.

```sql -/*+ update */ UPDATE confluent.schema_registry_clusters.v2_clusters SET spec = '{{ spec }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +AND spec = '{{ spec }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; ``` + + + -## `DELETE` example +## `DELETE` examples + + + -Deletes the specified v2_clusters resource. +Make a request to delete a cluster. ```sql -/*+ delete */ DELETE FROM confluent.schema_registry_clusters.v2_clusters -WHERE environment = '{{ environment }}' -AND id = '{{ id }}'; +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/schema_registry_clusters/v3_clusters/index.md b/website/docs/services/schema_registry_clusters/v3_clusters/index.md index 743c7c9..0d4b86f 100644 --- a/website/docs/services/schema_registry_clusters/v3_clusters/index.md +++ b/website/docs/services/schema_registry_clusters/v3_clusters/index.md @@ -1,4 +1,4 @@ ---- +--- title: v3_clusters hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,42 +23,228 @@ Creates, updates, deletes, gets or lists a v3_clusters resource. ## Overview - +
Namev3_clusters
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The desired state of the Cluster | -| | `object` | The status of the Cluster | + +The following fields are returned by `SELECT` queries: + + + + +Cluster. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (srcm/v3)
stringKind defines the object this REST resource represents. (Cluster)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Cluster
objectThe status of the Cluster
+ + + +Cluster. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (srcm/v3)
stringKind defines the object this REST resource represents. (Cluster)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Cluster
objectThe status of the Cluster
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a cluster. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all clusters. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a cluster.
environmentpage_size, page_tokenRetrieve a sorted, filtered, paginated list of all clusters.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringFilter the results by exact match for environment. (example: env-00000)
stringThe unique identifier for the cluster.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all clusters. + + + +Make a request to read a cluster. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.schema_registry_clusters.v3_clusters +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + +Retrieve a sorted, filtered, paginated list of all clusters. ```sql SELECT id, -_spec, api_version, kind, metadata, spec, status FROM confluent.schema_registry_clusters.v3_clusters -WHERE environment = '{{ environment }}'; -``` \ No newline at end of file +WHERE environment = '{{ environment }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + diff --git a/website/docs/services/share_group/consumer_assignments/index.md b/website/docs/services/share_group/consumer_assignments/index.md new file mode 100644 index 0000000..f05087a --- /dev/null +++ b/website/docs/services/share_group/consumer_assignments/index.md @@ -0,0 +1,166 @@ +--- +title: consumer_assignments +hide_title: false +hide_table_of_contents: false +keywords: + - consumer_assignments + - share_group + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a consumer_assignments resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The list of share group assignments. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
integer
string
string
object
object
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the consumer assignments specified by the ``consumer_id``.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Return the consumer assignments specified by the ``consumer_id``. + +```sql +SELECT +cluster_id, +consumer_id, +group_id, +partition_id, +topic_name, +kind, +metadata, +partition +FROM confluent.share_group.consumer_assignments +; +``` + + diff --git a/website/docs/services/share_group/consumers/index.md b/website/docs/services/share_group/consumers/index.md new file mode 100644 index 0000000..d402590 --- /dev/null +++ b/website/docs/services/share_group/consumers/index.md @@ -0,0 +1,237 @@ +--- +title: consumers +hide_title: false +hide_table_of_contents: false +keywords: + - consumers + - share_group + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a consumers resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The consumer. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
string
object
+ + + +The list of consumers. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
string
object
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the consumer specified by the ``consumer_id``.
Return a list of consumers that belong to the specified share
group.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Return the consumer specified by the ``consumer_id``. + +```sql +SELECT +client_id, +cluster_id, +consumer_id, +group_id, +assignments, +kind, +metadata +FROM confluent.share_group.consumers +; +``` + + + +Return a list of consumers that belong to the specified share
group. + +```sql +SELECT +client_id, +cluster_id, +consumer_id, +group_id, +assignments, +kind, +metadata +FROM confluent.share_group.consumers +; +``` + + diff --git a/website/docs/services/share_group/index.md b/website/docs/services/share_group/index.md new file mode 100644 index 0000000..0f704bd --- /dev/null +++ b/website/docs/services/share_group/index.md @@ -0,0 +1,34 @@ +--- +title: share_group +hide_title: false +hide_table_of_contents: false +keywords: + - share_group + - confluent + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +share_group service documentation. + +:::info[Service Summary] + +total resources: __3__ + +::: + +## Resources +
+
+consumer_assignments
+consumers +
+
+share_groups +
+
\ No newline at end of file diff --git a/website/docs/services/share_group/share_groups/index.md b/website/docs/services/share_group/share_groups/index.md new file mode 100644 index 0000000..86b073e --- /dev/null +++ b/website/docs/services/share_group/share_groups/index.md @@ -0,0 +1,300 @@ +--- +title: share_groups +hide_title: false +hide_table_of_contents: false +keywords: + - share_groups + - share_group + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a share_groups resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The share group. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
arrayList of topic-partitions assigned to this share group, including those from empty groups
integer (int32)Number of consumers in this share group
object
object
string
object
integer (int32)Total number of partitions assigned to this share group across all consumers
string
+ + + +The list of share groups. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
arrayList of topic-partitions assigned to this share group, including those from empty groups
integer (int32)Number of consumers in this share group
object
object
string
object
integer (int32)Total number of partitions assigned to this share group across all consumers
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the share group specified by the ``group_id``.
Return the list of share groups that belong to the specified
Kafka cluster.
Delete the share group specified by the ``group_id``.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Return the share group specified by the ``group_id``. + +```sql +SELECT +cluster_id, +share_group_id, +assigned_topic_partitions, +consumer_count, +consumers, +coordinator, +kind, +metadata, +partition_count, +state +FROM confluent.share_group.share_groups +; +``` + + + +Return the list of share groups that belong to the specified
Kafka cluster. + +```sql +SELECT +cluster_id, +share_group_id, +assigned_topic_partitions, +consumer_count, +consumers, +coordinator, +kind, +metadata, +partition_count, +state +FROM confluent.share_group.share_groups +; +``` + + + + +## `DELETE` examples + + + + +Delete the share group specified by the ``group_id``. + +```sql +DELETE FROM confluent.share_group.share_groups +; +``` + + diff --git a/website/docs/services/sql/agents/index.md b/website/docs/services/sql/agents/index.md new file mode 100644 index 0000000..75cee6d --- /dev/null +++ b/website/docs/services/sql/agents/index.md @@ -0,0 +1,443 @@ +--- +title: agents +hide_title: false +hide_table_of_contents: false +keywords: + - agents + - sql + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an agents resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The requested Agent. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe user-provided name of the agent, unique within this environment. (pattern: [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, example: chat-listener-agent)
stringThe unique identifier for the environment.
string (uuid)The unique identifier for the organization.
stringAPIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
stringKind defines the object this REST resource represents. (Agent)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe specifications of the Agent.
objectThe status of the Agent.
+ + + +A list of Agents. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe user-provided name of the agent, unique within this environment. (pattern: [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, example: chat-listener-agent)
stringThe unique identifier for the environment.
string (uuid)The unique identifier for the organization.
stringAPIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
stringKind defines the object this REST resource represents. (Agent)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe specifications of the Agent.
objectThe status of the Agent.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
organization_id, environment_id, kafka_cluster_id, agent_nameRetrieve a specific Agent by name.
organization_id, environment_idpage_size, page_tokenRetrieve a sorted and paginated list of all agents.
organization_id, environment_id, kafka_cluster_id, api_version, kind, metadata, name, organization_id, environment_id, specMake a request to create an Agent.
organization_id, environment_id, kafka_cluster_id, agent_name, api_version, kind, metadata, name, organization_id, environment_id, specMake a request to update an Agent's mutable fields.
Mutable fields include: `description`, `model`, `prompt`, and `properties`.
organization_id, environment_id, kafka_cluster_id, agent_nameDelete a specific Agent by name.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the Agent
stringThe unique identifier for the environment.
stringThe unique identifier for the database.
string (uuid)The unique identifier for the organization
integer (int32)A pagination size for collection requests.
stringAn opaque pagination token for collection requests.
+ +## `SELECT` examples + + + + +Retrieve a specific Agent by name.
+ +```sql +SELECT +name, +environment_id, +organization_id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.sql.agents +WHERE organization_id = '{{ organization_id }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required +AND agent_name = '{{ agent_name }}' -- required +; +``` + + + +Retrieve a sorted and paginated list of all agents.
+ +```sql +SELECT +name, +environment_id, +organization_id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.sql.agents +WHERE organization_id = '{{ organization_id }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples + + + + +Make a request to create an Agent.
+ +```sql +INSERT INTO confluent.sql.agents ( +name, +spec, +organization_id, +environment_id, +kafka_cluster_id +) +SELECT +'{{ name }}' /* required */, +'{{ spec }}' /* required */, +'{{ organization_id }}', +'{{ environment_id }}', +'{{ kafka_cluster_id }}' +RETURNING +name, +environment_id, +organization_id, +api_version, +kind, +metadata, +spec, +status +; +``` + + + +{`# Description fields are for documentation purposes +- name: agents + props: + - name: organization_id + value: "{{ organization_id }}" + description: Required parameter for the agents resource. + - name: environment_id + value: "{{ environment_id }}" + description: Required parameter for the agents resource. + - name: kafka_cluster_id + value: "{{ kafka_cluster_id }}" + description: Required parameter for the agents resource. + - name: name + value: "{{ name }}" + description: | + The user-provided name of the agent, unique within this environment. + - name: spec + description: | + The specifications of the Agent. + value: + description: "{{ description }}" + model: "{{ model }}" + prompt: "{{ prompt }}" + tools: + - "{{ tools }}" + properties: "{{ properties }}" +`} + + + + + +## `REPLACE` examples + + + + +Make a request to update an Agent's mutable fields.
Mutable fields include: `description`, `model`, `prompt`, and `properties`.
+ +```sql +REPLACE confluent.sql.agents +SET +name = '{{ name }}', +spec = '{{ spec }}' +WHERE +organization_id = '{{ organization_id }}' --required +AND environment_id = '{{ environment_id }}' --required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' --required +AND agent_name = '{{ agent_name }}' --required +AND name = '{{ name }}' --required +AND spec = '{{ spec }}' --required +RETURNING +name, +environment_id, +organization_id, +api_version, +kind, +metadata, +spec, +status; +``` + + + + +## `DELETE` examples + + + + +Delete a specific Agent by name.
+ +```sql +DELETE FROM confluent.sql.agents +WHERE organization_id = '{{ organization_id }}' --required +AND environment_id = '{{ environment_id }}' --required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' --required +AND agent_name = '{{ agent_name }}' --required +; +``` + + diff --git a/website/docs/services/sql/connections/index.md b/website/docs/services/sql/connections/index.md index 0c53d41..a6b2fe2 100644 --- a/website/docs/services/sql/connections/index.md +++ b/website/docs/services/sql/connections/index.md @@ -1,4 +1,4 @@ ---- +--- title: connections hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,106 +23,378 @@ Creates, updates, deletes, gets or lists a connections resource. ## Overview - +
Nameconnections
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The user provided name of the resource, unique within this environment. | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | Encapsulates the model provider access details | -| | `object` | The status of the Connection | + +The following fields are returned by `SELECT` queries: + + + + +Connection. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe user provided name of the resource, unique within this environment. (example: my-openai-connection, pattern: [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)
stringAPIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
stringKind defines the object this REST resource represents. (Connection)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectEncapsulates the model provider access details
objectThe status of the Connection
+ + + +Connections. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe user provided name of the resource, unique within this environment. (example: my-openai-connection, pattern: [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)
stringAPIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
stringKind defines the object this REST resource represents. (Connection)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectEncapsulates the model provider access details
objectThe status of the Connection
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a Connection. | -| | `SELECT` | | [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered and paginated list of all Connections. | -| | `INSERT` | | [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a Connection. | -| | `DELETE` | | [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a statement. | -| | `EXEC` | | [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a connection. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
organization_id, environment_id, connection_nameMake a request to read a Connection.
organization_id, environment_idspec.connection_type, page_size, page_tokenRetrieve a sorted, filtered and paginated list of all Connections.
organization_id, environment_id, spec, nameMake a request to create a Connection.
organization_id, environment_id, connection_name, spec, name, metadataMake a request to update a connection.
organization_id, environment_id, connection_nameMake a request to delete a statement.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the connection.
stringThe unique identifier for the environment.
string (uuid)The unique identifier for the organization.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for spec.connection_type
## `SELECT` examples -[![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered and paginated list of all Connections. + + + +Make a request to read a Connection. + +```sql +SELECT +name, +api_version, +kind, +metadata, +spec, +status +FROM confluent.sql.connections +WHERE organization_id = '{{ organization_id }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND connection_name = '{{ connection_name }}' -- required +; +``` + + +Retrieve a sorted, filtered and paginated list of all Connections. ```sql SELECT name, -_spec, api_version, kind, metadata, spec, status FROM confluent.sql.connections -WHERE environment_id = '{{ environment_id }}' -AND organization_id = '{{ organization_id }}'; +WHERE organization_id = '{{ organization_id }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND spec.connection_type = '{{ spec.connection_type }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new connections resource. + +## `INSERT` examples - + { label: 'create_sqlv1_connection', value: 'create_sqlv1_connection' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Make a request to create a Connection. ```sql -/*+ create */ INSERT INTO confluent.sql.connections ( -data__name, -data__spec, -environment_id, -organization_id +name, +spec, +organization_id, +environment_id ) SELECT -'{{ name }}', -'{{ spec }}', -'{{ environment_id }}', -'{{ organization_id }}' +'{{ name }}' /* required */, +'{{ spec }}' /* required */, +'{{ organization_id }}', +'{{ environment_id }}' +RETURNING +name, +api_version, +kind, +metadata, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: connections props: - - name: environment_id - value: string - name: organization_id - value: string + value: "{{ organization_id }}" + description: Required parameter for the connections resource. + - name: environment_id + value: "{{ environment_id }}" + description: Required parameter for the connections resource. - name: name - value: string + value: "{{ name }}" + description: | + The user provided name of the resource, unique within this environment. - name: spec - value: object + description: | + Encapsulates the model provider access details + value: + connection_type: "{{ connection_type }}" + endpoint: "{{ endpoint }}" + auth_data: + kind: "{{ kind }}" + data: "{{ data }}" +`} + + + + +## `REPLACE` examples + + + + +Make a request to update a connection. + +```sql +REPLACE confluent.sql.connections +SET +name = '{{ name }}', +spec = '{{ spec }}' +WHERE +organization_id = '{{ organization_id }}' --required +AND environment_id = '{{ environment_id }}' --required +AND connection_name = '{{ connection_name }}' --required +AND spec = '{{ spec }}' --required +AND name = '{{ name }}' --required; ``` -## `DELETE` example -Deletes the specified connections resource. +## `DELETE` examples + + + + +Make a request to delete a statement. ```sql -/*+ delete */ DELETE FROM confluent.sql.connections -WHERE connection_name = '{{ connection_name }}' -AND environment_id = '{{ environment_id }}' -AND organization_id = '{{ organization_id }}'; +WHERE organization_id = '{{ organization_id }}' --required +AND environment_id = '{{ environment_id }}' --required +AND connection_name = '{{ connection_name }}' --required +; ``` + + diff --git a/website/docs/services/sql/index.md b/website/docs/services/sql/index.md index b7e5835..9c9d2dd 100644 --- a/website/docs/services/sql/index.md +++ b/website/docs/services/sql/index.md @@ -16,24 +16,24 @@ image: /img/stackql-confluent-provider-featured-image.png sql service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 4
-
-
+total resources: __8__ ::: ## Resources
+agents
connections
-statement_exceptions +materialized_table_versions
+materialized_tables
+statement_exceptions
statement_results
-statements +statements
+tools
\ No newline at end of file diff --git a/website/docs/services/sql/materialized_table_versions/index.md b/website/docs/services/sql/materialized_table_versions/index.md new file mode 100644 index 0000000..093fbfa --- /dev/null +++ b/website/docs/services/sql/materialized_table_versions/index.md @@ -0,0 +1,283 @@ +--- +title: materialized_table_versions +hide_title: false +hide_table_of_contents: false +keywords: + - materialized_table_versions + - sql + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a materialized_table_versions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The requested Materialized Table Version. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe resource version name, unique within the Kafka cluster. Name conforms to DNS Subdomain (RFC 1123). (pattern: [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, example: mt-123-v4)
stringThe unique identifier for the environment.
string (uuid)The unique identifier for the organization.
stringAPIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
stringKind defines the object this REST resource represents. (MaterializedTableVersion)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe specifications of the Materialized Table Version.
+ + + +A list of Materialized Table Versions. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe resource version name, unique within the Kafka cluster. Name conforms to DNS Subdomain (RFC 1123). (pattern: [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, example: mt-123-v4)
stringThe unique identifier for the environment.
string (uuid)The unique identifier for the organization.
stringAPIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
stringKind defines the object this REST resource represents. (MaterializedTableVersion)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe specifications of the Materialized Table Version.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
organization_id, environment_id, kafka_cluster_id, table_name, versionRetrieve a specific version of a Materialized Table.
organization_id, environment_id, kafka_cluster_id, table_namepage_size, page_tokenRetrieve a sorted and paginated list of all versions for a specific Materialized Table.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the environment.
stringThe unique identifier for the database.
string (uuid)The unique identifier for the organization.
stringThe unique identifier for the Materialized Table.
integer (int32)The version number of the Materialized Table.
integer (int32)A pagination size for collection requests.
stringAn opaque pagination token for collection requests.
+ +## `SELECT` examples + + + + +Retrieve a specific version of a Materialized Table.
+ +```sql +SELECT +name, +environment_id, +organization_id, +api_version, +kind, +metadata, +spec +FROM confluent.sql.materialized_table_versions +WHERE organization_id = '{{ organization_id }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required +AND table_name = '{{ table_name }}' -- required +AND version = '{{ version }}' -- required +; +``` + + + +Retrieve a sorted and paginated list of all versions for a specific Materialized Table.
+ +```sql +SELECT +name, +environment_id, +organization_id, +api_version, +kind, +metadata, +spec +FROM confluent.sql.materialized_table_versions +WHERE organization_id = '{{ organization_id }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required +AND table_name = '{{ table_name }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + diff --git a/website/docs/services/sql/materialized_tables/index.md b/website/docs/services/sql/materialized_tables/index.md new file mode 100644 index 0000000..48f656f --- /dev/null +++ b/website/docs/services/sql/materialized_tables/index.md @@ -0,0 +1,609 @@ +--- +title: materialized_tables +hide_title: false +hide_table_of_contents: false +keywords: + - materialized_tables + - sql + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a materialized_tables resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The requested Materialized Table. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe user-provided name of the resource, unique within this environment. (pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$, example: high-value-orders)
stringThe unique identifier for the environment.
string (uuid)The unique identifier for the organization.
stringAPIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
stringKind defines the object this REST resource represents. (MaterializedTable)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe specifications of the Materialized Table.
objectThe status of the Materialized Table.
+ + + +A list of Materialized Tables. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe user-provided name of the resource, unique within this environment. (pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$, example: high-value-orders)
stringThe unique identifier for the environment.
string (uuid)The unique identifier for the organization.
stringAPIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
stringKind defines the object this REST resource represents. (MaterializedTable)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe specifications of the Materialized Table.
objectThe status of the Materialized Table.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
organization_id, environment_id, kafka_cluster_id, table_nameRetrieve a specific Materialized Table by name.
organization_id, environment_idpage_size, page_tokenRetrieve a sorted and paginated list of all materialized tables.
organization_id, environment_id, kafka_cluster_id, api_version, kind, metadata, name, organization_id, environment_id, specCreate a new Materialized Table.
organization_id, environment_id, kafka_cluster_id, table_name, api_version, kind, metadata, name, organization_id, environment_id, specMake a request to update a Materialized Table's mutable fields.
Mutable fields include: `query`, `stopped`, `compute_pool_id`, `principal`, `columns`, `watermark`, `constraints` and `table_options`.
organization_id, environment_id, kafka_cluster_id, table_nameDelete a specific Materialized Table by name.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the environment.
stringThe unique identifier for the database.
string (uuid)The unique identifier for the organization
stringThe unique identifier for the Materialized Table
integer (int32)A pagination size for collection requests.
stringAn opaque pagination token for collection requests.
+ +## `SELECT` examples + + + + +Retrieve a specific Materialized Table by name.
+ +```sql +SELECT +name, +environment_id, +organization_id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.sql.materialized_tables +WHERE organization_id = '{{ organization_id }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required +AND table_name = '{{ table_name }}' -- required +; +``` + + + +Retrieve a sorted and paginated list of all materialized tables.
+ +```sql +SELECT +name, +environment_id, +organization_id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.sql.materialized_tables +WHERE organization_id = '{{ organization_id }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a new Materialized Table.
+ +```sql +INSERT INTO confluent.sql.materialized_tables ( +name, +spec, +organization_id, +environment_id, +kafka_cluster_id +) +SELECT +'{{ name }}' /* required */, +'{{ spec }}' /* required */, +'{{ organization_id }}', +'{{ environment_id }}', +'{{ kafka_cluster_id }}' +RETURNING +name, +environment_id, +organization_id, +api_version, +kind, +metadata, +spec, +status +; +``` + + + +{`# Description fields are for documentation purposes +- name: materialized_tables + props: + - name: organization_id + value: "{{ organization_id }}" + description: Required parameter for the materialized_tables resource. + - name: environment_id + value: "{{ environment_id }}" + description: Required parameter for the materialized_tables resource. + - name: kafka_cluster_id + value: "{{ kafka_cluster_id }}" + description: Required parameter for the materialized_tables resource. + - name: name + value: "{{ name }}" + description: | + The user-provided name of the resource, unique within this environment. + - name: spec + description: | + The specifications of the Materialized Table. + value: + kafka_cluster_id: "{{ kafka_cluster_id }}" + compute_pool_id: "{{ compute_pool_id }}" + principal: "{{ principal }}" + stopped: {{ stopped }} + table_options: "{{ table_options }}" + session_options: "{{ session_options }}" + columns: + - name: "{{ name }}" + type: + type: "{{ type }}" + nullable: {{ nullable }} + length: {{ length }} + precision: {{ precision }} + scale: {{ scale }} + key_type: + type: "{{ type }}" + nullable: {{ nullable }} + length: {{ length }} + precision: {{ precision }} + scale: {{ scale }} + key_type: "{{ key_type }}" + value_type: "{{ value_type }}" + element_type: "{{ element_type }}" + fields: + - name: "{{ name }}" + field_type: + type: "{{ type }}" + nullable: {{ nullable }} + length: {{ length }} + precision: {{ precision }} + scale: {{ scale }} + key_type: "{{ key_type }}" + value_type: "{{ value_type }}" + element_type: "{{ element_type }}" + fields: "{{ fields }}" + resolution: "{{ resolution }}" + fractional_precision: {{ fractional_precision }} + class_name: "{{ class_name }}" + description: "{{ description }}" + resolution: "{{ resolution }}" + fractional_precision: {{ fractional_precision }} + class_name: "{{ class_name }}" + value_type: + type: "{{ type }}" + nullable: {{ nullable }} + length: {{ length }} + precision: {{ precision }} + scale: {{ scale }} + key_type: + type: "{{ type }}" + nullable: {{ nullable }} + length: {{ length }} + precision: {{ precision }} + scale: {{ scale }} + key_type: "{{ key_type }}" + value_type: "{{ value_type }}" + element_type: "{{ element_type }}" + fields: "{{ fields }}" + resolution: "{{ resolution }}" + fractional_precision: {{ fractional_precision }} + class_name: "{{ class_name }}" + value_type: "{{ value_type }}" + element_type: "{{ element_type }}" + fields: + - name: "{{ name }}" + field_type: + type: "{{ type }}" + nullable: {{ nullable }} + length: {{ length }} + precision: {{ precision }} + scale: {{ scale }} + key_type: "{{ key_type }}" + value_type: "{{ value_type }}" + element_type: "{{ element_type }}" + fields: "{{ fields }}" + resolution: "{{ resolution }}" + fractional_precision: {{ fractional_precision }} + class_name: "{{ class_name }}" + description: "{{ description }}" + resolution: "{{ resolution }}" + fractional_precision: {{ fractional_precision }} + class_name: "{{ class_name }}" + element_type: + type: "{{ type }}" + nullable: {{ nullable }} + length: {{ length }} + precision: {{ precision }} + scale: {{ scale }} + key_type: + type: "{{ type }}" + nullable: {{ nullable }} + length: {{ length }} + precision: {{ precision }} + scale: {{ scale }} + key_type: "{{ key_type }}" + value_type: "{{ value_type }}" + element_type: "{{ element_type }}" + fields: "{{ fields }}" + resolution: "{{ resolution }}" + fractional_precision: {{ fractional_precision }} + class_name: "{{ class_name }}" + value_type: + type: "{{ type }}" + nullable: {{ nullable }} + length: {{ length }} + precision: {{ precision }} + scale: {{ scale }} + key_type: "{{ key_type }}" + value_type: "{{ value_type }}" + element_type: "{{ element_type }}" + fields: "{{ fields }}" + resolution: "{{ resolution }}" + fractional_precision: {{ fractional_precision }} + class_name: "{{ class_name }}" + element_type: "{{ element_type }}" + fields: + - name: "{{ name }}" + field_type: + type: "{{ type }}" + nullable: {{ nullable }} + length: {{ length }} + precision: {{ precision }} + scale: {{ scale }} + key_type: "{{ key_type }}" + value_type: "{{ value_type }}" + element_type: "{{ element_type }}" + fields: "{{ fields }}" + resolution: "{{ resolution }}" + fractional_precision: {{ fractional_precision }} + class_name: "{{ class_name }}" + description: "{{ description }}" + resolution: "{{ resolution }}" + fractional_precision: {{ fractional_precision }} + class_name: "{{ class_name }}" + fields: + - name: "{{ name }}" + field_type: + type: "{{ type }}" + nullable: {{ nullable }} + length: {{ length }} + precision: {{ precision }} + scale: {{ scale }} + key_type: "{{ key_type }}" + value_type: "{{ value_type }}" + element_type: "{{ element_type }}" + fields: "{{ fields }}" + resolution: "{{ resolution }}" + fractional_precision: {{ fractional_precision }} + class_name: "{{ class_name }}" + description: "{{ description }}" + resolution: "{{ resolution }}" + fractional_precision: {{ fractional_precision }} + class_name: "{{ class_name }}" + comment: "{{ comment }}" + kind: "{{ kind }}" + metadata_key: "{{ metadata_key }}" + virtual: {{ virtual }} + expression: "{{ expression }}" + watermark: + column: "{{ column }}" + expression: "{{ expression }}" + constraints: + - name: "{{ name }}" + type: "{{ type }}" + columns: "{{ columns }}" + enforced: {{ enforced }} + distribution: + kind: "{{ kind }}" + keys: + - "{{ keys }}" + bucket_count: {{ bucket_count }} + query: "{{ query }}" +`} + + + + + +## `REPLACE` examples + + + + +Make a request to update a Materialized Table's mutable fields.
Mutable fields include: `query`, `stopped`, `compute_pool_id`, `principal`, `columns`, `watermark`, `constraints` and `table_options`.
+ +```sql +REPLACE confluent.sql.materialized_tables +SET +name = '{{ name }}', +spec = '{{ spec }}' +WHERE +organization_id = '{{ organization_id }}' --required +AND environment_id = '{{ environment_id }}' --required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' --required +AND table_name = '{{ table_name }}' --required +AND name = '{{ name }}' --required +AND spec = '{{ spec }}' --required +RETURNING +name, +environment_id, +organization_id, +api_version, +kind, +metadata, +spec, +status; +``` + + + + +## `DELETE` examples + + + + +Delete a specific Materialized Table by name.
+ +```sql +DELETE FROM confluent.sql.materialized_tables +WHERE organization_id = '{{ organization_id }}' --required +AND environment_id = '{{ environment_id }}' --required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' --required +AND table_name = '{{ table_name }}' --required +; +``` + + diff --git a/website/docs/services/sql/statement_exceptions/index.md b/website/docs/services/sql/statement_exceptions/index.md index bb2c9a6..ce7bab0 100644 --- a/website/docs/services/sql/statement_exceptions/index.md +++ b/website/docs/services/sql/statement_exceptions/index.md @@ -1,4 +1,4 @@ ---- +--- title: statement_exceptions hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,28 +23,126 @@ Creates, updates, deletes, gets or lists a statement_exceptions res ## Overview - +
Namestatement_exceptions
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | Name of the SQL statement exception. | -| | `string` | Kind defines the object this REST resource represents. | -| | `string` | Error message of the statement exception. | -| | `string` | The date and time at which the exception occurred. It is represented in RFC3339 format and is in UTC. | + +The following fields are returned by `SELECT` queries: + + + + +Statement Exceptions. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the SQL statement exception. (example: java.lang.RuntimeException)
stringKind defines the object this REST resource represents. (StatementException)
stringError message of the statement exception. (example: java.lang.RuntimeException: An error occurred)
string (date-time)The date and time at which the exception occurred. It is represented in RFC3339 format and is in UTC. (example: 2025-11-10T16:20:00Z)
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a list of the 10 most recent statement exceptions. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
organization_id, environment_id, statement_nameRetrieve a list of the 10 most recent statement exceptions.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the environment.
string (uuid)The unique identifier for the organization.
stringThe unique identifier for the statement.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a list of the 10 most recent statement exceptions. + + +Retrieve a list of the 10 most recent statement exceptions. ```sql SELECT @@ -52,7 +151,10 @@ kind, message, timestamp FROM confluent.sql.statement_exceptions -WHERE environment_id = '{{ environment_id }}' -AND organization_id = '{{ organization_id }}' -AND statement_name = '{{ statement_name }}'; -``` \ No newline at end of file +WHERE organization_id = '{{ organization_id }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND statement_name = '{{ statement_name }}' -- required +; +``` + + diff --git a/website/docs/services/sql/statement_results/index.md b/website/docs/services/sql/statement_results/index.md index 92844b7..c1fc4b1 100644 --- a/website/docs/services/sql/statement_results/index.md +++ b/website/docs/services/sql/statement_results/index.md @@ -1,4 +1,4 @@ ---- +--- title: statement_results hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,39 +23,144 @@ Creates, updates, deletes, gets or lists a statement_results resour ## Overview - +
Namestatement_results
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `object` | ListMeta describes metadata that resource collections may have | -| | `object` | A results property that contains a data property that contains an array of results. | + +The following fields are returned by `SELECT` queries: + + + + +Statement Result. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAPIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
stringKind defines the object this REST resource represents. (StatementResult)
objectListMeta describes metadata that resource collections may have
objectA results property that contains a data property that contains an array of results.
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Read Statement Result. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
organization_id, environment_id, namepage_tokenRead Statement Result.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the environment.
stringThe unique identifier for the statement.
string (uuid)The unique identifier for the organization.
stringIt contains the field offset in the CollectSinkFunction protocol. On the first request, it should be unset. The offset is assumed to start at 0.
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Read Statement Result. + + +Read Statement Result. ```sql SELECT -_results, api_version, kind, metadata, results FROM confluent.sql.statement_results -WHERE environment_id = '{{ environment_id }}' -AND name = '{{ name }}' -AND organization_id = '{{ organization_id }}'; -``` \ No newline at end of file +WHERE organization_id = '{{ organization_id }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND name = '{{ name }}' -- required +AND page_token = '{{ page_token }}' +; +``` + + diff --git a/website/docs/services/sql/statements/index.md b/website/docs/services/sql/statements/index.md index 469bf83..4f3ce25 100644 --- a/website/docs/services/sql/statements/index.md +++ b/website/docs/services/sql/statements/index.md @@ -1,4 +1,4 @@ ---- +--- title: statements hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,171 +23,496 @@ Creates, updates, deletes, gets or lists a statements resource. ## Overview - +
Namestatements
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The user provided name of the resource, unique within this environment. | -| | `object` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | The unique identifier for the environment. | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | The metadata of the statement. | -| | `string` | The unique identifier for the organization. | -| | `object` | `Statement Result` represents a resource used to model results of SQL statements. The API allows you to read your SQL statement result. | -| | `object` | The specs of the Statement | -| | `object` | The status of the Statement | + +The following fields are returned by `SELECT` queries: + + + + +Statement. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe user provided name of the resource, unique within this environment. (example: sql123, pattern: [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)
stringThe unique identifier for the environment.
string (uuid)The unique identifier for the organization.
stringAPIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
stringKind defines the object this REST resource represents. (Statement)
objectThe metadata of the statement.
object`Statement Result` represents a resource used to model results of SQL statements. The API allows you to read your SQL statement result.
objectThe specs of the Statement
objectThe status of the Statement
+ + + +Statements. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe user provided name of the resource, unique within this environment. (example: sql123, pattern: [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)
stringThe unique identifier for the environment.
string (uuid)The unique identifier for the organization.
stringAPIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
stringKind defines the object this REST resource represents. (Statement)
objectThe metadata of the statement.
object`Statement Result` represents a resource used to model results of SQL statements. The API allows you to read your SQL statement result.
objectThe specs of the Statement
objectThe status of the Statement
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a statement. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all statements. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to create a statement. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a statement. | -| | `UPDATE` | | [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to patch a statement. | -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a statement. The request will fail with a 409 Conflict error if the Statement has changed since it was fetched. In this case, do a GET, reapply the modifications, and try the update again. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
organization_id, environment_id, statement_nameMake a request to read a statement.
organization_id, environment_idspec.compute_pool_id, page_size, page_token, label_selectorRetrieve a sorted, filtered, paginated list of all statements.
organization_id, environment_id, spec, nameMake a request to create a statement.
organization_id, environment_id, statement_nameMake a request to patch a statement.
organization_id, environment_id, statement_name, spec, name, metadataMake a request to update a statement.
The request will fail with a 409 Conflict error if the Statement has changed since it was fetched.
In this case, do a GET, reapply the modifications, and try the update again.
organization_id, environment_id, statement_nameMake a request to delete a statement.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the environment.
string (uuid)The unique identifier for the organization.
stringThe unique identifier for the statement.
stringA comma-separated label selector to filter the statements.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for spec.compute_pool_id. When creating statements, if compute_pool_id is not specified, the statement will use the default compute pool. The default pool is automatically determined by the system. (example: lfcp-00000)
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all statements. + + +Make a request to read a statement. ```sql SELECT name, -_spec, -api_version, environment_id, +organization_id, +api_version, kind, metadata, -organization_id, result, spec, status FROM confluent.sql.statements -WHERE environment_id = '{{ environment_id }}' -AND organization_id = '{{ organization_id }}'; +WHERE organization_id = '{{ organization_id }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND statement_name = '{{ statement_name }}' -- required +; ``` -## `INSERT` example + + -Use the following StackQL query and manifest file to create a new statements resource. - - - +Retrieve a sorted, filtered, paginated list of all statements. ```sql -/*+ create */ -INSERT INTO confluent.sql.statements ( -data__name, -data__organization_id, -data__environment_id, -data__spec, -data__result, +SELECT +name, environment_id, -organization_id -) -SELECT -'{{ name }}', -'{{ organization_id }}', -'{{ environment_id }}', -'{{ spec }}', -'{{ result }}' +organization_id, +api_version, +kind, +metadata, +result, +spec, +status +FROM confluent.sql.statements +WHERE organization_id = '{{ organization_id }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND spec.compute_pool_id = '{{ spec.compute_pool_id }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +AND label_selector = '{{ label_selector }}' ; ``` + + - +## `INSERT` examples + + + + +Make a request to create a statement. ```sql -/*+ create */ INSERT INTO confluent.sql.statements ( -data__spec, -data__name, +name, +organization_id, environment_id, -organization_id +spec, +result, +organization_id, +environment_id ) SELECT -'{{ spec }}', -'{{ name }}', +'{{ name }}' /* required */, +'{{ organization_id }}', '{{ environment_id }}', -'{{ organization_id }}' +'{{ spec }}' /* required */, +'{{ result }}', +'{{ organization_id }}', +'{{ environment_id }}' +RETURNING +name, +environment_id, +organization_id, +api_version, +kind, +metadata, +result, +spec, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: statements props: - - name: environment_id - value: string - name: organization_id - value: string + value: "{{ organization_id }}" + description: Required parameter for the statements resource. + - name: environment_id + value: "{{ environment_id }}" + description: Required parameter for the statements resource. - name: name - value: string + value: "{{ name }}" + description: | + The user provided name of the resource, unique within this environment. - name: organization_id - value: string + value: "{{ organization_id }}" + description: | + The unique identifier for the organization. - name: environment_id - value: string + value: "{{ environment_id }}" + description: | + The unique identifier for the environment. - name: spec - value: object + description: | + The specs of the Statement + value: + statement: "{{ statement }}" + properties: "{{ properties }}" + compute_pool_id: "{{ compute_pool_id }}" + principal: "{{ principal }}" + stopped: {{ stopped }} + execution_mode: "{{ execution_mode }}" - name: result - props: - - name: api_version - value: string - - name: kind - value: string - - name: metadata - props: - - name: self - value: string - - name: next - value: string - - name: results - props: - - name: data - value: array + description: | + \`Statement Result\` represents a resource used to model results of SQL statements. + The API allows you to read your SQL statement result. + value: + api_version: "{{ api_version }}" + kind: "{{ kind }}" + metadata: + self: "{{ self }}" + next: "{{ next }}" + created_at: "{{ created_at }}" + results: + data: "{{ data }}" +`} -``` -## `UPDATE` example -Updates a statements resource. +## `UPDATE` examples + + + + +Make a request to patch a statement. ```sql -/*+ update */ UPDATE confluent.sql.statements SET +-- No updatable properties +WHERE +organization_id = '{{ organization_id }}' --required +AND environment_id = '{{ environment_id }}' --required +AND statement_name = '{{ statement_name }}' --required +RETURNING +name, +environment_id, +organization_id, +api_version, +kind, +metadata, +result, +spec, +status; +``` + + + + +## `REPLACE` examples + + + +Make a request to update a statement.
The request will fail with a 409 Conflict error if the Statement has changed since it was fetched.
In this case, do a GET, reapply the modifications, and try the update again. + +```sql +REPLACE confluent.sql.statements +SET +name = '{{ name }}', +organization_id = '{{ organization_id }}', +environment_id = '{{ environment_id }}', +spec = '{{ spec }}', +result = '{{ result }}' WHERE -environment_id = '{{ environment_id }}' -AND organization_id = '{{ organization_id }}' -AND statement_name = '{{ statement_name }}'; +organization_id = '{{ organization_id }}' --required +AND environment_id = '{{ environment_id }}' --required +AND statement_name = '{{ statement_name }}' --required +AND spec = '{{ spec }}' --required +AND name = '{{ name }}' --required; ``` + + + -## `DELETE` example +## `DELETE` examples -Deletes the specified statements resource. + + + +Make a request to delete a statement. ```sql -/*+ delete */ DELETE FROM confluent.sql.statements -WHERE environment_id = '{{ environment_id }}' -AND organization_id = '{{ organization_id }}' -AND statement_name = '{{ statement_name }}'; +WHERE organization_id = '{{ organization_id }}' --required +AND environment_id = '{{ environment_id }}' --required +AND statement_name = '{{ statement_name }}' --required +; ``` + + diff --git a/website/docs/services/sql/tools/index.md b/website/docs/services/sql/tools/index.md new file mode 100644 index 0000000..dc4ed03 --- /dev/null +++ b/website/docs/services/sql/tools/index.md @@ -0,0 +1,372 @@ +--- +title: tools +hide_title: false +hide_table_of_contents: false +keywords: + - tools + - sql + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a tools resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Tool. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe user provided name of the tool, unique within this environment. (example: linear-mcp-tool, pattern: [a-z0-9_]([-a-z0-9_]*[a-z0-9_])?)
stringAPIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
stringKind defines the object this REST resource represents. (Tool)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe spec of the Tool. A tool must reference either a `connection` (for MCP or A2A tools) or a `function` (for function-based tools), but not both.
objectThe status of the Tool
+ + + +Tools. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe user provided name of the tool, unique within this environment. (example: linear-mcp-tool, pattern: [a-z0-9_]([-a-z0-9_]*[a-z0-9_])?)
stringAPIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
stringKind defines the object this REST resource represents. (Tool)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe spec of the Tool. A tool must reference either a `connection` (for MCP or A2A tools) or a `function` (for function-based tools), but not both.
objectThe status of the Tool
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
organization_id, environment_id, database_name, tool_nameMake a request to read a Tool.
organization_id, environment_id, database_namepage_size, page_tokenRetrieve a sorted, filtered, paginated list of all Tools.
organization_id, environment_id, database_name, name, specMake a request to create a Tool.
organization_id, environment_id, database_name, tool_nameMake a request to delete a Tool.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the database.
stringThe unique identifier for the environment.
string (uuid)The unique identifier for the organization.
stringThe user provided name of the Tool.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
+ +## `SELECT` examples + + + + +Make a request to read a Tool. + +```sql +SELECT +name, +api_version, +kind, +metadata, +spec, +status +FROM confluent.sql.tools +WHERE organization_id = '{{ organization_id }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND database_name = '{{ database_name }}' -- required +AND tool_name = '{{ tool_name }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all Tools. + +```sql +SELECT +name, +api_version, +kind, +metadata, +spec, +status +FROM confluent.sql.tools +WHERE organization_id = '{{ organization_id }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND database_name = '{{ database_name }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples + + + + +Make a request to create a Tool. + +```sql +INSERT INTO confluent.sql.tools ( +name, +spec, +organization_id, +environment_id, +database_name +) +SELECT +'{{ name }}' /* required */, +'{{ spec }}' /* required */, +'{{ organization_id }}', +'{{ environment_id }}', +'{{ database_name }}' +RETURNING +name, +api_version, +kind, +metadata, +spec, +status +; +``` + + + +{`# Description fields are for documentation purposes +- name: tools + props: + - name: organization_id + value: "{{ organization_id }}" + description: Required parameter for the tools resource. + - name: environment_id + value: "{{ environment_id }}" + description: Required parameter for the tools resource. + - name: database_name + value: "{{ database_name }}" + description: Required parameter for the tools resource. + - name: name + value: "{{ name }}" + description: | + The user provided name of the tool, unique within this environment. + - name: spec + description: | + The spec of the Tool. A tool must reference either a \`connection\` (for MCP or A2A tools) + or a \`function\` (for function-based tools), but not both. + value: + connection: "{{ connection }}" + function: "{{ function }}" + comment: "{{ comment }}" + options: "{{ options }}" +`} + + + + + +## `DELETE` examples + + + + +Make a request to delete a Tool. + +```sql +DELETE FROM confluent.sql.tools +WHERE organization_id = '{{ organization_id }}' --required +AND environment_id = '{{ environment_id }}' --required +AND database_name = '{{ database_name }}' --required +AND tool_name = '{{ tool_name }}' --required +; +``` + + diff --git a/website/docs/services/stream_sharing/consumer_shared_resources/index.md b/website/docs/services/stream_sharing/consumer_shared_resources/index.md index 6ebb535..769fac9 100644 --- a/website/docs/services/stream_sharing/consumer_shared_resources/index.md +++ b/website/docs/services/stream_sharing/consumer_shared_resources/index.md @@ -1,4 +1,4 @@ ---- +--- title: consumer_shared_resources hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,58 +23,363 @@ Creates, updates, deletes, gets or lists a consumer_shared_resources -Nameconsumer_shared_resources +Name TypeResource Id ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | Description of consumer resource | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | The cloud service provider of the provider shared cluster. | -| | `string` | Consumer resource display name | -| | `string` | Kind defines the object this REST resource represents. | -| | `string` | Resource logo url | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `array` | The network connection types of the provider shared cluster. If the shared cluster is on public internet, then the list will be empty | -| | `string` | Email of the shared resource's organization contact | -| | `string` | Shared resource's organization description | -| | `string` | Shared resource's organization name | -| | `array` | List of schemas in JSON format. This field is work in progress and subject to changes. | -| | `array` | list of tags | + +The following fields are returned by `SELECT` queries: + + + + +Consumer Shared Resource. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringConsumer resource display name (example: Stock Trades)
stringShared resource's organization name (example: ABC Corp)
stringAPIVersion defines the schema version of this representation of a resource. (cdx/v1)
stringThe cloud service provider of the provider shared cluster. (example: AWS)
stringDescription of consumer resource (example: This topic provides realtime data for the orders placed through the website)
stringKind defines the object this REST resource represents. (ConsumerSharedResource)
string (uri)Resource logo url (example: https://confluent.cloud/api/cdx/v1/consumer-shared-resources/sr-123/images/logo)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
arrayThe network connection types of the provider shared cluster. If the shared cluster is on public internet, then the list will be empty
string (email)Email of the shared resource's organization contact (example: jane.doe@example.com)
stringShared resource's organization description (example: ABC Corp is the biggest online retailer)
arrayList of schemas in JSON format. This field is work in progress and subject to changes.
arraylist of tags
+ + + +Consumer Shared Resource. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringConsumer resource display name (example: Stock Trades)
stringShared resource's organization name (example: ABC Corp)
stringAPIVersion defines the schema version of this representation of a resource. (cdx/v1)
stringThe cloud service provider of the provider shared cluster. (example: AWS)
stringDescription of consumer resource (example: This topic provides realtime data for the orders placed through the website)
stringKind defines the object this REST resource represents. (ConsumerSharedResource)
string (uri)Resource logo url (example: https://confluent.cloud/api/cdx/v1/consumer-shared-resources/sr-123/images/logo)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
arrayThe network connection types of the provider shared cluster. If the shared cluster is on public internet, then the list will be empty
string (email)Email of the shared resource's organization contact (example: jane.doe@example.com)
stringShared resource's organization description (example: ABC Corp is the biggest online retailer)
arrayList of schemas in JSON format. This field is work in progress and subject to changes.
arraylist of tags
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a consumer shared resource. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all consumer shared resources. | -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the image file for the shared resource | -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns network information of the shared resource | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a consumer shared resource.
stream_share, include_deleted, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all consumer shared resources.
id, file_nameReturns the image file for the shared resource
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe File Name
stringThe unique identifier for the consumer shared resource.
booleanInclude deactivated shared resources
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for stream_share. (example: ss-1234)
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all consumer shared resources. + + +Make a request to read a consumer shared resource. ```sql SELECT id, -description, +display_name, +organization_name, api_version, cloud, -display_name, +description, kind, logo_url, metadata, network_connection_types, organization_contact, organization_description, +schemas, +tags +FROM confluent.stream_sharing.consumer_shared_resources +WHERE id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all consumer shared resources. + +```sql +SELECT +id, +display_name, organization_name, +api_version, +cloud, +description, +kind, +logo_url, +metadata, +network_connection_types, +organization_contact, +organization_description, schemas, tags FROM confluent.stream_sharing.consumer_shared_resources +WHERE stream_share = '{{ stream_share }}' +AND include_deleted = '{{ include_deleted }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## Lifecycle Methods + + + + +Returns the image file for the shared resource + +```sql +EXEC confluent.stream_sharing.consumer_shared_resources.image_cdx_v1_consumer_shared_resource +@id='{{ id }}' --required, +@file_name='{{ file_name }}' --required ; -``` \ No newline at end of file +``` + + diff --git a/website/docs/services/stream_sharing/consumer_shares/index.md b/website/docs/services/stream_sharing/consumer_shares/index.md index 91d7be2..8f37240 100644 --- a/website/docs/services/stream_sharing/consumer_shares/index.md +++ b/website/docs/services/stream_sharing/consumer_shares/index.md @@ -1,4 +1,4 @@ ---- +--- title: consumer_shares hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,60 +23,321 @@ Creates, updates, deletes, gets or lists a consumer_shares resource ## Overview - +
Nameconsumer_shares
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Consumer organization name. Deprecated | -| | `object` | The consumer user/invitee | -| | `string` | Name of the consumer. Deprecated | -| | `string` | The date and time at which the invitation will expire. Only for invited shares | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `string` | Provider organization name | -| | `string` | Name or email of the provider user | -| | `object` | The status of the Consumer Share | + +The following fields are returned by `SELECT` queries: + + + + +Consumer Share. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringConsumer organization name. Deprecated (example: Nasdaq)
stringName of the consumer. Deprecated (example: John Doe)
stringProvider organization name (example: Nasdaq)
stringName or email of the provider user (example: Jane Doe)
stringAPIVersion defines the schema version of this representation of a resource. (cdx/v1)
objectThe consumer user/invitee
string (date-time)The date and time at which the invitation will expire. Only for invited shares (example: 2006-01-02T15:04:05-07:00)
stringKind defines the object this REST resource represents. (ConsumerShare)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe status of the Consumer Share
+ + + +Consumer Share. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringConsumer organization name. Deprecated (example: Nasdaq)
stringName of the consumer. Deprecated (example: John Doe)
stringProvider organization name (example: Nasdaq)
stringName or email of the provider user (example: Jane Doe)
stringAPIVersion defines the schema version of this representation of a resource. (cdx/v1)
objectThe consumer user/invitee
string (date-time)The date and time at which the invitation will expire. Only for invited shares (example: 2006-01-02T15:04:05-07:00)
stringKind defines the object this REST resource represents. (ConsumerShare)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe status of the Consumer Share
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a consumer share. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all consumer shares. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a consumer share. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a consumer share.
shared_resource, include_deleted, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all consumer shares.
idMake a request to delete a consumer share.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the consumer share.
booleanInclude deactivated shares
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for shared_resource. (example: sr-1234)
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all consumer shares. + + +Make a request to read a consumer share. ```sql SELECT id, -api_version, consumer_organization_name, -consumer_user, consumer_user_name, +provider_organization_name, +provider_user_name, +api_version, +consumer_user, invite_expires_at, kind, metadata, +status +FROM confluent.stream_sharing.consumer_shares +WHERE id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all consumer shares. + +```sql +SELECT +id, +consumer_organization_name, +consumer_user_name, provider_organization_name, provider_user_name, +api_version, +consumer_user, +invite_expires_at, +kind, +metadata, status FROM confluent.stream_sharing.consumer_shares +WHERE shared_resource = '{{ shared_resource }}' +AND include_deleted = '{{ include_deleted }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` -## `DELETE` example + + -Deletes the specified consumer_shares resource. + +## `DELETE` examples + + + + +Make a request to delete a consumer share. ```sql -/*+ delete */ DELETE FROM confluent.stream_sharing.consumer_shares -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; ``` + + diff --git a/website/docs/services/stream_sharing/index.md b/website/docs/services/stream_sharing/index.md index 431b7d3..5591296 100644 --- a/website/docs/services/stream_sharing/index.md +++ b/website/docs/services/stream_sharing/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png stream_sharing service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 6
-
-
+total resources: __7__ ::: @@ -31,11 +27,12 @@ stream_sharing service documentation.
consumer_shared_resources
consumer_shares
-opt_ins +opt_ins
+provider_shared_resources
-provider_shared_resources
provider_shares
+shared_resources_network_config
shared_tokens
\ No newline at end of file diff --git a/website/docs/services/stream_sharing/opt_ins/index.md b/website/docs/services/stream_sharing/opt_ins/index.md index e30777b..4717ae9 100644 --- a/website/docs/services/stream_sharing/opt_ins/index.md +++ b/website/docs/services/stream_sharing/opt_ins/index.md @@ -1,4 +1,4 @@ ---- +--- title: opt_ins hide_title: false hide_table_of_contents: false @@ -15,35 +15,121 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a opt_ins resource. +Creates, updates, deletes, gets or lists an opt_ins resource. ## Overview - +
Nameopt_ins
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `string` | Kind defines the object this REST resource represents. | -| | `boolean` | Enable stream sharing for the organization | + +The following fields are returned by `SELECT` queries: + + + + +Opt In. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAPIVersion defines the schema version of this representation of a resource. (cdx/v1)
stringKind defines the object this REST resource represents. (OptIn)
booleanEnable stream sharing for the organization
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the organization's stream sharing opt-in settings. | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Updates the organization's stream sharing opt-in settings. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Returns the organization's stream sharing opt-in settings.
Updates the organization's stream sharing opt-in settings.


+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the organization's stream sharing opt-in settings. + + +Returns the organization's stream sharing opt-in settings.
```sql SELECT @@ -53,15 +139,30 @@ stream_share_enabled FROM confluent.stream_sharing.opt_ins ; ``` -## `UPDATE` example + + + + +## `UPDATE` examples -Updates a opt_ins resource. + + + +Updates the organization's stream sharing opt-in settings.


```sql -/*+ update */ UPDATE confluent.stream_sharing.opt_ins SET -stream_share_enabled = true|false -WHERE -; +stream_share_enabled = {{ stream_share_enabled }} +RETURNING +api_version, +kind, +stream_share_enabled; ``` + + diff --git a/website/docs/services/stream_sharing/provider_shared_resources/index.md b/website/docs/services/stream_sharing/provider_shared_resources/index.md index 9ffedfa..58c970b 100644 --- a/website/docs/services/stream_sharing/provider_shared_resources/index.md +++ b/website/docs/services/stream_sharing/provider_shared_resources/index.md @@ -1,4 +1,4 @@ ---- +--- title: provider_shared_resources hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,94 +23,506 @@ Creates, updates, deletes, gets or lists a provider_shared_resources -Nameprovider_shared_resources +Name TypeResource Id ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `string` | Description of shared resource | -| | `` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `object` | The cloud cluster to which this belongs. | -| | `string` | The cluster display name of the shared resource. Deprecated | -| | `string` | Deprecated please use resources attribute. | -| | `string` | Shared resource display name | -| | `string` | The environment name of the shared resource. Deprecated | -| | `string` | Kind defines the object this REST resource represents. | -| | `string` | Resource logo url | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `string` | Email of contact person from the organization | -| | `string` | Shared resource's organization description | -| | `` | Organization to which the shared resource belongs. Deprecated | -| | `array` | List of resource crns that are shared together | -| | `array` | List of schemas in JSON format. This field is work in progress and subject to changes. | -| | `array` | list of tags | + +The following fields are returned by `SELECT` queries: + + + + +Provider Shared Resource. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe cluster display name of the shared resource. Deprecated (example: Published Trades)
stringShared resource display name (example: Stock Trades)
stringThe environment name of the shared resource. Deprecated (example: Public Env)
Organization to which the shared resource belongs. Deprecated (example: ABC Corp)
stringAPIVersion defines the schema version of this representation of a resource. (cdx/v1)
objectThe cloud cluster to which this belongs.
string (uri)Deprecated please use resources attribute. (pattern: ^crn://.+$, example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic)
stringDescription of shared resource (example: This topic provides realtime data for the orders placed through the website)
stringKind defines the object this REST resource represents. (ProviderSharedResource)
string (uri)Resource logo url (example: https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
string (email)Email of contact person from the organization (example: jane.doe@example.com)
stringShared resource's organization description (example: ABC Corp is the biggest online retailer)
arrayList of resource crns that are shared together
arrayList of schemas in JSON format. This field is work in progress and subject to changes.
arraylist of tags
+ + + +Provider Shared Resource. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe cluster display name of the shared resource. Deprecated (example: Published Trades)
stringShared resource display name (example: Stock Trades)
stringThe environment name of the shared resource. Deprecated (example: Public Env)
Organization to which the shared resource belongs. Deprecated (example: ABC Corp)
stringAPIVersion defines the schema version of this representation of a resource. (cdx/v1)
objectThe cloud cluster to which this belongs.
string (uri)Deprecated please use resources attribute. (pattern: ^crn://.+$, example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic)
stringDescription of shared resource (example: This topic provides realtime data for the orders placed through the website)
stringKind defines the object this REST resource represents. (ProviderSharedResource)
string (uri)Resource logo url (example: https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
string (email)Email of contact person from the organization (example: jane.doe@example.com)
stringShared resource's organization description (example: ABC Corp is the biggest online retailer)
arrayList of resource crns that are shared together
arrayList of schemas in JSON format. This field is work in progress and subject to changes.
arraylist of tags
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a provider shared resource. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all provider shared resources. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Deletes the image file for the shared resource | -| | `UPDATE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a provider shared resource. | -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Upload the image file for the shared resource | -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the image file for the shared resource | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a provider shared resource.
stream_share, crn, include_deleted, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all provider shared resources.
idMake a request to update a provider shared resource.

id, file_nameDeletes the image file for the shared resource
id, file_nameUpload the image file for the shared resource
id, file_nameReturns the image file for the shared resource
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe File Name
stringThe unique identifier for the provider shared resource.
stringFilter the results by exact match for crn. (example: crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic)
booleanInclude deactivated shared resources
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for stream_share. (example: ss-1234)
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all provider shared resources. + + +Make a request to read a provider shared resource. ```sql SELECT id, -description, -_cloud_cluster, +cluster_name, +display_name, +environment_name, +organization_name, api_version, cloud_cluster, -cluster_name, crn, +description, +kind, +logo_url, +metadata, +organization_contact, +organization_description, +resources, +schemas, +tags +FROM confluent.stream_sharing.provider_shared_resources +WHERE id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all provider shared resources. + +```sql +SELECT +id, +cluster_name, display_name, environment_name, +organization_name, +api_version, +cloud_cluster, +crn, +description, kind, logo_url, metadata, organization_contact, organization_description, -organization_name, resources, schemas, tags FROM confluent.stream_sharing.provider_shared_resources +WHERE stream_share = '{{ stream_share }}' +AND crn = '{{ crn }}' +AND include_deleted = '{{ include_deleted }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` -## `UPDATE` example + + + + +## `UPDATE` examples -Updates a provider_shared_resources resource. + + + +Make a request to update a provider shared resource.

```sql -/*+ update */ UPDATE confluent.stream_sharing.provider_shared_resources SET +crn = '{{ crn }}', resources = '{{ resources }}', display_name = '{{ display_name }}', organization_description = '{{ organization_description }}', -organization_contact = '{{ organization_contact }}' +organization_contact = '{{ organization_contact }}', +cloud_cluster = '{{ cloud_cluster }}' WHERE -id = '{{ id }}'; +id = '{{ id }}' --required +RETURNING +id, +cluster_name, +display_name, +environment_name, +organization_name, +api_version, +cloud_cluster, +crn, +description, +kind, +logo_url, +metadata, +organization_contact, +organization_description, +resources, +schemas, +tags; ``` + + + + +## `DELETE` examples -## `DELETE` example + + -Deletes the specified provider_shared_resources resource. +Deletes the image file for the shared resource ```sql -/*+ delete */ DELETE FROM confluent.stream_sharing.provider_shared_resources -WHERE file_name = '{{ file_name }}' -AND id = '{{ id }}'; +WHERE id = '{{ id }}' --required +AND file_name = '{{ file_name }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Upload the image file for the shared resource + +```sql +EXEC confluent.stream_sharing.provider_shared_resources.upload_image_cdx_v1_provider_shared_resource +@id='{{ id }}' --required, +@file_name='{{ file_name }}' --required +; +``` + + + +Returns the image file for the shared resource + +```sql +EXEC confluent.stream_sharing.provider_shared_resources.view_image_cdx_v1_provider_shared_resource +@id='{{ id }}' --required, +@file_name='{{ file_name }}' --required +; ``` + + diff --git a/website/docs/services/stream_sharing/provider_shares/index.md b/website/docs/services/stream_sharing/provider_shares/index.md index 2030eff..fde020e 100644 --- a/website/docs/services/stream_sharing/provider_shares/index.md +++ b/website/docs/services/stream_sharing/provider_shares/index.md @@ -1,4 +1,4 @@ ---- +--- title: provider_shares hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,125 +23,491 @@ Creates, updates, deletes, gets or lists a provider_shares resource ## Overview - +
Nameprovider_shares
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | -| | `` | | -| | `` | | -| | `string` | APIVersion defines the schema version of this representation of a resource. | -| | `object` | The cloud cluster to which this belongs. | -| | `string` | Consumer organization name | -| | `` | Restrictions on the consumer that can redeem this token | -| | `string` | Name of the consumer | -| | `string` | Method by which the invite will be delivered | -| | `string` | The date and time at which the invitation will expire. Only for invited shares | -| | `string` | The date and time at which consumer was invited | -| | `string` | Kind defines the object this REST resource represents. | -| | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | -| | `object` | The provider user/inviter | -| | `string` | Name or email of the provider user. Deprecated | -| | `string` | The date and time at which the invite was redeemed | -| | `object` | The service account associated with this object. | -| | `object` | The status of the Provider Share | + +The following fields are returned by `SELECT` queries: + + + + +Provider Share. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringConsumer organization name (example: Nasdaq)
stringName of the consumer (example: John Doe)
stringName or email of the provider user. Deprecated (example: Jane Doe)
stringAPIVersion defines the schema version of this representation of a resource. (cdx/v1)
objectThe cloud cluster to which this belongs.
objectRestrictions on the consumer that can redeem this token
stringMethod by which the invite will be delivered (example: EMAIL)
string (date-time)The date and time at which the invitation will expire. Only for invited shares (example: 2006-01-02T15:04:05-07:00)
string (date-time)The date and time at which consumer was invited (example: 2006-01-02T15:04:05-07:00)
stringKind defines the object this REST resource represents. (ProviderShare)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe provider user/inviter
string (date-time)The date and time at which the invite was redeemed (example: 2006-01-02T15:04:05-07:00)
objectThe service account associated with this object.
objectThe status of the Provider Share
+ + + +Provider Share. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringConsumer organization name (example: Nasdaq)
stringName of the consumer (example: John Doe)
stringName or email of the provider user. Deprecated (example: Jane Doe)
stringAPIVersion defines the schema version of this representation of a resource. (cdx/v1)
objectThe cloud cluster to which this belongs.
objectRestrictions on the consumer that can redeem this token
stringMethod by which the invite will be delivered (example: EMAIL)
string (date-time)The date and time at which the invitation will expire. Only for invited shares (example: 2006-01-02T15:04:05-07:00)
string (date-time)The date and time at which consumer was invited (example: 2006-01-02T15:04:05-07:00)
stringKind defines the object this REST resource represents. (ProviderShare)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe provider user/inviter
string (date-time)The date and time at which the invite was redeemed (example: 2006-01-02T15:04:05-07:00)
objectThe service account associated with this object.
objectThe status of the Provider Share
+ + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to read a provider share. | -| | `SELECT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all provider shares. | -| | `INSERT` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Creates a share based on delivery method. | -| | `DELETE` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to delete a provider share. | -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Resend provider share | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idMake a request to read a provider share.
shared_resource, crn, include_deleted, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all provider shares.
delivery_method, consumer_restriction, resourcesCreates a share based on delivery method.
idMake a request to delete a provider share.
idResend provider share
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the provider share.
stringFilter the results by exact match for crn. (example: crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic)
booleanInclude deactivated shares
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
stringFilter the results by exact match for shared_resource. (example: sr-1234)
## `SELECT` examples -[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all provider shares. + + +Make a request to read a provider share. ```sql SELECT id, -_cloud_cluster, -_service_account, +consumer_organization_name, +consumer_user_name, +provider_user_name, api_version, cloud_cluster, -consumer_organization_name, consumer_restriction, -consumer_user_name, delivery_method, invite_expires_at, invited_at, kind, metadata, provider_user, +redeemed_at, +service_account, +status +FROM confluent.stream_sharing.provider_shares +WHERE id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all provider shares. + +```sql +SELECT +id, +consumer_organization_name, +consumer_user_name, provider_user_name, +api_version, +cloud_cluster, +consumer_restriction, +delivery_method, +invite_expires_at, +invited_at, +kind, +metadata, +provider_user, redeemed_at, service_account, status FROM confluent.stream_sharing.provider_shares +WHERE shared_resource = '{{ shared_resource }}' +AND crn = '{{ crn }}' +AND include_deleted = '{{ include_deleted }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' ; ``` -## `INSERT` example + + + -Use the following StackQL query and manifest file to create a new provider_shares resource. +## `INSERT` examples - + { label: 'create_cdx_v1_provider_share', value: 'create_cdx_v1_provider_share' }, + { label: 'Manifest', value: 'manifest' } + ]} +> + + +Creates a share based on delivery method. ```sql -/*+ create */ INSERT INTO confluent.stream_sharing.provider_shares ( -data__delivery_method, -data__consumer_restriction, -data__resources +delivery_method, +consumer_restriction, +resources ) SELECT -'{{ delivery_method }}', -'{{ consumer_restriction }}', -'{{ resources }}' +'{{ delivery_method }}' /* required */, +'{{ consumer_restriction }}' /* required */, +'{{ resources }}' /* required */ +RETURNING +id, +consumer_organization_name, +consumer_user_name, +provider_user_name, +api_version, +cloud_cluster, +consumer_restriction, +delivery_method, +invite_expires_at, +invited_at, +kind, +metadata, +provider_user, +redeemed_at, +service_account, +status ; ``` - -```yaml +{`# Description fields are for documentation purposes - name: provider_shares props: - name: delivery_method - value: string + value: "{{ delivery_method }}" + description: | + Method by which the invite will be delivered - name: consumer_restriction - props: - - name: kind - value: string - - name: email - value: string + description: | + Restrictions on the consumer that can redeem this token + value: + kind: "{{ kind }}" + email: "{{ email }}" - name: resources - value: array + value: + - "{{ resources }}" + description: | + List of resource crns to be shared +`} -``` -## `DELETE` example -Deletes the specified provider_shares resource. +## `DELETE` examples + + + + +Make a request to delete a provider share. ```sql -/*+ delete */ DELETE FROM confluent.stream_sharing.provider_shares -WHERE id = '{{ id }}'; +WHERE id = '{{ id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Resend provider share + +```sql +EXEC confluent.stream_sharing.provider_shares.resend_cdx_v1_provider_share +@id='{{ id }}' --required +; ``` + + diff --git a/website/docs/services/stream_sharing/shared_resources_network_config/index.md b/website/docs/services/stream_sharing/shared_resources_network_config/index.md new file mode 100644 index 0000000..30baac7 --- /dev/null +++ b/website/docs/services/stream_sharing/shared_resources_network_config/index.md @@ -0,0 +1,178 @@ +--- +title: shared_resources_network_config +hide_title: false +hide_table_of_contents: false +keywords: + - shared_resources_network_config + - stream_sharing + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a shared_resources_network_config resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The network information of the shared resource + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (cdx/v1)
objectThe cloud-specific network details. These will be populated when the network reaches the READY state.
stringThe root DNS domain for the network if applicable. (example: 00000.us-east-1.aws.glb.confluent.cloud)
string (uri)The kafka cluster bootstrap url (example: SASL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092)
stringKind defines the object this REST resource represents. (Network)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe DNS subdomain for each zone. Present on networks that support PrivateLink. Keys are zones and values are DNS domains.
arrayThe 3 availability zones for this network. They can optionally be specified for AWS networks used with PrivateLink. Otherwise, they are automatically chosen by Confluent Cloud. On AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) (e.g. use1-az3) On GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones) (e.g. us-central1-c). On Azure, zones are Confluent-chosen names (e.g. 1, 2, 3) since Azure does not have universal zone identifiers.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
idReturns network information of the shared resource
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the consumer shared resource.
+ +## `SELECT` examples + + + + +Returns network information of the shared resource + +```sql +SELECT +id, +api_version, +cloud, +dns_domain, +kafka_bootstrap_url, +kind, +metadata, +zonal_subdomains, +zones +FROM confluent.stream_sharing.shared_resources_network_config +WHERE id = '{{ id }}' -- required +; +``` + + diff --git a/website/docs/services/stream_sharing/shared_tokens/index.md b/website/docs/services/stream_sharing/shared_tokens/index.md index e2bd97f..f9b57c6 100644 --- a/website/docs/services/stream_sharing/shared_tokens/index.md +++ b/website/docs/services/stream_sharing/shared_tokens/index.md @@ -1,4 +1,4 @@ ---- +--- title: shared_tokens hide_title: false hide_table_of_contents: false @@ -15,6 +15,7 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -22,17 +23,102 @@ Creates, updates, deletes, gets or lists a shared_tokens resource. ## Overview - +
Nameshared_tokens
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + `SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Redeem the shared token for shared topic and cluster access information | -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Validate and decrypt the shared token and view token's shared resources | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
tokenValidate and decrypt the shared token and view token's shared resources
tokenRedeem the shared token for shared topic and cluster access information
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## Lifecycle Methods + + + + +Validate and decrypt the shared token and view token's shared resources + +```sql +EXEC confluent.stream_sharing.shared_tokens.resources_cdx_v1_shared_token +@@json= +'{ +"token": "{{ token }}" +}' +; +``` + + + +Redeem the shared token for shared topic and cluster access information + +```sql +EXEC confluent.stream_sharing.shared_tokens.redeem_cdx_v1_shared_token +@@json= +'{ +"token": "{{ token }}", +"aws_account": "{{ aws_account }}", +"azure_subscription": "{{ azure_subscription }}", +"gcp_project": "{{ gcp_project }}" +}' +; +``` + + diff --git a/website/docs/services/streams_group/index.md b/website/docs/services/streams_group/index.md new file mode 100644 index 0000000..0dc2e82 --- /dev/null +++ b/website/docs/services/streams_group/index.md @@ -0,0 +1,40 @@ +--- +title: streams_group +hide_title: false +hide_table_of_contents: false +keywords: + - streams_group + - confluent + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +streams_group service documentation. + +:::info[Service Summary] + +total resources: __9__ + +::: + +## Resources +
+
+member_assignment_task_partitions
+member_assignment_tasks
+member_assignments
+member_target_assignment_task_partitions
+member_target_assignment_tasks +
+
+member_target_assignments
+members
+streams_groups
+subtopologies +
+
\ No newline at end of file diff --git a/website/docs/services/streams_group/member_assignment_task_partitions/index.md b/website/docs/services/streams_group/member_assignment_task_partitions/index.md new file mode 100644 index 0000000..d051c1b --- /dev/null +++ b/website/docs/services/streams_group/member_assignment_task_partitions/index.md @@ -0,0 +1,142 @@ +--- +title: member_assignment_task_partitions +hide_title: false +hide_table_of_contents: false +keywords: + - member_assignment_task_partitions + - streams_group + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a member_assignment_task_partitions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The partitions of a streams member task. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the Streams subtopology.
string
object
arrayThe list of partition IDs assigned to the Streams task.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the tasks of the member specified by the ``member_id``, and the type ``assignments_type``.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Return the tasks of the member specified by the ``member_id``, and the type ``assignments_type``. + +```sql +SELECT +subtopology_id, +kind, +metadata, +partition_ids +FROM confluent.streams_group.member_assignment_task_partitions +; +``` + + diff --git a/website/docs/services/streams_group/member_assignment_tasks/index.md b/website/docs/services/streams_group/member_assignment_tasks/index.md new file mode 100644 index 0000000..c66d0fe --- /dev/null +++ b/website/docs/services/streams_group/member_assignment_tasks/index.md @@ -0,0 +1,142 @@ +--- +title: member_assignment_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - member_assignment_tasks + - streams_group + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a member_assignment_tasks resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The streams group member assignments of specific type. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the Streams subtopology.
string
object
arrayThe list of partition IDs assigned to the Streams task.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the tasks of the member specified by the ``member_id``, and the type ``assignments_type``.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Return the tasks of the member specified by the ``member_id``, and the type ``assignments_type``. + +```sql +SELECT +subtopology_id, +kind, +metadata, +partition_ids +FROM confluent.streams_group.member_assignment_tasks +; +``` + + diff --git a/website/docs/services/streams_group/member_assignments/index.md b/website/docs/services/streams_group/member_assignments/index.md new file mode 100644 index 0000000..9bf1305 --- /dev/null +++ b/website/docs/services/streams_group/member_assignments/index.md @@ -0,0 +1,166 @@ +--- +title: member_assignments +hide_title: false +hide_table_of_contents: false +keywords: + - member_assignments + - streams_group + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a member_assignments resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The streams group member assignments. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the Kafka cluster.
stringThe unique identifier of the Streams group.
stringThe unique identifier of the Streams group member.
object
string
object
object
object
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the assignments of the member specified by the ``member_id``.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Return the assignments of the member specified by the ``member_id``. + +```sql +SELECT +cluster_id, +group_id, +member_id, +active_tasks, +kind, +metadata, +standby_tasks, +warmup_tasks +FROM confluent.streams_group.member_assignments +; +``` + + diff --git a/website/docs/services/streams_group/member_target_assignment_task_partitions/index.md b/website/docs/services/streams_group/member_target_assignment_task_partitions/index.md new file mode 100644 index 0000000..2a44783 --- /dev/null +++ b/website/docs/services/streams_group/member_target_assignment_task_partitions/index.md @@ -0,0 +1,142 @@ +--- +title: member_target_assignment_task_partitions +hide_title: false +hide_table_of_contents: false +keywords: + - member_target_assignment_task_partitions + - streams_group + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a member_target_assignment_task_partitions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The partitions of a streams member task. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the Streams subtopology.
string
object
arrayThe list of partition IDs assigned to the Streams task.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the tasks of the member specified by the ``member_id``, and the type ``assignments_type``.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Return the tasks of the member specified by the ``member_id``, and the type ``assignments_type``. + +```sql +SELECT +subtopology_id, +kind, +metadata, +partition_ids +FROM confluent.streams_group.member_target_assignment_task_partitions +; +``` + + diff --git a/website/docs/services/streams_group/member_target_assignment_tasks/index.md b/website/docs/services/streams_group/member_target_assignment_tasks/index.md new file mode 100644 index 0000000..b3d87da --- /dev/null +++ b/website/docs/services/streams_group/member_target_assignment_tasks/index.md @@ -0,0 +1,142 @@ +--- +title: member_target_assignment_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - member_target_assignment_tasks + - streams_group + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a member_target_assignment_tasks resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The streams group member assignments of specific type. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the Streams subtopology.
string
object
arrayThe list of partition IDs assigned to the Streams task.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the target tasks of the member specified by the ``member_id``, and the type ``assignments_type``.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Return the target tasks of the member specified by the ``member_id``, and the type ``assignments_type``. + +```sql +SELECT +subtopology_id, +kind, +metadata, +partition_ids +FROM confluent.streams_group.member_target_assignment_tasks +; +``` + + diff --git a/website/docs/services/streams_group/member_target_assignments/index.md b/website/docs/services/streams_group/member_target_assignments/index.md new file mode 100644 index 0000000..c528d1b --- /dev/null +++ b/website/docs/services/streams_group/member_target_assignments/index.md @@ -0,0 +1,166 @@ +--- +title: member_target_assignments +hide_title: false +hide_table_of_contents: false +keywords: + - member_target_assignments + - streams_group + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a member_target_assignments resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The streams group member assignments. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the Kafka cluster.
stringThe unique identifier of the Streams group.
stringThe unique identifier of the Streams group member.
object
string
object
object
object
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the target assignments of the member specified by the ``member_id``.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Return the target assignments of the member specified by the ``member_id``. + +```sql +SELECT +cluster_id, +group_id, +member_id, +active_tasks, +kind, +metadata, +standby_tasks, +warmup_tasks +FROM confluent.streams_group.member_target_assignments +; +``` + + diff --git a/website/docs/services/streams_group/members/index.md b/website/docs/services/streams_group/members/index.md new file mode 100644 index 0000000..d51195e --- /dev/null +++ b/website/docs/services/streams_group/members/index.md @@ -0,0 +1,309 @@ +--- +title: members +hide_title: false +hide_table_of_contents: false +keywords: + - members + - streams_group + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a members resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The streams group member. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe client identifier of the Streams group member.
stringThe unique identifier of the Kafka cluster.
stringThe unique identifier of the Streams group.
stringThe instance identifier of the Streams group member.
stringThe unique identifier of the Streams group member.
stringThe process identifier of the Streams group member.
object
booleanThe flag indicating if the member is a classic consumer.
string
integerThe epoch of the Streams group member.
object
object
integerThe epoch of the Streams topology for the member.
+ + + +The list of members of the streams group + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe client identifier of the Streams group member.
stringThe unique identifier of the Kafka cluster.
stringThe unique identifier of the Streams group.
stringThe instance identifier of the Streams group member.
stringThe unique identifier of the Streams group member.
stringThe process identifier of the Streams group member.
object
booleanThe flag indicating if the member is a classic consumer.
string
integerThe epoch of the Streams group member.
object
object
integerThe epoch of the Streams topology for the member.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the members specified by the ``member_id``.
Return a list of members that belong to the specified streams group.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Return the members specified by the ``member_id``. + +```sql +SELECT +client_id, +cluster_id, +group_id, +instance_id, +member_id, +process_id, +assignments, +is_classic, +kind, +member_epoch, +metadata, +target_assignment, +topology_epoch +FROM confluent.streams_group.members +; +``` + + + +Return a list of members that belong to the specified streams group. + +```sql +SELECT +client_id, +cluster_id, +group_id, +instance_id, +member_id, +process_id, +assignments, +is_classic, +kind, +member_epoch, +metadata, +target_assignment, +topology_epoch +FROM confluent.streams_group.members +; +``` + + diff --git a/website/docs/services/streams_group/streams_groups/index.md b/website/docs/services/streams_group/streams_groups/index.md new file mode 100644 index 0000000..39b8d5c --- /dev/null +++ b/website/docs/services/streams_group/streams_groups/index.md @@ -0,0 +1,297 @@ +--- +title: streams_groups +hide_title: false +hide_table_of_contents: false +keywords: + - streams_groups + - streams_group + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a streams_groups resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The streams group. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the Kafka cluster.
stringThe unique identifier of the Streams group.
integerThe epoch of the Streams group.
string
integerThe number of members in the Streams group.
object
object
stringThe state of the Streams group.
object
integerThe number of subtopologies in the Streams group.
integerThe epoch of the target assignment.
integerThe epoch of the Streams topology.
+ + + +The list of streams groups. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the Kafka cluster.
stringThe unique identifier of the Streams group.
integerThe epoch of the Streams group.
string
integerThe number of members in the Streams group.
object
object
stringThe state of the Streams group.
object
integerThe number of subtopologies in the Streams group.
integerThe epoch of the target assignment.
integerThe epoch of the Streams topology.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the streams group specified by the ``group_id``.
Return the list of streams groups that belong to the specified Kafka cluster
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Return the streams group specified by the ``group_id``. + +```sql +SELECT +cluster_id, +group_id, +group_epoch, +kind, +member_count, +members, +metadata, +state, +subtopologies, +subtopology_count, +target_assignment_epoch, +topology_epoch +FROM confluent.streams_group.streams_groups +; +``` + + + +Return the list of streams groups that belong to the specified Kafka cluster + +```sql +SELECT +cluster_id, +group_id, +group_epoch, +kind, +member_count, +members, +metadata, +state, +subtopologies, +subtopology_count, +target_assignment_epoch, +topology_epoch +FROM confluent.streams_group.streams_groups +; +``` + + diff --git a/website/docs/services/streams_group/subtopologies/index.md b/website/docs/services/streams_group/subtopologies/index.md new file mode 100644 index 0000000..b0ffa7a --- /dev/null +++ b/website/docs/services/streams_group/subtopologies/index.md @@ -0,0 +1,225 @@ +--- +title: subtopologies +hide_title: false +hide_table_of_contents: false +keywords: + - subtopologies + - streams_group + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a subtopologies resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The streams group subtopology. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the Kafka cluster.
stringThe unique identifier of the Streams group.
stringThe unique identifier of the Streams subtopology.
string
object
arrayThe list of source topics for the subtopology.
+ + + +The list of subtoplogies of the streams group + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the Kafka cluster.
stringThe unique identifier of the Streams group.
stringThe unique identifier of the Streams subtopology.
string
object
arrayThe list of source topics for the subtopology.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Return the subtopology specified by the ``subtopology_id``.
Return a list of subtopologies that belong to the specified streams group.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Return the subtopology specified by the ``subtopology_id``. + +```sql +SELECT +cluster_id, +group_id, +subtopology_id, +kind, +metadata, +source_topics +FROM confluent.streams_group.subtopologies +; +``` + + + +Return a list of subtopologies that belong to the specified streams group. + +```sql +SELECT +cluster_id, +group_id, +subtopology_id, +kind, +metadata, +source_topics +FROM confluent.streams_group.subtopologies +; +``` + + diff --git a/website/docs/services/sts/index.md b/website/docs/services/sts/index.md index 54b16b6..608393c 100644 --- a/website/docs/services/sts/index.md +++ b/website/docs/services/sts/index.md @@ -16,13 +16,9 @@ image: /img/stackql-confluent-provider-featured-image.png sts service documentation. -:::info Service Summary +:::info[Service Summary] -
-
-total resources: 1
-
-
+total resources: __1__ ::: diff --git a/website/docs/services/sts/oauth_tokens/index.md b/website/docs/services/sts/oauth_tokens/index.md index bbea021..b001baa 100644 --- a/website/docs/services/sts/oauth_tokens/index.md +++ b/website/docs/services/sts/oauth_tokens/index.md @@ -1,4 +1,4 @@ ---- +--- title: oauth_tokens hide_title: false hide_table_of_contents: false @@ -15,23 +15,91 @@ image: /img/stackql-confluent-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a oauth_tokens resource. +Creates, updates, deletes, gets or lists an oauth_tokens resource. ## Overview - +
Nameoauth_tokens
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + `SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `EXEC` | | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Use this operation to exchange an access token (JWT) issued by an external identity provider for an access token (JWT) issued by Confluent.This enables the use of external identities to access Confluent Cloud APIs. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
subject_token, grant_type, identity_pool_id, subject_token_type, requested_token_typeUse this operation to exchange an access token (JWT) issued by an external identity provider for
an access token (JWT) issued by Confluent.This enables the use of external identities
to access Confluent Cloud APIs.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## Lifecycle Methods + + + + +Use this operation to exchange an access token (JWT) issued by an external identity provider for
an access token (JWT) issued by Confluent.This enables the use of external identities
to access Confluent Cloud APIs.
+ +```sql +EXEC confluent.sts.oauth_tokens.exchange_sts_v1_oauth_token +@@json= +'{ +"grant_type": "{{ grant_type }}", +"subject_token": "{{ subject_token }}", +"identity_pool_id": "{{ identity_pool_id }}", +"subject_token_type": "{{ subject_token_type }}", +"requested_token_type": "{{ requested_token_type }}", +"expires_in": {{ expires_in }} +}' +; +``` + + diff --git a/website/docs/services/tableflow/catalog_integrations/index.md b/website/docs/services/tableflow/catalog_integrations/index.md new file mode 100644 index 0000000..ef98022 --- /dev/null +++ b/website/docs/services/tableflow/catalog_integrations/index.md @@ -0,0 +1,396 @@ +--- +title: catalog_integrations +hide_title: false +hide_table_of_contents: false +keywords: + - catalog_integrations + - tableflow + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a catalog_integrations resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Catalog Integration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (tableflow/v1)
stringKind defines the object this REST resource represents. (CatalogIntegration)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Catalog Integration
objectThe status of the Catalog Integration
+ + + +Catalog Integration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (tableflow/v1)
stringKind defines the object this REST resource represents. (CatalogIntegration)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Catalog Integration
objectThe status of the Catalog Integration
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, spec.kafka_cluster, idMake a request to read a catalog integration.
environment, spec.kafka_clusterpage_size, page_tokenRetrieve a sorted, filtered, paginated list of all catalog integrations.
specMake a request to create a catalog integration.
idMake a request to update a catalog integration.

environment, spec.kafka_cluster, idMake a request to delete a catalog integration.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the catalog integration.
stringScope the operation to the given spec.kafka_cluster. (example: lkc-00000)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
+ +## `SELECT` examples + + + + +Make a request to read a catalog integration. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.tableflow.catalog_integrations +WHERE environment = '{{ environment }}' -- required +AND spec.kafka_cluster = '{{ spec.kafka_cluster }}' -- required +AND id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all catalog integrations. + +```sql +SELECT +id, +api_version, +kind, +metadata, +spec, +status +FROM confluent.tableflow.catalog_integrations +WHERE environment = '{{ environment }}' -- required +AND spec.kafka_cluster = '{{ spec.kafka_cluster }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples + + + + +Make a request to create a catalog integration. + +```sql +INSERT INTO confluent.tableflow.catalog_integrations ( +spec +) +SELECT +'{{ spec }}' /* required */ +RETURNING +id, +api_version, +kind, +metadata, +spec, +status +; +``` + + + +{`# Description fields are for documentation purposes +- name: catalog_integrations + props: + - name: spec + description: | + The desired state of the Catalog Integration + value: + display_name: "{{ display_name }}" + suspended: {{ suspended }} + config: + kind: "{{ kind }}" + provider_integration_id: "{{ provider_integration_id }}" + endpoint: "{{ endpoint }}" + client_id: "{{ client_id }}" + client_secret: "{{ client_secret }}" + warehouse: "{{ warehouse }}" + allowed_scope: "{{ allowed_scope }}" + workspace_endpoint: "{{ workspace_endpoint }}" + catalog_name: "{{ catalog_name }}" + environment: + id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + kafka_cluster: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} + + + + + +## `UPDATE` examples + + + + +Make a request to update a catalog integration.

+ +```sql +UPDATE confluent.tableflow.catalog_integrations +SET +spec = '{{ spec }}' +WHERE +id = '{{ id }}' --required +RETURNING +id, +api_version, +kind, +metadata, +spec, +status; +``` + + + + +## `DELETE` examples + + + + +Make a request to delete a catalog integration. + +```sql +DELETE FROM confluent.tableflow.catalog_integrations +WHERE environment = '{{ environment }}' --required +AND spec.kafka_cluster = '{{ spec.kafka_cluster }}' --required +AND id = '{{ id }}' --required +; +``` + + diff --git a/website/docs/services/tableflow/index.md b/website/docs/services/tableflow/index.md new file mode 100644 index 0000000..4d2f3a1 --- /dev/null +++ b/website/docs/services/tableflow/index.md @@ -0,0 +1,34 @@ +--- +title: tableflow +hide_title: false +hide_table_of_contents: false +keywords: + - tableflow + - confluent + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +tableflow service documentation. + +:::info[Service Summary] + +total resources: __3__ + +::: + +## Resources +
+
+catalog_integrations
+regions +
+
+topics +
+
\ No newline at end of file diff --git a/website/docs/services/tableflow/regions/index.md b/website/docs/services/tableflow/regions/index.md new file mode 100644 index 0000000..224f3a6 --- /dev/null +++ b/website/docs/services/tableflow/regions/index.md @@ -0,0 +1,172 @@ +--- +title: regions +hide_title: false +hide_table_of_contents: false +keywords: + - regions + - tableflow + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a regions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Region. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringAPIVersion defines the schema version of this representation of a resource. (tableflow/v1)
stringThe cloud service provider that hosts the region. (example: AWS)
stringKind defines the object this REST resource represents. (Region)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stringThe cloud service provider region. (example: us-east-2)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
cloud, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all regions.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringFilter the results by exact match for cloud. (example: AWS)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
+ +## `SELECT` examples + + + + +Retrieve a sorted, filtered, paginated list of all regions. + +```sql +SELECT +id, +api_version, +cloud, +kind, +metadata, +region +FROM confluent.tableflow.regions +WHERE cloud = '{{ cloud }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + diff --git a/website/docs/services/tableflow/topics/index.md b/website/docs/services/tableflow/topics/index.md new file mode 100644 index 0000000..ae627fd --- /dev/null +++ b/website/docs/services/tableflow/topics/index.md @@ -0,0 +1,399 @@ +--- +title: topics +hide_title: false +hide_table_of_contents: false +keywords: + - topics + - tableflow + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a topics resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Tableflow Topic. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAPIVersion defines the schema version of this representation of a resource. (tableflow/v1)
stringKind defines the object this REST resource represents. (TableflowTopic)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Tableflow Topic
objectThe status of the Tableflow Topic
+ + + +Tableflow Topic. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAPIVersion defines the schema version of this representation of a resource. (tableflow/v1)
stringKind defines the object this REST resource represents. (TableflowTopic)
objectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
objectThe desired state of the Tableflow Topic
objectThe status of the Tableflow Topic
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, spec.kafka_cluster, display_nameMake a request to read a tableflow topic.
environment, spec.kafka_clusterspec.table_formats, page_size, page_tokenRetrieve a sorted, filtered, paginated list of all tableflow topics.
specMake a request to create a tableflow topic.
display_name, specMake a request to update a tableflow topic.

environment, spec.kafka_cluster, display_nameMake a request to delete a tableflow topic.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Kafka topic for which Tableflow is enabled.
stringScope the operation to the given environment. (example: env-00000)
stringScope the operation to the given spec.kafka_cluster. (example: lkc-00000)
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
arrayFilter the results by exact match for spec.table_formats. Pass multiple times to see results matching any of the values. (example: [DELTA, ICEBERG])
+ +## `SELECT` examples + + + + +Make a request to read a tableflow topic. + +```sql +SELECT +api_version, +kind, +metadata, +spec, +status +FROM confluent.tableflow.topics +WHERE environment = '{{ environment }}' -- required +AND spec.kafka_cluster = '{{ spec.kafka_cluster }}' -- required +AND display_name = '{{ display_name }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all tableflow topics. + +```sql +SELECT +api_version, +kind, +metadata, +spec, +status +FROM confluent.tableflow.topics +WHERE environment = '{{ environment }}' -- required +AND spec.kafka_cluster = '{{ spec.kafka_cluster }}' -- required +AND spec.table_formats = '{{ spec.table_formats }}' +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples + + + + +Make a request to create a tableflow topic. + +```sql +INSERT INTO confluent.tableflow.topics ( +spec +) +SELECT +'{{ spec }}' /* required */ +RETURNING +api_version, +kind, +metadata, +spec, +status +; +``` + + + +{`# Description fields are for documentation purposes +- name: topics + props: + - name: spec + description: | + The desired state of the Tableflow Topic + value: + display_name: "{{ display_name }}" + suspended: {{ suspended }} + config: + enable_compaction: {{ enable_compaction }} + enable_partitioning: {{ enable_partitioning }} + retention_ms: "{{ retention_ms }}" + data_retention_ms: "{{ data_retention_ms }}" + record_failure_strategy: "{{ record_failure_strategy }}" + error_handling: + mode: "{{ mode }}" + target: "{{ target }}" + storage: + kind: "{{ kind }}" + bucket_name: "{{ bucket_name }}" + bucket_region: "{{ bucket_region }}" + provider_integration_id: "{{ provider_integration_id }}" + table_path: "{{ table_path }}" + storage_account_name: "{{ storage_account_name }}" + container_name: "{{ container_name }}" + storage_region: "{{ storage_region }}" + table_formats: + - "{{ table_formats }}" + environment: + id: "{{ id }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" + kafka_cluster: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} + + + + + +## `UPDATE` examples + + + + +Make a request to update a tableflow topic.

+ +```sql +UPDATE confluent.tableflow.topics +SET +spec = '{{ spec }}' +WHERE +display_name = '{{ display_name }}' --required +AND spec = '{{ spec }}' --required +RETURNING +api_version, +kind, +metadata, +spec, +status; +``` + + + + +## `DELETE` examples + + + + +Make a request to delete a tableflow topic. + +```sql +DELETE FROM confluent.tableflow.topics +WHERE environment = '{{ environment }}' --required +AND spec.kafka_cluster = '{{ spec.kafka_cluster }}' --required +AND display_name = '{{ display_name }}' --required +; +``` + + diff --git a/website/docs/services/usm/connect_clusters/index.md b/website/docs/services/usm/connect_clusters/index.md new file mode 100644 index 0000000..9b7e5c8 --- /dev/null +++ b/website/docs/services/usm/connect_clusters/index.md @@ -0,0 +1,390 @@ +--- +title: connect_clusters +hide_title: false +hide_table_of_contents: false +keywords: + - connect_clusters + - usm + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a connect_clusters resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Connect Cluster. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe unique identifier of the Connect cluster within the Confluent Platform environment. (example: connect-group-xyz123)
stringThe unique identifier of the metadata Kafka cluster for the Connect Cluster. (example: 4k0R9d1GTS5tI9f4Y2xZ0Q)
stringAPIVersion defines the schema version of this representation of a resource. (usm/v1)
stringThe cloud service provider where the metadata for the Connect Cluster should be stored. This field is optional. If provided, 'region' must also be provided. If neither 'cloud' nor 'region' are provided, the cloud provider of the associated metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. (example: AWS)
objectThe environment to which this belongs.
stringKind defines the object this REST resource represents. (ConnectCluster)
stringThe home region of the Confluent Platform Connect cluster where the metadata should be stored. This field is optional. If provided, 'cloud' must also be provided. If neither 'cloud' nor 'region' are provided, the home region of the associated metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. (example: us-east-1)
+ + + +Connect Cluster. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe unique identifier of the Connect cluster within the Confluent Platform environment. (example: connect-group-xyz123)
stringThe unique identifier of the metadata Kafka cluster for the Connect Cluster. (example: 4k0R9d1GTS5tI9f4Y2xZ0Q)
stringAPIVersion defines the schema version of this representation of a resource. (usm/v1)
stringThe cloud service provider where the metadata for the Connect Cluster should be stored. This field is optional. If provided, 'region' must also be provided. If neither 'cloud' nor 'region' are provided, the cloud provider of the associated metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. (example: AWS)
objectThe environment to which this belongs.
stringKind defines the object this REST resource represents. (ConnectCluster)
stringThe home region of the Confluent Platform Connect cluster where the metadata should be stored. This field is optional. If provided, 'cloud' must also be provided. If neither 'cloud' nor 'region' are provided, the home region of the associated metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. (example: us-east-1)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a connect cluster.
environmentpage_size, page_tokenRetrieve a sorted, filtered, paginated list of all connect clusters.
confluent_platform_connect_cluster_id, kafka_cluster_id, environmentMake a request to create a connect cluster.
environment, idMake a request to delete a connect cluster.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the connect cluster.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
+ +## `SELECT` examples + + + + +Make a request to read a connect cluster. + +```sql +SELECT +id, +confluent_platform_connect_cluster_id, +kafka_cluster_id, +api_version, +cloud, +environment, +kind, +region +FROM confluent.usm.connect_clusters +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all connect clusters. + +```sql +SELECT +id, +confluent_platform_connect_cluster_id, +kafka_cluster_id, +api_version, +cloud, +environment, +kind, +region +FROM confluent.usm.connect_clusters +WHERE environment = '{{ environment }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples + + + + +Make a request to create a connect cluster. + +```sql +INSERT INTO confluent.usm.connect_clusters ( +confluent_platform_connect_cluster_id, +kafka_cluster_id, +cloud, +region, +environment +) +SELECT +'{{ confluent_platform_connect_cluster_id }}' /* required */, +'{{ kafka_cluster_id }}' /* required */, +'{{ cloud }}', +'{{ region }}', +'{{ environment }}' /* required */ +RETURNING +id, +confluent_platform_connect_cluster_id, +kafka_cluster_id, +api_version, +cloud, +environment, +kind, +region +; +``` + + + +{`# Description fields are for documentation purposes +- name: connect_clusters + props: + - name: confluent_platform_connect_cluster_id + value: "{{ confluent_platform_connect_cluster_id }}" + description: | + The unique identifier of the Connect cluster within the Confluent Platform environment. + - name: kafka_cluster_id + value: "{{ kafka_cluster_id }}" + description: | + The unique identifier of the metadata Kafka cluster for the Connect Cluster. + - name: cloud + value: "{{ cloud }}" + description: | + The cloud service provider where the metadata for the Connect Cluster should be stored. + This field is optional. If provided, 'region' must also be provided. + If neither 'cloud' nor 'region' are provided, the cloud provider of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + - name: region + value: "{{ region }}" + description: | + The home region of the Confluent Platform Connect cluster where the metadata should be stored. + This field is optional. If provided, 'cloud' must also be provided. + If neither 'cloud' nor 'region' are provided, the home region of the associated + metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. + - name: environment + description: | + The environment to which this belongs. + value: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} + + + + + +## `DELETE` examples + + + + +Make a request to delete a connect cluster. + +```sql +DELETE FROM confluent.usm.connect_clusters +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; +``` + + diff --git a/website/docs/services/usm/index.md b/website/docs/services/usm/index.md new file mode 100644 index 0000000..ad9ee93 --- /dev/null +++ b/website/docs/services/usm/index.md @@ -0,0 +1,33 @@ +--- +title: usm +hide_title: false +hide_table_of_contents: false +keywords: + - usm + - confluent + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +usm service documentation. + +:::info[Service Summary] + +total resources: __2__ + +::: + +## Resources +
+
+connect_clusters +
+
+kafka_clusters +
+
\ No newline at end of file diff --git a/website/docs/services/usm/kafka_clusters/index.md b/website/docs/services/usm/kafka_clusters/index.md new file mode 100644 index 0000000..20c431e --- /dev/null +++ b/website/docs/services/usm/kafka_clusters/index.md @@ -0,0 +1,384 @@ +--- +title: kafka_clusters +hide_title: false +hide_table_of_contents: false +keywords: + - kafka_clusters + - usm + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a kafka_clusters resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Kafka Cluster. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe unique identifier of the Kafka cluster within the Confluent Platform environment. (example: 4k0R9d1GTS5tI9f4Y2xZ0Q)
stringA human-readable name for the Confluent Platform Kafka cluster. (example: My-Prod-CP-Cluster)
stringAPIVersion defines the schema version of this representation of a resource. (usm/v1)
stringThe cloud service provider where the metadata for the Kafka Cluster should be stored. (example: AWS)
objectThe environment to which this belongs.
stringKind defines the object this REST resource represents. (KafkaCluster)
stringThe home region of the Confluent Platform Kafka cluster where the metadata should be stored. (example: us-east-1)
+ + + +Kafka Cluster. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). (example: dlz-f3a90de)
stringThe unique identifier of the Kafka cluster within the Confluent Platform environment. (example: 4k0R9d1GTS5tI9f4Y2xZ0Q)
stringA human-readable name for the Confluent Platform Kafka cluster. (example: My-Prod-CP-Cluster)
stringAPIVersion defines the schema version of this representation of a resource. (usm/v1)
stringThe cloud service provider where the metadata for the Kafka Cluster should be stored. (example: AWS)
objectThe environment to which this belongs.
stringKind defines the object this REST resource represents. (KafkaCluster)
stringThe home region of the Confluent Platform Kafka cluster where the metadata should be stored. (example: us-east-1)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment, idMake a request to read a kafka cluster.
environmentpage_size, page_tokenRetrieve a sorted, filtered, paginated list of all kafka clusters.
display_name, confluent_platform_kafka_cluster_id, cloud, region, environmentMake a request to create a kafka cluster.
environment, idMake a request to delete a kafka cluster.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringScope the operation to the given environment. (example: env-00000)
stringThe unique identifier for the kafka cluster.
integerA pagination size for collection requests.
stringAn opaque pagination token for collection requests.
+ +## `SELECT` examples + + + + +Make a request to read a kafka cluster. + +```sql +SELECT +id, +confluent_platform_kafka_cluster_id, +display_name, +api_version, +cloud, +environment, +kind, +region +FROM confluent.usm.kafka_clusters +WHERE environment = '{{ environment }}' -- required +AND id = '{{ id }}' -- required +; +``` + + + +Retrieve a sorted, filtered, paginated list of all kafka clusters. + +```sql +SELECT +id, +confluent_platform_kafka_cluster_id, +display_name, +api_version, +cloud, +environment, +kind, +region +FROM confluent.usm.kafka_clusters +WHERE environment = '{{ environment }}' -- required +AND page_size = '{{ page_size }}' +AND page_token = '{{ page_token }}' +; +``` + + + + +## `INSERT` examples + + + + +Make a request to create a kafka cluster. + +```sql +INSERT INTO confluent.usm.kafka_clusters ( +display_name, +confluent_platform_kafka_cluster_id, +cloud, +region, +environment +) +SELECT +'{{ display_name }}' /* required */, +'{{ confluent_platform_kafka_cluster_id }}' /* required */, +'{{ cloud }}' /* required */, +'{{ region }}' /* required */, +'{{ environment }}' /* required */ +RETURNING +id, +confluent_platform_kafka_cluster_id, +display_name, +api_version, +cloud, +environment, +kind, +region +; +``` + + + +{`# Description fields are for documentation purposes +- name: kafka_clusters + props: + - name: display_name + value: "{{ display_name }}" + description: | + A human-readable name for the Confluent Platform Kafka cluster. + - name: confluent_platform_kafka_cluster_id + value: "{{ confluent_platform_kafka_cluster_id }}" + description: | + The unique identifier of the Kafka cluster within the Confluent Platform environment. + - name: cloud + value: "{{ cloud }}" + description: | + The cloud service provider where the metadata for the Kafka Cluster should be stored. + - name: region + value: "{{ region }}" + description: | + The home region of the Confluent Platform Kafka cluster where the metadata should be stored. + - name: environment + description: | + The environment to which this belongs. + value: + id: "{{ id }}" + environment: "{{ environment }}" + related: "{{ related }}" + resource_name: "{{ resource_name }}" +`} + + + + + +## `DELETE` examples + + + + +Make a request to delete a kafka cluster. + +```sql +DELETE FROM confluent.usm.kafka_clusters +WHERE environment = '{{ environment }}' --required +AND id = '{{ id }}' --required +; +``` + + diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 1c33bcf..cd7c4ad 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -112,7 +112,11 @@ const config = { projectName: `stackql-provider-${providerName}`, // Usually your repo name. onBrokenLinks: 'warn', - onBrokenMarkdownLinks: 'warn', + markdown: { + hooks: { + onBrokenMarkdownLinks: 'warn', + }, + }, // Even if you don't use internationalization, you can use this field to set // useful metadata like html lang. For example, if your site is Chinese, you @@ -134,6 +138,9 @@ const config = { // editUrl: 'https://github.com/stackql/stackql-deploy/tree/main/website/', routeBasePath: '/', // Set the docs to be the root of the site }, + // No blog in a provider doc microsite — navbar links to /blog point + // at the main stackql site, not this build. + blog: false, theme: { customCss: './src/css/custom.css', }, diff --git a/website/package.json b/website/package.json index 8f57f6c..9914c8b 100644 --- a/website/package.json +++ b/website/package.json @@ -14,8 +14,9 @@ "write-heading-ids": "docusaurus write-heading-ids" }, "dependencies": { - "@docusaurus/core": "3.8.1", - "@docusaurus/preset-classic": "3.8.1", + "@docusaurus/core": "^3.10.1", + "@docusaurus/faster": "^3.10.1", + "@docusaurus/preset-classic": "^3.10.1", "@emotion/react": "^11.14.0", "@emotion/styled": "^11.14.1", "@iconify/react": "^6.0.0", @@ -29,8 +30,9 @@ "react-dom": "^19.0.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.8.1", - "@docusaurus/types": "3.8.1" + "@docusaurus/module-type-aliases": "^3.10.1", + "@docusaurus/types": "^3.10.1", + "baseline-browser-mapping": "^2.10.27" }, "browserslist": { "production": [ diff --git a/website/yarn.lock b/website/yarn.lock index 00f1900..ef931d9 100644 --- a/website/yarn.lock +++ b/website/yarn.lock @@ -2,163 +2,176 @@ # yarn lockfile v1 -"@algolia/abtesting@1.3.0": - version "1.3.0" - resolved "https://registry.yarnpkg.com/@algolia/abtesting/-/abtesting-1.3.0.tgz#3fade769bf5b03244baaee8034b83e2b49f8e86c" - integrity sha512-KqPVLdVNfoJzX5BKNGM9bsW8saHeyax8kmPFXul5gejrSPN3qss7PgsFH5mMem7oR8tvjvNkia97ljEYPYCN8Q== - dependencies: - "@algolia/client-common" "5.37.0" - "@algolia/requester-browser-xhr" "5.37.0" - "@algolia/requester-fetch" "5.37.0" - "@algolia/requester-node-http" "5.37.0" - -"@algolia/autocomplete-core@1.17.9": - version "1.17.9" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.17.9.tgz#83374c47dc72482aa45d6b953e89377047f0dcdc" - integrity sha512-O7BxrpLDPJWWHv/DLA9DRFWs+iY1uOJZkqUwjS5HSZAGcl0hIVCQ97LTLewiZmZ402JYUrun+8NqFP+hCknlbQ== - dependencies: - "@algolia/autocomplete-plugin-algolia-insights" "1.17.9" - "@algolia/autocomplete-shared" "1.17.9" - -"@algolia/autocomplete-plugin-algolia-insights@1.17.9": - version "1.17.9" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.17.9.tgz#74c86024d09d09e8bfa3dd90b844b77d9f9947b6" - integrity sha512-u1fEHkCbWF92DBeB/KHeMacsjsoI0wFhjZtlCq2ddZbAehshbZST6Hs0Avkc0s+4UyBGbMDnSuXHLuvRWK5iDQ== - dependencies: - "@algolia/autocomplete-shared" "1.17.9" - -"@algolia/autocomplete-preset-algolia@1.17.9": - version "1.17.9" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.17.9.tgz#911f3250544eb8ea4096fcfb268f156b085321b5" - integrity sha512-Na1OuceSJeg8j7ZWn5ssMu/Ax3amtOwk76u4h5J4eK2Nx2KB5qt0Z4cOapCsxot9VcEN11ADV5aUSlQF4RhGjQ== - dependencies: - "@algolia/autocomplete-shared" "1.17.9" - -"@algolia/autocomplete-shared@1.17.9": - version "1.17.9" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.17.9.tgz#5f38868f7cb1d54b014b17a10fc4f7e79d427fa8" - integrity sha512-iDf05JDQ7I0b7JEA/9IektxN/80a2MZ1ToohfmNS3rfeuQnIKI3IJlIafD0xu4StbtQTghx9T3Maa97ytkXenQ== - -"@algolia/client-abtesting@5.37.0": - version "5.37.0" - resolved "https://registry.yarnpkg.com/@algolia/client-abtesting/-/client-abtesting-5.37.0.tgz#37df3674ccc37dfb0aa4cbfea42002bb136fb909" - integrity sha512-Dp2Zq+x9qQFnuiQhVe91EeaaPxWBhzwQ6QnznZQnH9C1/ei3dvtmAFfFeaTxM6FzfJXDLvVnaQagTYFTQz3R5g== - dependencies: - "@algolia/client-common" "5.37.0" - "@algolia/requester-browser-xhr" "5.37.0" - "@algolia/requester-fetch" "5.37.0" - "@algolia/requester-node-http" "5.37.0" - -"@algolia/client-analytics@5.37.0": - version "5.37.0" - resolved "https://registry.yarnpkg.com/@algolia/client-analytics/-/client-analytics-5.37.0.tgz#6fb4d748e1af43d8bc9f955d73d98205ce1c1ee5" - integrity sha512-wyXODDOluKogTuZxRII6mtqhAq4+qUR3zIUJEKTiHLe8HMZFxfUEI4NO2qSu04noXZHbv/sRVdQQqzKh12SZuQ== - dependencies: - "@algolia/client-common" "5.37.0" - "@algolia/requester-browser-xhr" "5.37.0" - "@algolia/requester-fetch" "5.37.0" - "@algolia/requester-node-http" "5.37.0" - -"@algolia/client-common@5.37.0": - version "5.37.0" - resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-5.37.0.tgz#f7ca097c4bae44e4ea365ee8f420693d0005c98e" - integrity sha512-GylIFlPvLy9OMgFG8JkonIagv3zF+Dx3H401Uo2KpmfMVBBJiGfAb9oYfXtplpRMZnZPxF5FnkWaI/NpVJMC+g== - -"@algolia/client-insights@5.37.0": - version "5.37.0" - resolved "https://registry.yarnpkg.com/@algolia/client-insights/-/client-insights-5.37.0.tgz#f4f4011fc89bc0b2dfc384acc3c6fb38f633f4ec" - integrity sha512-T63afO2O69XHKw2+F7mfRoIbmXWGzgpZxgOFAdP3fR4laid7pWBt20P4eJ+Zn23wXS5kC9P2K7Bo3+rVjqnYiw== - dependencies: - "@algolia/client-common" "5.37.0" - "@algolia/requester-browser-xhr" "5.37.0" - "@algolia/requester-fetch" "5.37.0" - "@algolia/requester-node-http" "5.37.0" - -"@algolia/client-personalization@5.37.0": - version "5.37.0" - resolved "https://registry.yarnpkg.com/@algolia/client-personalization/-/client-personalization-5.37.0.tgz#c1688db681623b189f353599815a118033ceebb5" - integrity sha512-1zOIXM98O9zD8bYDCJiUJRC/qNUydGHK/zRK+WbLXrW1SqLFRXECsKZa5KoG166+o5q5upk96qguOtE8FTXDWQ== - dependencies: - "@algolia/client-common" "5.37.0" - "@algolia/requester-browser-xhr" "5.37.0" - "@algolia/requester-fetch" "5.37.0" - "@algolia/requester-node-http" "5.37.0" - -"@algolia/client-query-suggestions@5.37.0": - version "5.37.0" - resolved "https://registry.yarnpkg.com/@algolia/client-query-suggestions/-/client-query-suggestions-5.37.0.tgz#fa514df8d36fb548258c712f3ba6f97eb84ebb87" - integrity sha512-31Nr2xOLBCYVal+OMZn1rp1H4lPs1914Tfr3a34wU/nsWJ+TB3vWjfkUUuuYhWoWBEArwuRzt3YNLn0F/KRVkg== - dependencies: - "@algolia/client-common" "5.37.0" - "@algolia/requester-browser-xhr" "5.37.0" - "@algolia/requester-fetch" "5.37.0" - "@algolia/requester-node-http" "5.37.0" - -"@algolia/client-search@5.37.0": - version "5.37.0" - resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-5.37.0.tgz#38c7110d96fbbbda7b7fb0578a18b8cad3c25af2" - integrity sha512-DAFVUvEg+u7jUs6BZiVz9zdaUebYULPiQ4LM2R4n8Nujzyj7BZzGr2DCd85ip4p/cx7nAZWKM8pLcGtkTRTdsg== - dependencies: - "@algolia/client-common" "5.37.0" - "@algolia/requester-browser-xhr" "5.37.0" - "@algolia/requester-fetch" "5.37.0" - "@algolia/requester-node-http" "5.37.0" +"@algolia/abtesting@1.18.1": + version "1.18.1" + resolved "https://registry.yarnpkg.com/@algolia/abtesting/-/abtesting-1.18.1.tgz#f6f6c221ec463eb3237756d41606c9fb364843dd" + integrity sha512-aehCadlWOGvrT91KUIZpC0MbB8KBW9yUuvTJFd2xesR7le/IsT4nJUnjCCZ4ZqZCeTcPHPV5mo//fZ5oxcSVYw== + dependencies: + "@algolia/client-common" "5.52.1" + "@algolia/requester-browser-xhr" "5.52.1" + "@algolia/requester-fetch" "5.52.1" + "@algolia/requester-node-http" "5.52.1" + +"@algolia/autocomplete-core@1.19.2": + version "1.19.2" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.19.2.tgz#702df67a08cb3cfe8c33ee1111ef136ec1a9e232" + integrity sha512-mKv7RyuAzXvwmq+0XRK8HqZXt9iZ5Kkm2huLjgn5JoCPtDy+oh9yxUMfDDaVCw0oyzZ1isdJBc7l9nuCyyR7Nw== + dependencies: + "@algolia/autocomplete-plugin-algolia-insights" "1.19.2" + "@algolia/autocomplete-shared" "1.19.2" + +"@algolia/autocomplete-core@^1.19.2": + version "1.19.8" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.19.8.tgz#7c84c771d28643fb00d09026c05013fb97aeea23" + integrity sha512-3YEorYg44niXcm7gkft3nXYItHd44e8tmh4D33CTszPgP0QWkaLEaFywiNyJBo7UL/mqObA/G9RYuU7R8tN1IA== + dependencies: + "@algolia/autocomplete-plugin-algolia-insights" "1.19.8" + "@algolia/autocomplete-shared" "1.19.8" + +"@algolia/autocomplete-plugin-algolia-insights@1.19.2": + version "1.19.2" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.19.2.tgz#3584b625b9317e333d1ae43664d02358e175c52d" + integrity sha512-TjxbcC/r4vwmnZaPwrHtkXNeqvlpdyR+oR9Wi2XyfORkiGkLTVhX2j+O9SaCCINbKoDfc+c2PB8NjfOnz7+oKg== + dependencies: + "@algolia/autocomplete-shared" "1.19.2" + +"@algolia/autocomplete-plugin-algolia-insights@1.19.8": + version "1.19.8" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.19.8.tgz#f60d21edbe2a42e6d4e2215430733e3f51641471" + integrity sha512-ZvJWO8ZZJDpc1LNM2TTBdmQsZBLMR4rU5iNR2OYvEeFBiaf/0ESnRSSLQbryarJY4SVxtoz6A2ZtDMNM+iQEAA== + dependencies: + "@algolia/autocomplete-shared" "1.19.8" + +"@algolia/autocomplete-shared@1.19.2": + version "1.19.2" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.19.2.tgz#c0b7b8dc30a5c65b70501640e62b009535e4578f" + integrity sha512-jEazxZTVD2nLrC+wYlVHQgpBoBB5KPStrJxLzsIFl6Kqd1AlG9sIAGl39V5tECLpIQzB3Qa2T6ZPJ1ChkwMK/w== + +"@algolia/autocomplete-shared@1.19.8": + version "1.19.8" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.19.8.tgz#5d723d8bdb448efbb1b0e1c7ff94cc18e5b1dc0e" + integrity sha512-h5hf2t8ejF6vlOgvLaZzQbWs5SyH2z4PAWygNAvvD/2RI29hdQ54ldUGwqVuj9Srs+n8XUKTPUqb7fvhBhQrnQ== + +"@algolia/client-abtesting@5.52.1": + version "5.52.1" + resolved "https://registry.yarnpkg.com/@algolia/client-abtesting/-/client-abtesting-5.52.1.tgz#e356949a304f3c6f30121e18d282cdd8f65b7f67" + integrity sha512-HmXOGBOAOJPounpBzBpuY0zDYeiCpxgHnQmuA7JO6ScukcBdGp3/XM9zJk5pJx/xNGD68mbPGXWpDxGtl6BwDQ== + dependencies: + "@algolia/client-common" "5.52.1" + "@algolia/requester-browser-xhr" "5.52.1" + "@algolia/requester-fetch" "5.52.1" + "@algolia/requester-node-http" "5.52.1" + +"@algolia/client-analytics@5.52.1": + version "5.52.1" + resolved "https://registry.yarnpkg.com/@algolia/client-analytics/-/client-analytics-5.52.1.tgz#82f50f028f88414a397d7ab2a284b0de61d8492a" + integrity sha512-5oo4+I8iixie9vXhCyNFCzeIr8pqA3FQ//VsLHTDvZAV4ttYOPGvYHGQq5NSalrLx5Jc3dRro/5uDOlnUMcBJg== + dependencies: + "@algolia/client-common" "5.52.1" + "@algolia/requester-browser-xhr" "5.52.1" + "@algolia/requester-fetch" "5.52.1" + "@algolia/requester-node-http" "5.52.1" + +"@algolia/client-common@5.52.1": + version "5.52.1" + resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-5.52.1.tgz#303ec8040b918c4b8bb1032d3385db1f1768cfbe" + integrity sha512-qCDoZfx5MpX7XQzvQ3bC4tSEMkQWQMaF/ABtLuoze03Y/flR563CCSws02qIJ23oX7lxl92LsilZjINVyTdtLw== + +"@algolia/client-insights@5.52.1": + version "5.52.1" + resolved "https://registry.yarnpkg.com/@algolia/client-insights/-/client-insights-5.52.1.tgz#1558869cd0b0a7e59c46c0957535bddcb1eb43f4" + integrity sha512-hnGs0/lsFJ2PWDxNBz7pxreXo/Xz7gxYRcfePBUjsH26ad0kU/sgnVZd9LwWBpsQv65z2jlb5dkyaB9WE9M9FQ== + dependencies: + "@algolia/client-common" "5.52.1" + "@algolia/requester-browser-xhr" "5.52.1" + "@algolia/requester-fetch" "5.52.1" + "@algolia/requester-node-http" "5.52.1" + +"@algolia/client-personalization@5.52.1": + version "5.52.1" + resolved "https://registry.yarnpkg.com/@algolia/client-personalization/-/client-personalization-5.52.1.tgz#cc0ab06435b0e84dbdae7807131a30c4a5fbbd07" + integrity sha512-2VxxNc/uBysyKvGeBdSM5n9eIDKH8kWD7wd9/yqbJAiVwU4Yv6tU1LSJusHKrXV/aCu1KW7t9Gug9QyeEmtn/Q== + dependencies: + "@algolia/client-common" "5.52.1" + "@algolia/requester-browser-xhr" "5.52.1" + "@algolia/requester-fetch" "5.52.1" + "@algolia/requester-node-http" "5.52.1" + +"@algolia/client-query-suggestions@5.52.1": + version "5.52.1" + resolved "https://registry.yarnpkg.com/@algolia/client-query-suggestions/-/client-query-suggestions-5.52.1.tgz#6d1ec4950fe8478f33ac94da68122fd57092cf84" + integrity sha512-O6mPtsw3xEfNOe6gWFpYLeAZAIljNa4Hgna3bq15PwyN7nbjTY0wXJFRbzs/0YVf75Br+SbOQUmjKxXYjDiSiQ== + dependencies: + "@algolia/client-common" "5.52.1" + "@algolia/requester-browser-xhr" "5.52.1" + "@algolia/requester-fetch" "5.52.1" + "@algolia/requester-node-http" "5.52.1" + +"@algolia/client-search@5.52.1": + version "5.52.1" + resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-5.52.1.tgz#1a87024e25899cd7417c1dc88e4be1f390f38e85" + integrity sha512-gA8oJOV1LnQQkDf91iebNnFInHuW0gRPEgLSOQ7EfipCEjYTHm5swm1DlH9H5RaRw4RrHuzHBegnlzc0MAstcg== + dependencies: + "@algolia/client-common" "5.52.1" + "@algolia/requester-browser-xhr" "5.52.1" + "@algolia/requester-fetch" "5.52.1" + "@algolia/requester-node-http" "5.52.1" "@algolia/events@^4.0.1": version "4.0.1" resolved "https://registry.yarnpkg.com/@algolia/events/-/events-4.0.1.tgz#fd39e7477e7bc703d7f893b556f676c032af3950" integrity sha512-FQzvOCgoFXAbf5Y6mYozw2aj5KCJoA3m4heImceldzPSMbdyS4atVjJzXKMsfX3wnZTFYwkkt8/z8UesLHlSBQ== -"@algolia/ingestion@1.37.0": - version "1.37.0" - resolved "https://registry.yarnpkg.com/@algolia/ingestion/-/ingestion-1.37.0.tgz#bb6016e656c68014050814abf130e103f977794e" - integrity sha512-pkCepBRRdcdd7dTLbFddnu886NyyxmhgqiRcHHaDunvX03Ij4WzvouWrQq7B7iYBjkMQrLS8wQqSP0REfA4W8g== +"@algolia/ingestion@1.52.1": + version "1.52.1" + resolved "https://registry.yarnpkg.com/@algolia/ingestion/-/ingestion-1.52.1.tgz#6f045c218be76eae38e2ddb2c0d79081f67554b9" + integrity sha512-U9zZfc5xIu9wRxZkt+HceJUAD4VKHKbAyLSloJdEyMRmphXeibfrY9cxqIXBcmPeZzGhn3Imb35Dq8l19PkJhw== dependencies: - "@algolia/client-common" "5.37.0" - "@algolia/requester-browser-xhr" "5.37.0" - "@algolia/requester-fetch" "5.37.0" - "@algolia/requester-node-http" "5.37.0" + "@algolia/client-common" "5.52.1" + "@algolia/requester-browser-xhr" "5.52.1" + "@algolia/requester-fetch" "5.52.1" + "@algolia/requester-node-http" "5.52.1" -"@algolia/monitoring@1.37.0": - version "1.37.0" - resolved "https://registry.yarnpkg.com/@algolia/monitoring/-/monitoring-1.37.0.tgz#6d20c220d648db8faea45679350f1516917cc13d" - integrity sha512-fNw7pVdyZAAQQCJf1cc/ih4fwrRdQSgKwgor4gchsI/Q/ss9inmC6bl/69jvoRSzgZS9BX4elwHKdo0EfTli3w== +"@algolia/monitoring@1.52.1": + version "1.52.1" + resolved "https://registry.yarnpkg.com/@algolia/monitoring/-/monitoring-1.52.1.tgz#311045ebe1d1c987ffd3ef987847b13d2ade8b46" + integrity sha512-a3SGNceHmkQfq77iG8Ka+w1pvwfZa/0lzEIgse30fL0kD+yKnd/dg0dQvSfFPAEt2f21DMcGkDSSeJlO3KdQjQ== dependencies: - "@algolia/client-common" "5.37.0" - "@algolia/requester-browser-xhr" "5.37.0" - "@algolia/requester-fetch" "5.37.0" - "@algolia/requester-node-http" "5.37.0" + "@algolia/client-common" "5.52.1" + "@algolia/requester-browser-xhr" "5.52.1" + "@algolia/requester-fetch" "5.52.1" + "@algolia/requester-node-http" "5.52.1" -"@algolia/recommend@5.37.0": - version "5.37.0" - resolved "https://registry.yarnpkg.com/@algolia/recommend/-/recommend-5.37.0.tgz#dd5e814f30bbb92395902e120fdb28a120b91341" - integrity sha512-U+FL5gzN2ldx3TYfQO5OAta2TBuIdabEdFwD5UVfWPsZE5nvOKkc/6BBqP54Z/adW/34c5ZrvvZhlhNTZujJXQ== +"@algolia/recommend@5.52.1": + version "5.52.1" + resolved "https://registry.yarnpkg.com/@algolia/recommend/-/recommend-5.52.1.tgz#8e197801ed0aabbf1006d7d3f2549f6d8a8c8729" + integrity sha512-z98QEguCFDpxb4S/PyrUK1igqF8tPsdbqOUUO6ON91vJ58w+Gwa6ncrI0oNXSFcrkxA5EqPKPQ2A1PBCn08TYQ== dependencies: - "@algolia/client-common" "5.37.0" - "@algolia/requester-browser-xhr" "5.37.0" - "@algolia/requester-fetch" "5.37.0" - "@algolia/requester-node-http" "5.37.0" + "@algolia/client-common" "5.52.1" + "@algolia/requester-browser-xhr" "5.52.1" + "@algolia/requester-fetch" "5.52.1" + "@algolia/requester-node-http" "5.52.1" -"@algolia/requester-browser-xhr@5.37.0": - version "5.37.0" - resolved "https://registry.yarnpkg.com/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.37.0.tgz#8851ab846d8005055c36a59422161ebe1594ae48" - integrity sha512-Ao8GZo8WgWFABrU7iq+JAftXV0t+UcOtCDL4mzHHZ+rQeTTf1TZssr4d0vIuoqkVNnKt9iyZ7T4lQff4ydcTrw== +"@algolia/requester-browser-xhr@5.52.1": + version "5.52.1" + resolved "https://registry.yarnpkg.com/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.52.1.tgz#1cf9162c5f8a4b5a5379f29791c492f352f2f247" + integrity sha512-CI7+/0I11QeZM59Uc8whd2or0kqzFVjpaPn9Qpwll/krHcBAxk24WkAQ6WX+IwDVMfpont4YGbKwAmCre3vE8Q== dependencies: - "@algolia/client-common" "5.37.0" + "@algolia/client-common" "5.52.1" -"@algolia/requester-fetch@5.37.0": - version "5.37.0" - resolved "https://registry.yarnpkg.com/@algolia/requester-fetch/-/requester-fetch-5.37.0.tgz#93602fdc9a59b41ecd53768c53c11cddb0db846a" - integrity sha512-H7OJOXrFg5dLcGJ22uxx8eiFId0aB9b0UBhoOi4SMSuDBe6vjJJ/LeZyY25zPaSvkXNBN3vAM+ad6M0h6ha3AA== +"@algolia/requester-fetch@5.52.1": + version "5.52.1" + resolved "https://registry.yarnpkg.com/@algolia/requester-fetch/-/requester-fetch-5.52.1.tgz#ee7e2094540a14a3e4416c31214b79f730d89c97" + integrity sha512-S6bDuw9byfOvm3T71cgdoZgrgnZq6hpdMLkx52Louh57nUAmvGQESz2aojOynQHjbTiV55smvAFbgn0qT4tJrg== dependencies: - "@algolia/client-common" "5.37.0" + "@algolia/client-common" "5.52.1" -"@algolia/requester-node-http@5.37.0": - version "5.37.0" - resolved "https://registry.yarnpkg.com/@algolia/requester-node-http/-/requester-node-http-5.37.0.tgz#83da1b52f3ee86f262a5d4b2a88a74db665211c2" - integrity sha512-npZ9aeag4SGTx677eqPL3rkSPlQrnzx/8wNrl1P7GpWq9w/eTmRbOq+wKrJ2r78idlY0MMgmY/mld2tq6dc44g== +"@algolia/requester-node-http@5.52.1": + version "5.52.1" + resolved "https://registry.yarnpkg.com/@algolia/requester-node-http/-/requester-node-http-5.52.1.tgz#be0d9c5642f392586bd306bae70befb38f04e0af" + integrity sha512-tqZXM+54rWo4mk5jL5Z/flE11nPmNEdXwFBM5py9DkOmbjeCNemfVd45FyM97XdzfZ0dl9uOJC6PYn1FpkeyQg== dependencies: - "@algolia/client-common" "5.37.0" + "@algolia/client-common" "5.52.1" "@babel/code-frame@^7.0.0", "@babel/code-frame@^7.27.1": version "7.27.1" @@ -1019,13 +1032,6 @@ "@babel/plugin-transform-modules-commonjs" "^7.27.1" "@babel/plugin-transform-typescript" "^7.27.1" -"@babel/runtime-corejs3@^7.25.9": - version "7.28.4" - resolved "https://registry.yarnpkg.com/@babel/runtime-corejs3/-/runtime-corejs3-7.28.4.tgz#c25be39c7997ce2f130d70b9baecb8ed94df93fa" - integrity sha512-h7iEYiW4HebClDEhtvFObtPmIvrd1SSfpI9EhOeKk4CtIK/ngBWFpuhCzhdmRKtg71ylcue+9I6dv54XYO1epQ== - dependencies: - core-js-pure "^3.43.0" - "@babel/runtime@^7.1.2", "@babel/runtime@^7.10.3", "@babel/runtime@^7.12.13", "@babel/runtime@^7.12.5", "@babel/runtime@^7.18.3", "@babel/runtime@^7.25.9", "@babel/runtime@^7.28.3", "@babel/runtime@^7.5.5", "@babel/runtime@^7.8.7": version "7.28.4" resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.28.4.tgz#a70226016fabe25c5783b2f22d3e1c9bc5ca3326" @@ -1426,25 +1432,29 @@ resolved "https://registry.yarnpkg.com/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz#1d572bfbbe14b7704e0ba0f39b74815b84870d70" integrity sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw== -"@docsearch/css@3.9.0": - version "3.9.0" - resolved "https://registry.yarnpkg.com/@docsearch/css/-/css-3.9.0.tgz#3bc29c96bf024350d73b0cfb7c2a7b71bf251cd5" - integrity sha512-cQbnVbq0rrBwNAKegIac/t6a8nWoUAn8frnkLFW6YARaRmAQr5/Eoe6Ln2fqkUCZ40KpdrKbpSAmgrkviOxuWA== +"@docsearch/core@4.6.3": + version "4.6.3" + resolved "https://registry.yarnpkg.com/@docsearch/core/-/core-4.6.3.tgz#9954c75c3ae28418e06f8e7537a920d6cd2bc22e" + integrity sha512-rUOujwIpxJRgD7+kicVsI3D5sqBvdiRTquzWBpTEXZs8ZXfGbfzpus5HqumaNYTppN2HvH8E2yNuRwYdHJeOlA== -"@docsearch/react@^3.9.0": - version "3.9.0" - resolved "https://registry.yarnpkg.com/@docsearch/react/-/react-3.9.0.tgz#d0842b700c3ee26696786f3c8ae9f10c1a3f0db3" - integrity sha512-mb5FOZYZIkRQ6s/NWnM98k879vu5pscWqTLubLFBO87igYYT4VzVazh4h5o/zCvTIZgEt3PvsCOMOswOUo9yHQ== +"@docsearch/css@4.6.3": + version "4.6.3" + resolved "https://registry.yarnpkg.com/@docsearch/css/-/css-4.6.3.tgz#a94065af4a996dd927dc5dda383395e583dbd638" + integrity sha512-nlOwcXcsNAptQl4vlL4MA78qNJKO0Qlds5GuBjCoePgkebTXLSf8Qt1oyZ3YBshYupKXG9VRGEsk1zr23d+bzQ== + +"@docsearch/react@^3.9.0 || ^4.3.2": + version "4.6.3" + resolved "https://registry.yarnpkg.com/@docsearch/react/-/react-4.6.3.tgz#80df785f9c5e484c960b914a22ea2a3e4c7210ad" + integrity sha512-Bg2wdDsoQVlNCcEKuEJAU04tvHCqgx8rIu+uIoM4pRtcx3TBKJuXutJik3LTA8LRc9YEyHkrYUrmcC0D7BYf+g== dependencies: - "@algolia/autocomplete-core" "1.17.9" - "@algolia/autocomplete-preset-algolia" "1.17.9" - "@docsearch/css" "3.9.0" - algoliasearch "^5.14.2" + "@algolia/autocomplete-core" "1.19.2" + "@docsearch/core" "4.6.3" + "@docsearch/css" "4.6.3" -"@docusaurus/babel@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/babel/-/babel-3.8.1.tgz#db329ac047184214e08e2dbc809832c696c18506" - integrity sha512-3brkJrml8vUbn9aeoZUlJfsI/GqyFcDgQJwQkmBtclJgWDEQBKKeagZfOgx0WfUQhagL1sQLNW0iBdxnI863Uw== +"@docusaurus/babel@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/babel/-/babel-3.10.1.tgz#2f714f682117658ba43d308e9b35b6a73a105227" + integrity sha512-DZzFO1K3v/GoEt1fx1DiYHF4en+PuhtQf1AkQJa5zu3CoeKSpr5cpQRUlz3jr0m44wyzmSXu9bVpfir+N4+8bg== dependencies: "@babel/core" "^7.25.9" "@babel/generator" "^7.25.9" @@ -1454,25 +1464,24 @@ "@babel/preset-react" "^7.25.9" "@babel/preset-typescript" "^7.25.9" "@babel/runtime" "^7.25.9" - "@babel/runtime-corejs3" "^7.25.9" "@babel/traverse" "^7.25.9" - "@docusaurus/logger" "3.8.1" - "@docusaurus/utils" "3.8.1" + "@docusaurus/logger" "3.10.1" + "@docusaurus/utils" "3.10.1" babel-plugin-dynamic-import-node "^2.3.3" fs-extra "^11.1.1" tslib "^2.6.0" -"@docusaurus/bundler@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/bundler/-/bundler-3.8.1.tgz#e2b11d615f09a6e470774bb36441b8d06736b94c" - integrity sha512-/z4V0FRoQ0GuSLToNjOSGsk6m2lQUG4FRn8goOVoZSRsTrU8YR2aJacX5K3RG18EaX9b+52pN4m1sL3MQZVsQA== +"@docusaurus/bundler@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/bundler/-/bundler-3.10.1.tgz#82fa5079f3787a67502e25f82d37d05ec5de0cc3" + integrity sha512-HIqQPvbqnnQRe4NsBd1774KRarjXqS6wHsWELtyuSs1gCfvixJO2jUGH/OEBtr1Gvzpw+ze5CjGMvSJ8UE1KUw== dependencies: "@babel/core" "^7.25.9" - "@docusaurus/babel" "3.8.1" - "@docusaurus/cssnano-preset" "3.8.1" - "@docusaurus/logger" "3.8.1" - "@docusaurus/types" "3.8.1" - "@docusaurus/utils" "3.8.1" + "@docusaurus/babel" "3.10.1" + "@docusaurus/cssnano-preset" "3.10.1" + "@docusaurus/logger" "3.10.1" + "@docusaurus/types" "3.10.1" + "@docusaurus/utils" "3.10.1" babel-loader "^9.2.1" clean-css "^5.3.3" copy-webpack-plugin "^11.0.0" @@ -1490,20 +1499,20 @@ tslib "^2.6.0" url-loader "^4.1.1" webpack "^5.95.0" - webpackbar "^6.0.1" - -"@docusaurus/core@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/core/-/core-3.8.1.tgz#c22e47c16a22cb7d245306c64bc54083838ff3db" - integrity sha512-ENB01IyQSqI2FLtOzqSI3qxG2B/jP4gQPahl2C3XReiLebcVh5B5cB9KYFvdoOqOWPyr5gXK4sjgTKv7peXCrA== - dependencies: - "@docusaurus/babel" "3.8.1" - "@docusaurus/bundler" "3.8.1" - "@docusaurus/logger" "3.8.1" - "@docusaurus/mdx-loader" "3.8.1" - "@docusaurus/utils" "3.8.1" - "@docusaurus/utils-common" "3.8.1" - "@docusaurus/utils-validation" "3.8.1" + webpackbar "^7.0.0" + +"@docusaurus/core@3.10.1", "@docusaurus/core@^3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/core/-/core-3.10.1.tgz#3f8bdb97451b4df14f2a3b39ab0186366fbf8fbe" + integrity sha512-3pf2fXXw0eVk8WnC3T4LIigRDupcpvngpKo9Vy7mYyBhuddc0klDUuZAIfzMoK6z05pdlk6EFC/vBSX43+1O5w== + dependencies: + "@docusaurus/babel" "3.10.1" + "@docusaurus/bundler" "3.10.1" + "@docusaurus/logger" "3.10.1" + "@docusaurus/mdx-loader" "3.10.1" + "@docusaurus/utils" "3.10.1" + "@docusaurus/utils-common" "3.10.1" + "@docusaurus/utils-validation" "3.10.1" boxen "^6.2.1" chalk "^4.1.2" chokidar "^3.5.3" @@ -1515,7 +1524,7 @@ escape-html "^1.0.3" eta "^2.2.0" eval "^0.1.8" - execa "5.1.1" + execa "^5.1.1" fs-extra "^11.1.1" html-tags "^3.3.1" html-webpack-plugin "^5.6.0" @@ -1526,46 +1535,62 @@ prompts "^2.4.2" react-helmet-async "npm:@slorber/react-helmet-async@1.3.0" react-loadable "npm:@docusaurus/react-loadable@6.0.0" - react-loadable-ssr-addon-v5-slorber "^1.0.1" + react-loadable-ssr-addon-v5-slorber "^1.0.3" react-router "^5.3.4" react-router-config "^5.1.1" react-router-dom "^5.3.4" semver "^7.5.4" - serve-handler "^6.1.6" + serve-handler "^6.1.7" tinypool "^1.0.2" tslib "^2.6.0" update-notifier "^6.0.2" webpack "^5.95.0" webpack-bundle-analyzer "^4.10.2" - webpack-dev-server "^4.15.2" + webpack-dev-server "^5.2.2" webpack-merge "^6.0.1" -"@docusaurus/cssnano-preset@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/cssnano-preset/-/cssnano-preset-3.8.1.tgz#bd55026251a6ab8e2194839a2042458ef9880c44" - integrity sha512-G7WyR2N6SpyUotqhGznERBK+x84uyhfMQM2MmDLs88bw4Flom6TY46HzkRkSEzaP9j80MbTN8naiL1fR17WQug== +"@docusaurus/cssnano-preset@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/cssnano-preset/-/cssnano-preset-3.10.1.tgz#4b6bafeca8bb9423364d2fd6683c28e2f85a4665" + integrity sha512-eNfHGcTKCSq6xmcavAkX3RRclHaE2xRCMParlDXLdXVP01/a2e/jKXMj/0ULnLFQSNwwuI62L0Ge8J+nZsR7UQ== dependencies: cssnano-preset-advanced "^6.1.2" postcss "^8.5.4" postcss-sort-media-queries "^5.2.0" tslib "^2.6.0" -"@docusaurus/logger@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/logger/-/logger-3.8.1.tgz#45321b2e2e14695d0dbd8b4104ea7b0fbaa98700" - integrity sha512-2wjeGDhKcExEmjX8k1N/MRDiPKXGF2Pg+df/bDDPnnJWHXnVEZxXj80d6jcxp1Gpnksl0hF8t/ZQw9elqj2+ww== +"@docusaurus/faster@^3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/faster/-/faster-3.10.1.tgz#a63d89ae980c98e1eeab3ff15ee083f7c20ed353" + integrity sha512-XTZhE5C1gZ/DaYYMlSk02dwP5vhpQON5QHVz1s3892mSESAywgWanURpXEDAvt4GvGuq7s+XP8rTWHZvfaJmdQ== + dependencies: + "@docusaurus/types" "3.10.1" + "@rspack/core" "^1.7.10" + "@swc/core" "^1.7.39" + "@swc/html" "^1.13.5" + browserslist "^4.24.2" + lightningcss "^1.27.0" + semver "^7.5.4" + swc-loader "^0.2.6" + tslib "^2.6.0" + webpack "^5.95.0" + +"@docusaurus/logger@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/logger/-/logger-3.10.1.tgz#34c964e32e18f120e30f80171a38cfefe72cfb4b" + integrity sha512-oPjNFnfJsRCkePVjkGrxWGq4MvJKRQT0r9jOP0eRBTZ7Wr9FAbzdP/Gjs0I2Ss6YRkPoEgygKG112OkE6skvJw== dependencies: chalk "^4.1.2" tslib "^2.6.0" -"@docusaurus/mdx-loader@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/mdx-loader/-/mdx-loader-3.8.1.tgz#74309b3614bbcef1d55fb13e6cc339b7fb000b5f" - integrity sha512-DZRhagSFRcEq1cUtBMo4TKxSNo/W6/s44yhr8X+eoXqCLycFQUylebOMPseHi5tc4fkGJqwqpWJLz6JStU9L4w== +"@docusaurus/mdx-loader@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/mdx-loader/-/mdx-loader-3.10.1.tgz#050ae9bc614158a4ec07a628aa75fa9ae90d7e82" + integrity sha512-GRmeb/wQ+iXRrFwcHBfgQhrJxGElgCsoTWZYDhccjsZVne1p8MK/EpQVIloXttz76TCe78kKD5AEG9n1xc1oxQ== dependencies: - "@docusaurus/logger" "3.8.1" - "@docusaurus/utils" "3.8.1" - "@docusaurus/utils-validation" "3.8.1" + "@docusaurus/logger" "3.10.1" + "@docusaurus/utils" "3.10.1" + "@docusaurus/utils-validation" "3.10.1" "@mdx-js/mdx" "^3.0.0" "@slorber/remark-comment" "^1.0.0" escape-html "^1.0.3" @@ -1588,12 +1613,12 @@ vfile "^6.0.1" webpack "^5.88.1" -"@docusaurus/module-type-aliases@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/module-type-aliases/-/module-type-aliases-3.8.1.tgz#454de577bd7f50b5eae16db0f76b49ca5e4e281a" - integrity sha512-6xhvAJiXzsaq3JdosS7wbRt/PwEPWHr9eM4YNYqVlbgG1hSK3uQDXTVvQktasp3VO6BmfYWPozueLWuj4gB+vg== +"@docusaurus/module-type-aliases@3.10.1", "@docusaurus/module-type-aliases@^3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/module-type-aliases/-/module-type-aliases-3.10.1.tgz#22d39177c296786eb6e0d940699cd590cc93ca77" + integrity sha512-YoOZKUdGlp8xSYhuAkGdSo5Ydkbq4V4eK3sD8v0a2hloxCWdQbNBhkc+Ko9QyjpESc0BYcIGM5iHVAy5hdFV6w== dependencies: - "@docusaurus/types" "3.8.1" + "@docusaurus/types" "3.10.1" "@types/history" "^4.7.11" "@types/react" "*" "@types/react-router-config" "*" @@ -1601,20 +1626,21 @@ react-helmet-async "npm:@slorber/react-helmet-async@1.3.0" react-loadable "npm:@docusaurus/react-loadable@6.0.0" -"@docusaurus/plugin-content-blog@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.8.1.tgz#88d842b562b04cf59df900d9f6984b086f821525" - integrity sha512-vNTpMmlvNP9n3hGEcgPaXyvTljanAKIUkuG9URQ1DeuDup0OR7Ltvoc8yrmH+iMZJbcQGhUJF+WjHLwuk8HSdw== - dependencies: - "@docusaurus/core" "3.8.1" - "@docusaurus/logger" "3.8.1" - "@docusaurus/mdx-loader" "3.8.1" - "@docusaurus/theme-common" "3.8.1" - "@docusaurus/types" "3.8.1" - "@docusaurus/utils" "3.8.1" - "@docusaurus/utils-common" "3.8.1" - "@docusaurus/utils-validation" "3.8.1" +"@docusaurus/plugin-content-blog@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.10.1.tgz#0bd8de700ccbd8e95d920df2613304ef59abe72b" + integrity sha512-mmkgE6Q2+K74tnkou7tXlpDLvoCU/qkSa2GSQ3XUiHWvcebCoDQzS670RR3tO8PmaWlIyWWISYWzZLuMfxunRA== + dependencies: + "@docusaurus/core" "3.10.1" + "@docusaurus/logger" "3.10.1" + "@docusaurus/mdx-loader" "3.10.1" + "@docusaurus/theme-common" "3.10.1" + "@docusaurus/types" "3.10.1" + "@docusaurus/utils" "3.10.1" + "@docusaurus/utils-common" "3.10.1" + "@docusaurus/utils-validation" "3.10.1" cheerio "1.0.0-rc.12" + combine-promises "^1.1.0" feed "^4.2.2" fs-extra "^11.1.1" lodash "^4.17.21" @@ -1625,20 +1651,20 @@ utility-types "^3.10.0" webpack "^5.88.1" -"@docusaurus/plugin-content-docs@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.8.1.tgz#40686a206abb6373bee5638de100a2c312f112a4" - integrity sha512-oByRkSZzeGNQByCMaX+kif5Nl2vmtj2IHQI2fWjCfCootsdKZDPFLonhIp5s3IGJO7PLUfe0POyw0Xh/RrGXJA== - dependencies: - "@docusaurus/core" "3.8.1" - "@docusaurus/logger" "3.8.1" - "@docusaurus/mdx-loader" "3.8.1" - "@docusaurus/module-type-aliases" "3.8.1" - "@docusaurus/theme-common" "3.8.1" - "@docusaurus/types" "3.8.1" - "@docusaurus/utils" "3.8.1" - "@docusaurus/utils-common" "3.8.1" - "@docusaurus/utils-validation" "3.8.1" +"@docusaurus/plugin-content-docs@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.10.1.tgz#261e0e982e4a937c05b462e3c5729374f433b752" + integrity sha512-2jRVrtzjf8LClGTHQlwlwuD3wQXRx3WEoF7XUarJ8Ou+0onV+SLtejsyfY9JLpfUh9hPhXM4pbBGkyAY4Bi3HQ== + dependencies: + "@docusaurus/core" "3.10.1" + "@docusaurus/logger" "3.10.1" + "@docusaurus/mdx-loader" "3.10.1" + "@docusaurus/module-type-aliases" "3.10.1" + "@docusaurus/theme-common" "3.10.1" + "@docusaurus/types" "3.10.1" + "@docusaurus/utils" "3.10.1" + "@docusaurus/utils-common" "3.10.1" + "@docusaurus/utils-validation" "3.10.1" "@types/react-router-config" "^5.0.7" combine-promises "^1.1.0" fs-extra "^11.1.1" @@ -1649,142 +1675,142 @@ utility-types "^3.10.0" webpack "^5.88.1" -"@docusaurus/plugin-content-pages@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-pages/-/plugin-content-pages-3.8.1.tgz#41b684dbd15390b7bb6a627f78bf81b6324511ac" - integrity sha512-a+V6MS2cIu37E/m7nDJn3dcxpvXb6TvgdNI22vJX8iUTp8eoMoPa0VArEbWvCxMY/xdC26WzNv4wZ6y0iIni/w== +"@docusaurus/plugin-content-pages@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-pages/-/plugin-content-pages-3.10.1.tgz#8c6ffc2079ed0262548ecc4df1dea6add6aa9673" + integrity sha512-huJpaRPMl42nsFwuCXvV8bVDj2MazuwRJIUylI/RSlmZeJssVoZXeCjVf1y+1Drtpa9SKcdGn8yoJ76IRJijtw== dependencies: - "@docusaurus/core" "3.8.1" - "@docusaurus/mdx-loader" "3.8.1" - "@docusaurus/types" "3.8.1" - "@docusaurus/utils" "3.8.1" - "@docusaurus/utils-validation" "3.8.1" + "@docusaurus/core" "3.10.1" + "@docusaurus/mdx-loader" "3.10.1" + "@docusaurus/types" "3.10.1" + "@docusaurus/utils" "3.10.1" + "@docusaurus/utils-validation" "3.10.1" fs-extra "^11.1.1" tslib "^2.6.0" webpack "^5.88.1" -"@docusaurus/plugin-css-cascade-layers@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-css-cascade-layers/-/plugin-css-cascade-layers-3.8.1.tgz#cb414b4a82aa60fc64ef2a435ad0105e142a6c71" - integrity sha512-VQ47xRxfNKjHS5ItzaVXpxeTm7/wJLFMOPo1BkmoMG4Cuz4nuI+Hs62+RMk1OqVog68Swz66xVPK8g9XTrBKRw== +"@docusaurus/plugin-css-cascade-layers@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-css-cascade-layers/-/plugin-css-cascade-layers-3.10.1.tgz#440578d95cbe1a6120936fa83df868d2626cd1d8" + integrity sha512-r//fn+MNHkE1wCof8T29VAQezt1enGCpsFxoziBbvLgBM4JfXN2P3rxrBaavHmvLvm7lYkpJeitcDthwnmWCTw== dependencies: - "@docusaurus/core" "3.8.1" - "@docusaurus/types" "3.8.1" - "@docusaurus/utils" "3.8.1" - "@docusaurus/utils-validation" "3.8.1" + "@docusaurus/core" "3.10.1" + "@docusaurus/types" "3.10.1" + "@docusaurus/utils" "3.10.1" + "@docusaurus/utils-validation" "3.10.1" tslib "^2.6.0" -"@docusaurus/plugin-debug@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-debug/-/plugin-debug-3.8.1.tgz#45b107e46b627caaae66995f53197ace78af3491" - integrity sha512-nT3lN7TV5bi5hKMB7FK8gCffFTBSsBsAfV84/v293qAmnHOyg1nr9okEw8AiwcO3bl9vije5nsUvP0aRl2lpaw== +"@docusaurus/plugin-debug@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-debug/-/plugin-debug-3.10.1.tgz#b8b7b24d9a7d185fd8a56a030f90145d3bfd8239" + integrity sha512-9KqOpKNfAyqGZykRb9LhIT/vyRF6sm/ykhjj/39JvaJahDS+jZJE0Z1Wfz9q3DUNDTMNN0Q7u/kk4rKKU+IJuA== dependencies: - "@docusaurus/core" "3.8.1" - "@docusaurus/types" "3.8.1" - "@docusaurus/utils" "3.8.1" + "@docusaurus/core" "3.10.1" + "@docusaurus/types" "3.10.1" + "@docusaurus/utils" "3.10.1" fs-extra "^11.1.1" react-json-view-lite "^2.3.0" tslib "^2.6.0" -"@docusaurus/plugin-google-analytics@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-3.8.1.tgz#64a302e62fe5cb6e007367c964feeef7b056764a" - integrity sha512-Hrb/PurOJsmwHAsfMDH6oVpahkEGsx7F8CWMjyP/dw1qjqmdS9rcV1nYCGlM8nOtD3Wk/eaThzUB5TSZsGz+7Q== +"@docusaurus/plugin-google-analytics@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-3.10.1.tgz#ac15afc77386e0352edb8a1698d993aa5de36ffc" + integrity sha512-8o0P1KtmgdYQHH+oInitPpRWI0Of5XednAX4+DMhQNSmGSRNrsEEHg1ebv35m9AgRClfAytCJ5jA9KvcASTyuA== dependencies: - "@docusaurus/core" "3.8.1" - "@docusaurus/types" "3.8.1" - "@docusaurus/utils-validation" "3.8.1" + "@docusaurus/core" "3.10.1" + "@docusaurus/types" "3.10.1" + "@docusaurus/utils-validation" "3.10.1" tslib "^2.6.0" -"@docusaurus/plugin-google-gtag@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-3.8.1.tgz#8c76f8a1d96448f2f0f7b10e6bde451c40672b95" - integrity sha512-tKE8j1cEZCh8KZa4aa80zpSTxsC2/ZYqjx6AAfd8uA8VHZVw79+7OTEP2PoWi0uL5/1Is0LF5Vwxd+1fz5HlKg== +"@docusaurus/plugin-google-gtag@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-3.10.1.tgz#0482b83b9bc411aa99a432be2b39d2e53a00e2e0" + integrity sha512-pu3xIUo5o/zCMLfUY9BO5KOwSH0zIsAGyFRPvXHayFSA5XIhCU/SFuB0g0ZNjFn9niZLCaNvoeAuOGFJZq0fdw== dependencies: - "@docusaurus/core" "3.8.1" - "@docusaurus/types" "3.8.1" - "@docusaurus/utils-validation" "3.8.1" - "@types/gtag.js" "^0.0.12" + "@docusaurus/core" "3.10.1" + "@docusaurus/types" "3.10.1" + "@docusaurus/utils-validation" "3.10.1" + "@types/gtag.js" "^0.0.20" tslib "^2.6.0" -"@docusaurus/plugin-google-tag-manager@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-tag-manager/-/plugin-google-tag-manager-3.8.1.tgz#88241ffd06369f4a4d5fb982ff3ac2777561ae37" - integrity sha512-iqe3XKITBquZq+6UAXdb1vI0fPY5iIOitVjPQ581R1ZKpHr0qe+V6gVOrrcOHixPDD/BUKdYwkxFjpNiEN+vBw== +"@docusaurus/plugin-google-tag-manager@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-tag-manager/-/plugin-google-tag-manager-3.10.1.tgz#eaf5765d6f82b4fb661d92a793d1883f9d1ec106" + integrity sha512-f6fyGHiCm7kJHBtAisGQS5oNBnpnMTYQZxDXeVrnw/3zWU+LMA22pr6UHGYkBKDbN+qPC5QHG3NuOfzQLq3+Lw== dependencies: - "@docusaurus/core" "3.8.1" - "@docusaurus/types" "3.8.1" - "@docusaurus/utils-validation" "3.8.1" + "@docusaurus/core" "3.10.1" + "@docusaurus/types" "3.10.1" + "@docusaurus/utils-validation" "3.10.1" tslib "^2.6.0" -"@docusaurus/plugin-sitemap@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-sitemap/-/plugin-sitemap-3.8.1.tgz#3aebd39186dc30e53023f1aab44625bc0bdac892" - integrity sha512-+9YV/7VLbGTq8qNkjiugIelmfUEVkTyLe6X8bWq7K5qPvGXAjno27QAfFq63mYfFFbJc7z+pudL63acprbqGzw== - dependencies: - "@docusaurus/core" "3.8.1" - "@docusaurus/logger" "3.8.1" - "@docusaurus/types" "3.8.1" - "@docusaurus/utils" "3.8.1" - "@docusaurus/utils-common" "3.8.1" - "@docusaurus/utils-validation" "3.8.1" +"@docusaurus/plugin-sitemap@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-sitemap/-/plugin-sitemap-3.10.1.tgz#66a6974bb2fd1b9d8f5cb0f3c5ecd2201c118565" + integrity sha512-C26MbmmqgdjkDq1htaZ3aD7LzEDKFWXfpyQpt0EOUThuq5nV77zDaedV20yHcVo9p+3ey9aZ4pbHA0D3QcZTzg== + dependencies: + "@docusaurus/core" "3.10.1" + "@docusaurus/logger" "3.10.1" + "@docusaurus/types" "3.10.1" + "@docusaurus/utils" "3.10.1" + "@docusaurus/utils-common" "3.10.1" + "@docusaurus/utils-validation" "3.10.1" fs-extra "^11.1.1" sitemap "^7.1.1" tslib "^2.6.0" -"@docusaurus/plugin-svgr@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-svgr/-/plugin-svgr-3.8.1.tgz#6f340be8eae418a2cce540d8ece096ffd9c9b6ab" - integrity sha512-rW0LWMDsdlsgowVwqiMb/7tANDodpy1wWPwCcamvhY7OECReN3feoFwLjd/U4tKjNY3encj0AJSTxJA+Fpe+Gw== +"@docusaurus/plugin-svgr@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-svgr/-/plugin-svgr-3.10.1.tgz#c217c24d6d23fd2bc6f54d44c040635b49d6b36e" + integrity sha512-6SFxsmjWFkVLDmBUvFK6i72QjUwqyQFe4Ovz+SUJophJjOyVG3ZZG5IQpBC/kX/Gfv1yWeU9nWauH6F6Q7QX/Q== dependencies: - "@docusaurus/core" "3.8.1" - "@docusaurus/types" "3.8.1" - "@docusaurus/utils" "3.8.1" - "@docusaurus/utils-validation" "3.8.1" + "@docusaurus/core" "3.10.1" + "@docusaurus/types" "3.10.1" + "@docusaurus/utils" "3.10.1" + "@docusaurus/utils-validation" "3.10.1" "@svgr/core" "8.1.0" "@svgr/webpack" "^8.1.0" tslib "^2.6.0" webpack "^5.88.1" -"@docusaurus/preset-classic@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/preset-classic/-/preset-classic-3.8.1.tgz#bb79fd12f3211363720c569a526c7e24d3aa966b" - integrity sha512-yJSjYNHXD8POMGc2mKQuj3ApPrN+eG0rO1UPgSx7jySpYU+n4WjBikbrA2ue5ad9A7aouEtMWUoiSRXTH/g7KQ== - dependencies: - "@docusaurus/core" "3.8.1" - "@docusaurus/plugin-content-blog" "3.8.1" - "@docusaurus/plugin-content-docs" "3.8.1" - "@docusaurus/plugin-content-pages" "3.8.1" - "@docusaurus/plugin-css-cascade-layers" "3.8.1" - "@docusaurus/plugin-debug" "3.8.1" - "@docusaurus/plugin-google-analytics" "3.8.1" - "@docusaurus/plugin-google-gtag" "3.8.1" - "@docusaurus/plugin-google-tag-manager" "3.8.1" - "@docusaurus/plugin-sitemap" "3.8.1" - "@docusaurus/plugin-svgr" "3.8.1" - "@docusaurus/theme-classic" "3.8.1" - "@docusaurus/theme-common" "3.8.1" - "@docusaurus/theme-search-algolia" "3.8.1" - "@docusaurus/types" "3.8.1" - -"@docusaurus/theme-classic@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-classic/-/theme-classic-3.8.1.tgz#1e45c66d89ded359225fcd29bf3258d9205765c1" - integrity sha512-bqDUCNqXeYypMCsE1VcTXSI1QuO4KXfx8Cvl6rYfY0bhhqN6d2WZlRkyLg/p6pm+DzvanqHOyYlqdPyP0iz+iw== - dependencies: - "@docusaurus/core" "3.8.1" - "@docusaurus/logger" "3.8.1" - "@docusaurus/mdx-loader" "3.8.1" - "@docusaurus/module-type-aliases" "3.8.1" - "@docusaurus/plugin-content-blog" "3.8.1" - "@docusaurus/plugin-content-docs" "3.8.1" - "@docusaurus/plugin-content-pages" "3.8.1" - "@docusaurus/theme-common" "3.8.1" - "@docusaurus/theme-translations" "3.8.1" - "@docusaurus/types" "3.8.1" - "@docusaurus/utils" "3.8.1" - "@docusaurus/utils-common" "3.8.1" - "@docusaurus/utils-validation" "3.8.1" +"@docusaurus/preset-classic@^3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/preset-classic/-/preset-classic-3.10.1.tgz#faf330d96aedc9083a59bec09d966ae4dfc8b2fb" + integrity sha512-YO/FL8v1zmbxoTso6mjMz/RDjhaTJxb1UpFFTDdY5847LLDCeyYiYlrhyTbgN1RIN3xnkLKZ9Lj1x8hUzI4JOg== + dependencies: + "@docusaurus/core" "3.10.1" + "@docusaurus/plugin-content-blog" "3.10.1" + "@docusaurus/plugin-content-docs" "3.10.1" + "@docusaurus/plugin-content-pages" "3.10.1" + "@docusaurus/plugin-css-cascade-layers" "3.10.1" + "@docusaurus/plugin-debug" "3.10.1" + "@docusaurus/plugin-google-analytics" "3.10.1" + "@docusaurus/plugin-google-gtag" "3.10.1" + "@docusaurus/plugin-google-tag-manager" "3.10.1" + "@docusaurus/plugin-sitemap" "3.10.1" + "@docusaurus/plugin-svgr" "3.10.1" + "@docusaurus/theme-classic" "3.10.1" + "@docusaurus/theme-common" "3.10.1" + "@docusaurus/theme-search-algolia" "3.10.1" + "@docusaurus/types" "3.10.1" + +"@docusaurus/theme-classic@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-classic/-/theme-classic-3.10.1.tgz#deed8cf73cc0f56113e53775cbb3b168c3c61566" + integrity sha512-VU1RK0qb2pab0si4r7HFK37cYco8VzqLj3u1PspVipSr/z/GPVKHO4/HXbnePqHoWDk8urjyGSeatH0NIMBM1A== + dependencies: + "@docusaurus/core" "3.10.1" + "@docusaurus/logger" "3.10.1" + "@docusaurus/mdx-loader" "3.10.1" + "@docusaurus/module-type-aliases" "3.10.1" + "@docusaurus/plugin-content-blog" "3.10.1" + "@docusaurus/plugin-content-docs" "3.10.1" + "@docusaurus/plugin-content-pages" "3.10.1" + "@docusaurus/theme-common" "3.10.1" + "@docusaurus/theme-translations" "3.10.1" + "@docusaurus/types" "3.10.1" + "@docusaurus/utils" "3.10.1" + "@docusaurus/utils-common" "3.10.1" + "@docusaurus/utils-validation" "3.10.1" "@mdx-js/react" "^3.0.0" clsx "^2.0.0" copy-text-to-clipboard "^3.2.0" @@ -1799,15 +1825,15 @@ tslib "^2.6.0" utility-types "^3.10.0" -"@docusaurus/theme-common@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-common/-/theme-common-3.8.1.tgz#17c23316fbe3ee3f7e707c7298cb59a0fff38b4b" - integrity sha512-UswMOyTnPEVRvN5Qzbo+l8k4xrd5fTFu2VPPfD6FcW/6qUtVLmJTQCktbAL3KJ0BVXGm5aJXz/ZrzqFuZERGPw== +"@docusaurus/theme-common@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-common/-/theme-common-3.10.1.tgz#cbfec82b1b107be5c229811ed9caae14a501361c" + integrity sha512-0YtmIeoNo1fIw65LO8+/1dPgmDV86UmhMkow37gzjytuiCSQm9xob6PJy0L4kuQEMTLfUOGvkXvZr7GPrHquMA== dependencies: - "@docusaurus/mdx-loader" "3.8.1" - "@docusaurus/module-type-aliases" "3.8.1" - "@docusaurus/utils" "3.8.1" - "@docusaurus/utils-common" "3.8.1" + "@docusaurus/mdx-loader" "3.10.1" + "@docusaurus/module-type-aliases" "3.10.1" + "@docusaurus/utils" "3.10.1" + "@docusaurus/utils-common" "3.10.1" "@types/history" "^4.7.11" "@types/react" "*" "@types/react-router-config" "*" @@ -1817,21 +1843,22 @@ tslib "^2.6.0" utility-types "^3.10.0" -"@docusaurus/theme-search-algolia@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.8.1.tgz#3aa3d99c35cc2d4b709fcddd4df875a9b536e29b" - integrity sha512-NBFH5rZVQRAQM087aYSRKQ9yGEK9eHd+xOxQjqNpxMiV85OhJDD4ZGz6YJIod26Fbooy54UWVdzNU0TFeUUUzQ== - dependencies: - "@docsearch/react" "^3.9.0" - "@docusaurus/core" "3.8.1" - "@docusaurus/logger" "3.8.1" - "@docusaurus/plugin-content-docs" "3.8.1" - "@docusaurus/theme-common" "3.8.1" - "@docusaurus/theme-translations" "3.8.1" - "@docusaurus/utils" "3.8.1" - "@docusaurus/utils-validation" "3.8.1" - algoliasearch "^5.17.1" - algoliasearch-helper "^3.22.6" +"@docusaurus/theme-search-algolia@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.10.1.tgz#6f422058711629ce8d7c2f17e1e54efa075c626e" + integrity sha512-OTaARARVZj2GvkJQjB+1jOIxntRaXea+G+fMsNqrZBAU1O1vJKDW22R7kECOHW27oJCLFN9HKaZeRrfAUyviug== + dependencies: + "@algolia/autocomplete-core" "^1.19.2" + "@docsearch/react" "^3.9.0 || ^4.3.2" + "@docusaurus/core" "3.10.1" + "@docusaurus/logger" "3.10.1" + "@docusaurus/plugin-content-docs" "3.10.1" + "@docusaurus/theme-common" "3.10.1" + "@docusaurus/theme-translations" "3.10.1" + "@docusaurus/utils" "3.10.1" + "@docusaurus/utils-validation" "3.10.1" + algoliasearch "^5.37.0" + algoliasearch-helper "^3.26.0" clsx "^2.0.0" eta "^2.2.0" fs-extra "^11.1.1" @@ -1839,21 +1866,22 @@ tslib "^2.6.0" utility-types "^3.10.0" -"@docusaurus/theme-translations@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-translations/-/theme-translations-3.8.1.tgz#4b1d76973eb53861e167c7723485e059ba4ffd0a" - integrity sha512-OTp6eebuMcf2rJt4bqnvuwmm3NVXfzfYejL+u/Y1qwKhZPrjPoKWfk1CbOP5xH5ZOPkiAsx4dHdQBRJszK3z2g== +"@docusaurus/theme-translations@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-translations/-/theme-translations-3.10.1.tgz#c3119a015652290eea560ca45ac775963d6eb75b" + integrity sha512-cLMyaKivjBVWKMJuWqyFVVgtqe8DPJNPkog0bn8W1MDVAKcPdxRFycBfC1We1RaNp7Rdk513bmtW78RR6OBxBw== dependencies: fs-extra "^11.1.1" tslib "^2.6.0" -"@docusaurus/types@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/types/-/types-3.8.1.tgz#83ab66c345464e003b576a49f78897482061fc26" - integrity sha512-ZPdW5AB+pBjiVrcLuw3dOS6BFlrG0XkS2lDGsj8TizcnREQg3J8cjsgfDviszOk4CweNfwo1AEELJkYaMUuOPg== +"@docusaurus/types@3.10.1", "@docusaurus/types@^3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/types/-/types-3.10.1.tgz#d42837938ae43ca2be0ca47e63e00476b5eb94be" + integrity sha512-XYMK8k1szDCFMw2V+Xyen0g7Kee1sP3dtFnl7vkGkZOkeAJ/oPDQPL8iz4HBKOo/cwU8QeV6onVjMqtP+tFzsw== dependencies: "@mdx-js/mdx" "^3.0.0" "@types/history" "^4.7.11" + "@types/mdast" "^4.0.2" "@types/react" "*" commander "^5.1.0" joi "^17.9.2" @@ -1862,38 +1890,38 @@ webpack "^5.95.0" webpack-merge "^5.9.0" -"@docusaurus/utils-common@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/utils-common/-/utils-common-3.8.1.tgz#c369b8c3041afb7dcd595d4172beb1cc1015c85f" - integrity sha512-zTZiDlvpvoJIrQEEd71c154DkcriBecm4z94OzEE9kz7ikS3J+iSlABhFXM45mZ0eN5pVqqr7cs60+ZlYLewtg== +"@docusaurus/utils-common@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/utils-common/-/utils-common-3.10.1.tgz#6350b4898691e765de750f90eade0e0fa7902d99" + integrity sha512-5mFSgEADtnFxFH7RLw02QA5MpU5JVUCj0MPeIvi/aF4Fi45tQRIuTwXoXDqJ+1VfQJuYJGz3SI63wmGz4HvXzA== dependencies: - "@docusaurus/types" "3.8.1" + "@docusaurus/types" "3.10.1" tslib "^2.6.0" -"@docusaurus/utils-validation@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/utils-validation/-/utils-validation-3.8.1.tgz#0499c0d151a4098a0963237057993282cfbd538e" - integrity sha512-gs5bXIccxzEbyVecvxg6upTwaUbfa0KMmTj7HhHzc016AGyxH2o73k1/aOD0IFrdCsfJNt37MqNI47s2MgRZMA== +"@docusaurus/utils-validation@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/utils-validation/-/utils-validation-3.10.1.tgz#ddbcce997a5506424cdd16abf6845cc51692acae" + integrity sha512-cRv1X69jwaWv47waglllgZVWzeBFLhl53XT/XED/83BerVBTC5FTP8WTcVl8Z6sZOegDSwitu/wpCSPCDOT6lg== dependencies: - "@docusaurus/logger" "3.8.1" - "@docusaurus/utils" "3.8.1" - "@docusaurus/utils-common" "3.8.1" + "@docusaurus/logger" "3.10.1" + "@docusaurus/utils" "3.10.1" + "@docusaurus/utils-common" "3.10.1" fs-extra "^11.2.0" joi "^17.9.2" js-yaml "^4.1.0" lodash "^4.17.21" tslib "^2.6.0" -"@docusaurus/utils@3.8.1": - version "3.8.1" - resolved "https://registry.yarnpkg.com/@docusaurus/utils/-/utils-3.8.1.tgz#2ac1e734106e2f73dbd0f6a8824d525f9064e9f0" - integrity sha512-P1ml0nvOmEFdmu0smSXOqTS1sxU5tqvnc0dA4MTKV39kye+bhQnjkIKEE18fNOvxjyB86k8esoCIFM3x4RykOQ== +"@docusaurus/utils@3.10.1": + version "3.10.1" + resolved "https://registry.yarnpkg.com/@docusaurus/utils/-/utils-3.10.1.tgz#535968caa2c9bff69f997a081b98b95b3c5d3785" + integrity sha512-3ojeJry9xBYdJO6qoyyzqeJFSJBVx2mXhyDzSdjwL2+URFQMf+h25gG38iswGImicK0ELjTd1EL2xzk8hf3QPw== dependencies: - "@docusaurus/logger" "3.8.1" - "@docusaurus/types" "3.8.1" - "@docusaurus/utils-common" "3.8.1" + "@docusaurus/logger" "3.10.1" + "@docusaurus/types" "3.10.1" + "@docusaurus/utils-common" "3.10.1" escape-string-regexp "^4.0.0" - execa "5.1.1" + execa "^5.1.1" file-loader "^6.2.0" fs-extra "^11.1.1" github-slugger "^1.5.0" @@ -1911,6 +1939,28 @@ utility-types "^3.10.0" webpack "^5.88.1" +"@emnapi/core@^1.5.0": + version "1.10.0" + resolved "https://registry.yarnpkg.com/@emnapi/core/-/core-1.10.0.tgz#380ccc8f2412ea22d1d972df7f8ee23a3b9c7467" + integrity sha512-yq6OkJ4p82CAfPl0u9mQebQHKPJkY7WrIuk205cTYnYe+k2Z8YBh11FrbRG/H6ihirqcacOgl2BIO8oyMQLeXw== + dependencies: + "@emnapi/wasi-threads" "1.2.1" + tslib "^2.4.0" + +"@emnapi/runtime@^1.5.0": + version "1.10.0" + resolved "https://registry.yarnpkg.com/@emnapi/runtime/-/runtime-1.10.0.tgz#4b260c0d3534204e98c6110b8db1a987d26ec87c" + integrity sha512-ewvYlk86xUoGI0zQRNq/mC+16R1QeDlKQy21Ki3oSYXNgLb45GV1P6A0M+/s6nyCuNDqe5VpaY84BzXGwVbwFA== + dependencies: + tslib "^2.4.0" + +"@emnapi/wasi-threads@1.2.1": + version "1.2.1" + resolved "https://registry.yarnpkg.com/@emnapi/wasi-threads/-/wasi-threads-1.2.1.tgz#28fed21a1ba1ce797c44a070abc94d42f3ae8548" + integrity sha512-uTII7OYF+/Mes/MrcIOYp5yOtSMLBWSIoLPpcgwipoiKbli6k322tcoFsxoIIxPDqW01SQGAgko4EzZi2BNv2w== + dependencies: + tslib "^2.4.0" + "@emotion/babel-plugin@^11.13.5": version "11.13.5" resolved "https://registry.yarnpkg.com/@emotion/babel-plugin/-/babel-plugin-11.13.5.tgz#eab8d65dbded74e0ecfd28dc218e75607c4e7bc0" @@ -2103,6 +2153,166 @@ "@jridgewell/resolve-uri" "^3.1.0" "@jridgewell/sourcemap-codec" "^1.4.14" +"@jsonjoy.com/base64@17.67.0": + version "17.67.0" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/base64/-/base64-17.67.0.tgz#7eeda3cb41138d77a90408fd2e42b2aba10576d7" + integrity sha512-5SEsJGsm15aP8TQGkDfJvz9axgPwAEm98S5DxOuYe8e1EbfajcDmgeXXzccEjh+mLnjqEKrkBdjHWS5vFNwDdw== + +"@jsonjoy.com/base64@^1.1.2": + version "1.1.2" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/base64/-/base64-1.1.2.tgz#cf8ea9dcb849b81c95f14fc0aaa151c6b54d2578" + integrity sha512-q6XAnWQDIMA3+FTiOYajoYqySkO+JSat0ytXGSuRdq9uXE7o92gzuQwQM14xaCRlBLGq3v5miDGC4vkVTn54xA== + +"@jsonjoy.com/buffers@17.67.0", "@jsonjoy.com/buffers@^17.65.0": + version "17.67.0" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/buffers/-/buffers-17.67.0.tgz#5c58dbcdeea8824ce296bd1cfce006c2eb167b3d" + integrity sha512-tfExRpYxBvi32vPs9ZHaTjSP4fHAfzSmcahOfNxtvGHcyJel+aibkPlGeBB+7AoC6hL7lXIE++8okecBxx7lcw== + +"@jsonjoy.com/buffers@^1.0.0", "@jsonjoy.com/buffers@^1.2.0": + version "1.2.1" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/buffers/-/buffers-1.2.1.tgz#8d99c7f67eaf724d3428dfd9826c6455266a5c83" + integrity sha512-12cdlDwX4RUM3QxmUbVJWqZ/mrK6dFQH4Zxq6+r1YXKXYBNgZXndx2qbCJwh3+WWkCSn67IjnlG3XYTvmvYtgA== + +"@jsonjoy.com/codegen@17.67.0": + version "17.67.0" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/codegen/-/codegen-17.67.0.tgz#3635fd8769d77e19b75dc5574bc9756019b2e591" + integrity sha512-idnkUplROpdBOV0HMcwhsCUS5TRUi9poagdGs70A6S4ux9+/aPuKbh8+UYRTLYQHtXvAdNfQWXDqZEx5k4Dj2Q== + +"@jsonjoy.com/codegen@^1.0.0": + version "1.0.0" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/codegen/-/codegen-1.0.0.tgz#5c23f796c47675f166d23b948cdb889184b93207" + integrity sha512-E8Oy+08cmCf0EK/NMxpaJZmOxPqM+6iSe2S4nlSBrPZOORoDJILxtbSUEDKQyTamm/BVAhIGllOBNU79/dwf0g== + +"@jsonjoy.com/fs-core@4.57.2": + version "4.57.2" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/fs-core/-/fs-core-4.57.2.tgz#e28f357ba9983ce53577ba34fc72d344f19ec459" + integrity sha512-SVjwklkpIV5wrynpYtuYnfYH1QF4/nDuLBX7VXdb+3miglcAgBVZb/5y0cOsehRV/9Vb+3UqhkMq3/NR3ztdkQ== + dependencies: + "@jsonjoy.com/fs-node-builtins" "4.57.2" + "@jsonjoy.com/fs-node-utils" "4.57.2" + thingies "^2.5.0" + +"@jsonjoy.com/fs-fsa@4.57.2": + version "4.57.2" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/fs-fsa/-/fs-fsa-4.57.2.tgz#ec6dd492ff8c104a0c1eae74959a013960fe8969" + integrity sha512-fhO8+iR2I+OCw668ISDJdn1aArc9zx033sWejIyzQ8RBeXa9bDSaUeA3ix0poYOfrj1KdOzytmYNv2/uLDfV6g== + dependencies: + "@jsonjoy.com/fs-core" "4.57.2" + "@jsonjoy.com/fs-node-builtins" "4.57.2" + "@jsonjoy.com/fs-node-utils" "4.57.2" + thingies "^2.5.0" + +"@jsonjoy.com/fs-node-builtins@4.57.2": + version "4.57.2" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/fs-node-builtins/-/fs-node-builtins-4.57.2.tgz#9174b87e70213b38caf1ac8669b130c4dfd6a909" + integrity sha512-xhiegylRmhw43Ki2HO1ZBL7DQ5ja/qpRsL29VtQ2xuUHiuDGbgf2uD4p9Qd8hJI5P6RCtGYD50IXHXVq/Ocjcg== + +"@jsonjoy.com/fs-node-to-fsa@4.57.2": + version "4.57.2" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/fs-node-to-fsa/-/fs-node-to-fsa-4.57.2.tgz#8542449b72dfc48f3bfe311a7b0af5323f9bc926" + integrity sha512-18LmWTSONhoAPW+IWRuf8w/+zRolPFGPeGwMxlAhhfY11EKzX+5XHDBPAw67dBF5dxDErHJbl40U+3IXSDRXSQ== + dependencies: + "@jsonjoy.com/fs-fsa" "4.57.2" + "@jsonjoy.com/fs-node-builtins" "4.57.2" + "@jsonjoy.com/fs-node-utils" "4.57.2" + +"@jsonjoy.com/fs-node-utils@4.57.2": + version "4.57.2" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/fs-node-utils/-/fs-node-utils-4.57.2.tgz#c3234c03b1e59d609a0915572dd6f450be0463b1" + integrity sha512-rsPSJgekz43IlNbLyAM/Ab+ouYLWGp5DDBfYBNNEqDaSpsbXfthBn29Q4muFA9L0F+Z3mKo+CWlgSCXrf+mOyQ== + dependencies: + "@jsonjoy.com/fs-node-builtins" "4.57.2" + +"@jsonjoy.com/fs-node@4.57.2": + version "4.57.2" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/fs-node/-/fs-node-4.57.2.tgz#8db2875df19683683e5852053e0099e233dc45d2" + integrity sha512-nX2AdL6cOFwLdju9G4/nbRnYevmCJbh7N7hvR3gGm97Cs60uEjyd0rpR+YBS7cTg175zzl22pGKXR5USaQMvKg== + dependencies: + "@jsonjoy.com/fs-core" "4.57.2" + "@jsonjoy.com/fs-node-builtins" "4.57.2" + "@jsonjoy.com/fs-node-utils" "4.57.2" + "@jsonjoy.com/fs-print" "4.57.2" + "@jsonjoy.com/fs-snapshot" "4.57.2" + glob-to-regex.js "^1.0.0" + thingies "^2.5.0" + +"@jsonjoy.com/fs-print@4.57.2": + version "4.57.2" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/fs-print/-/fs-print-4.57.2.tgz#286c4ceda19225a5c54aaad657ad9f466d5bd0c1" + integrity sha512-wK9NSow48i4DbDl9F1CQE5TqnyZOJ04elU3WFG5aJ76p+YxO/ulyBBQvKsessPxdo381Bc2pcEoyPujMOhcRqQ== + dependencies: + "@jsonjoy.com/fs-node-utils" "4.57.2" + tree-dump "^1.1.0" + +"@jsonjoy.com/fs-snapshot@4.57.2": + version "4.57.2" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/fs-snapshot/-/fs-snapshot-4.57.2.tgz#800424a076638a605dad5ef1540915bc0167d7f8" + integrity sha512-GdduDZuoP5V/QCgJkx9+BZ6SC0EZ/smXAdTS7PfMqgMTGXLlt/bH/FqMYaqB9JmLf05sJPtO0XRbAwwkEEPbVw== + dependencies: + "@jsonjoy.com/buffers" "^17.65.0" + "@jsonjoy.com/fs-node-utils" "4.57.2" + "@jsonjoy.com/json-pack" "^17.65.0" + "@jsonjoy.com/util" "^17.65.0" + +"@jsonjoy.com/json-pack@^1.11.0": + version "1.21.0" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/json-pack/-/json-pack-1.21.0.tgz#93f8dd57fe3a3a92132b33d1eb182dcd9e7629fa" + integrity sha512-+AKG+R2cfZMShzrF2uQw34v3zbeDYUqnQ+jg7ORic3BGtfw9p/+N6RJbq/kkV8JmYZaINknaEQ2m0/f693ZPpg== + dependencies: + "@jsonjoy.com/base64" "^1.1.2" + "@jsonjoy.com/buffers" "^1.2.0" + "@jsonjoy.com/codegen" "^1.0.0" + "@jsonjoy.com/json-pointer" "^1.0.2" + "@jsonjoy.com/util" "^1.9.0" + hyperdyperid "^1.2.0" + thingies "^2.5.0" + tree-dump "^1.1.0" + +"@jsonjoy.com/json-pack@^17.65.0": + version "17.67.0" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/json-pack/-/json-pack-17.67.0.tgz#8dd8ff65dd999c5d4d26df46c63915c7bdec093a" + integrity sha512-t0ejURcGaZsn1ClbJ/3kFqSOjlryd92eQY465IYrezsXmPcfHPE/av4twRSxf6WE+TkZgLY+71vCZbiIiFKA/w== + dependencies: + "@jsonjoy.com/base64" "17.67.0" + "@jsonjoy.com/buffers" "17.67.0" + "@jsonjoy.com/codegen" "17.67.0" + "@jsonjoy.com/json-pointer" "17.67.0" + "@jsonjoy.com/util" "17.67.0" + hyperdyperid "^1.2.0" + thingies "^2.5.0" + tree-dump "^1.1.0" + +"@jsonjoy.com/json-pointer@17.67.0": + version "17.67.0" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/json-pointer/-/json-pointer-17.67.0.tgz#74439573dc046e0c9a3a552fb94b391bc75313b8" + integrity sha512-+iqOFInH+QZGmSuaybBUNdh7yvNrXvqR+h3wjXm0N/3JK1EyyFAeGJvqnmQL61d1ARLlk/wJdFKSL+LHJ1eaUA== + dependencies: + "@jsonjoy.com/util" "17.67.0" + +"@jsonjoy.com/json-pointer@^1.0.2": + version "1.0.2" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/json-pointer/-/json-pointer-1.0.2.tgz#049cb530ac24e84cba08590c5e36b431c4843408" + integrity sha512-Fsn6wM2zlDzY1U+v4Nc8bo3bVqgfNTGcn6dMgs6FjrEnt4ZCe60o6ByKRjOGlI2gow0aE/Q41QOigdTqkyK5fg== + dependencies: + "@jsonjoy.com/codegen" "^1.0.0" + "@jsonjoy.com/util" "^1.9.0" + +"@jsonjoy.com/util@17.67.0", "@jsonjoy.com/util@^17.65.0": + version "17.67.0" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/util/-/util-17.67.0.tgz#7c4288fc3808233e55c7610101e7bb4590cddd3f" + integrity sha512-6+8xBaz1rLSohlGh68D1pdw3AwDi9xydm8QNlAFkvnavCJYSze+pxoW2VKP8p308jtlMRLs5NTHfPlZLd4w7ew== + dependencies: + "@jsonjoy.com/buffers" "17.67.0" + "@jsonjoy.com/codegen" "17.67.0" + +"@jsonjoy.com/util@^1.9.0": + version "1.9.0" + resolved "https://registry.yarnpkg.com/@jsonjoy.com/util/-/util-1.9.0.tgz#7ee95586aed0a766b746cd8d8363e336c3c47c46" + integrity sha512-pLuQo+VPRnN8hfPqUTLTHk126wuYdXVxE6aDmjSeV4NCAgyxWbiOIeNJVtID3h1Vzpoi9m4jXezf73I6LgabgQ== + dependencies: + "@jsonjoy.com/buffers" "^1.0.0" + "@jsonjoy.com/codegen" "^1.0.0" + "@leichtgewicht/ip-codec@^2.0.1": version "2.0.5" resolved "https://registry.yarnpkg.com/@leichtgewicht/ip-codec/-/ip-codec-2.0.5.tgz#4fc56c15c580b9adb7dc3c333a134e540b44bfb1" @@ -2146,6 +2356,49 @@ dependencies: "@types/mdx" "^2.0.0" +"@module-federation/error-codes@0.22.0": + version "0.22.0" + resolved "https://registry.yarnpkg.com/@module-federation/error-codes/-/error-codes-0.22.0.tgz#31ccc990dc240d73912ba7bd001f7e35ac751992" + integrity sha512-xF9SjnEy7vTdx+xekjPCV5cIHOGCkdn3pIxo9vU7gEZMIw0SvAEdsy6Uh17xaCpm8V0FWvR0SZoK9Ik6jGOaug== + +"@module-federation/runtime-core@0.22.0": + version "0.22.0" + resolved "https://registry.yarnpkg.com/@module-federation/runtime-core/-/runtime-core-0.22.0.tgz#7321ec792bb7d1d22bee6162ec43564b769d2a3c" + integrity sha512-GR1TcD6/s7zqItfhC87zAp30PqzvceoeDGYTgF3Vx2TXvsfDrhP6Qw9T4vudDQL3uJRne6t7CzdT29YyVxlgIA== + dependencies: + "@module-federation/error-codes" "0.22.0" + "@module-federation/sdk" "0.22.0" + +"@module-federation/runtime-tools@0.22.0": + version "0.22.0" + resolved "https://registry.yarnpkg.com/@module-federation/runtime-tools/-/runtime-tools-0.22.0.tgz#36f2a7cb267af208a9d1a237fe9a71b4bf31431e" + integrity sha512-4ScUJ/aUfEernb+4PbLdhM/c60VHl698Gn1gY21m9vyC1Ucn69fPCA1y2EwcCB7IItseRMoNhdcWQnzt/OPCNA== + dependencies: + "@module-federation/runtime" "0.22.0" + "@module-federation/webpack-bundler-runtime" "0.22.0" + +"@module-federation/runtime@0.22.0": + version "0.22.0" + resolved "https://registry.yarnpkg.com/@module-federation/runtime/-/runtime-0.22.0.tgz#f789c9ef40d846d110711c8221ecc0ad938d43d8" + integrity sha512-38g5iPju2tPC3KHMPxRKmy4k4onNp6ypFPS1eKGsNLUkXgHsPMBFqAjDw96iEcjri91BrahG4XcdyKi97xZzlA== + dependencies: + "@module-federation/error-codes" "0.22.0" + "@module-federation/runtime-core" "0.22.0" + "@module-federation/sdk" "0.22.0" + +"@module-federation/sdk@0.22.0": + version "0.22.0" + resolved "https://registry.yarnpkg.com/@module-federation/sdk/-/sdk-0.22.0.tgz#6ad4c1de85a900c3c80ff26cb87cce253e3a2770" + integrity sha512-x4aFNBKn2KVQRuNVC5A7SnrSCSqyfIWmm1DvubjbO9iKFe7ith5niw8dqSFBekYBg2Fwy+eMg4sEFNVvCAdo6g== + +"@module-federation/webpack-bundler-runtime@0.22.0": + version "0.22.0" + resolved "https://registry.yarnpkg.com/@module-federation/webpack-bundler-runtime/-/webpack-bundler-runtime-0.22.0.tgz#dcbe8f972d722fe278e6a7c21988d4bee53d401d" + integrity sha512-aM8gCqXu+/4wBmJtVeMeeMN5guw3chf+2i6HajKtQv7SJfxV/f4IyNQJUeUQu9HfiAZHjqtMV5Lvq/Lvh8LdyA== + dependencies: + "@module-federation/runtime" "0.22.0" + "@module-federation/sdk" "0.22.0" + "@mui/core-downloads-tracker@^7.3.2": version "7.3.2" resolved "https://registry.yarnpkg.com/@mui/core-downloads-tracker/-/core-downloads-tracker-7.3.2.tgz#896a7890864d619093dc79541ec1ecfa3b507ad2" @@ -2230,6 +2483,20 @@ prop-types "^15.8.1" react-is "^19.1.1" +"@napi-rs/wasm-runtime@1.0.7": + version "1.0.7" + resolved "https://registry.yarnpkg.com/@napi-rs/wasm-runtime/-/wasm-runtime-1.0.7.tgz#dcfea99a75f06209a235f3d941e3460a51e9b14c" + integrity sha512-SeDnOO0Tk7Okiq6DbXmmBODgOAb9dp9gjlphokTUxmt8U3liIP1ZsozBahH69j/RJv+Rfs6IwUKHTgQYJ/HBAw== + dependencies: + "@emnapi/core" "^1.5.0" + "@emnapi/runtime" "^1.5.0" + "@tybys/wasm-util" "^0.10.1" + +"@noble/hashes@1.4.0": + version "1.4.0" + resolved "https://registry.yarnpkg.com/@noble/hashes/-/hashes-1.4.0.tgz#45814aa329f30e4fe0ba49426f49dfccdd066426" + integrity sha512-V1JJ1WTRUqHHrOSh597hURcMqVKVGL/ea3kv0gSnEdsEZ0/+VyPghM1lMNGc00z7CIQorSvbKpuJkxvuHbvdbg== + "@nodelib/fs.scandir@2.1.5": version "2.1.5" resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5" @@ -2251,6 +2518,136 @@ "@nodelib/fs.scandir" "2.1.5" fastq "^1.6.0" +"@peculiar/asn1-cms@^2.6.0", "@peculiar/asn1-cms@^2.7.0": + version "2.7.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-cms/-/asn1-cms-2.7.0.tgz#8e0eb656f4fc85f7c621dd442fa2d298faa84984" + integrity sha512-hew63shtzzvBcSHbhm+cyAmKe6AIfinT9hzEqSPjDC6opTTMKmTkQ0gHuN2KsWlvqiKw1S/fS94fhag/FJkioQ== + dependencies: + "@peculiar/asn1-schema" "^2.7.0" + "@peculiar/asn1-x509" "^2.7.0" + "@peculiar/asn1-x509-attr" "^2.7.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-csr@^2.6.0": + version "2.7.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-csr/-/asn1-csr-2.7.0.tgz#1a03ac03f7571ea981f5d8377c6f4510c5d43411" + integrity sha512-VVsAyGqErT9D1SY4aEqozThXMVI+ssVRiv2DDeYuvpBKLIgZ3hYs3Ay3u/VSoKq6ESFi9cf6rf3IOOzfwh7oMA== + dependencies: + "@peculiar/asn1-schema" "^2.7.0" + "@peculiar/asn1-x509" "^2.7.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-ecc@^2.6.0": + version "2.7.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-ecc/-/asn1-ecc-2.7.0.tgz#c35b57859812ecd0c2ae7b2144855e8208c2cfee" + integrity sha512-n7KEs/Q/wrB415cxy4fHOBhegp4NdJ15fkJPwcB/3/8iNBQC2L/N7SChJPKDJPZGYH0jD4Tg4/0vnHmwghnbKw== + dependencies: + "@peculiar/asn1-schema" "^2.7.0" + "@peculiar/asn1-x509" "^2.7.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-pfx@^2.7.0": + version "2.7.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-pfx/-/asn1-pfx-2.7.0.tgz#d00766b13ff49785684a604248e6aadd184b291f" + integrity sha512-V/nrlQVmhg7lYAsM7E13UDL5erAwFv6kCIVFqNaMIHSVi7dngcT839JkRTkQBqznMG98l2XjxYk74ZztAohZzA== + dependencies: + "@peculiar/asn1-cms" "^2.7.0" + "@peculiar/asn1-pkcs8" "^2.7.0" + "@peculiar/asn1-rsa" "^2.7.0" + "@peculiar/asn1-schema" "^2.7.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-pkcs8@^2.7.0": + version "2.7.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-pkcs8/-/asn1-pkcs8-2.7.0.tgz#5ee602d8a9a3e0a3f09f7b008ff644a657378692" + integrity sha512-9GTl1nE8Mx1kTZ+7QyYatDyKsm34QcWRBFkY1iPvWC3X4Dona5s/tlLiQsx5WzVdZqiMBZNYT0buyw4/vbhnjw== + dependencies: + "@peculiar/asn1-schema" "^2.7.0" + "@peculiar/asn1-x509" "^2.7.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-pkcs9@^2.6.0": + version "2.7.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-pkcs9/-/asn1-pkcs9-2.7.0.tgz#23b4eae41c2feb8df258aa69c502a70092026b0a" + integrity sha512-Bh7m+OuIaSEllPQcSd9OSp93F4ROWH7sbITWV8MI+8dwsjE5111/87VxiWVvYFKyww3vp39geLv9ENqhwWHcew== + dependencies: + "@peculiar/asn1-cms" "^2.7.0" + "@peculiar/asn1-pfx" "^2.7.0" + "@peculiar/asn1-pkcs8" "^2.7.0" + "@peculiar/asn1-schema" "^2.7.0" + "@peculiar/asn1-x509" "^2.7.0" + "@peculiar/asn1-x509-attr" "^2.7.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-rsa@^2.6.0", "@peculiar/asn1-rsa@^2.7.0": + version "2.7.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-rsa/-/asn1-rsa-2.7.0.tgz#6dc5c78c643264dd5a251a66f1dd9a38fcbba385" + integrity sha512-/qvENQrXyTZURjMqSeofHul0JJt2sNSzSwk36pl2olkHbaioMQgrASDZAlHXl0xUlnVbHj0uGgOrBMTb5x2aJQ== + dependencies: + "@peculiar/asn1-schema" "^2.7.0" + "@peculiar/asn1-x509" "^2.7.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-schema@^2.6.0", "@peculiar/asn1-schema@^2.7.0": + version "2.7.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-schema/-/asn1-schema-2.7.0.tgz#f2dcb25995ce7cac8687ba1039f043e5eff43820" + integrity sha512-W8ZfWzLmQnrcky+eh3tni4IozMdqBDiHWU0N+vve/UGjMaUs8c0L7A2oEdkBXS8rTpWDpK/aoI3DG/L/hxmxPg== + dependencies: + "@peculiar/utils" "^2.0.2" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-x509-attr@^2.7.0": + version "2.7.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-x509-attr/-/asn1-x509-attr-2.7.0.tgz#5ef2a10d3a78d4763b848a2cb56db4bb6b1e082a" + integrity sha512-NS8e7SOgXipkzUPLF/sce7ukpMpWjhxYsH0n6Y+bHYo4TTxOb95Zv7hqwSuL212mj5YxovjdOKQOgH1As3E94w== + dependencies: + "@peculiar/asn1-schema" "^2.7.0" + "@peculiar/asn1-x509" "^2.7.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-x509@^2.6.0", "@peculiar/asn1-x509@^2.7.0": + version "2.7.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-x509/-/asn1-x509-2.7.0.tgz#84793efb7819dbc9526fd6b0a4ccd86f90464b96" + integrity sha512-mUn9RRrkGDnG4ALfunDmzyRW5dg+sWCj/pfnCCqEHYbkGxEpvUt6iVJv8Yw1cyp6SWZ26ZE5oSmI5SqEaen15g== + dependencies: + "@peculiar/asn1-schema" "^2.7.0" + "@peculiar/utils" "^2.0.2" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/utils@^2.0.2": + version "2.0.3" + resolved "https://registry.yarnpkg.com/@peculiar/utils/-/utils-2.0.3.tgz#a27ca4c4b73652e110f19a7d16d664f458a5528e" + integrity sha512-+oL3HPFRIZ1St2K50lWCXiioIgSoxzz7R1J3uF6neO2yl1sgmpgY6XXJH4BdpoDkMWznQTeYF6oWNDZLCdQ4eQ== + dependencies: + tslib "^2.8.1" + +"@peculiar/x509@^1.14.2": + version "1.14.3" + resolved "https://registry.yarnpkg.com/@peculiar/x509/-/x509-1.14.3.tgz#2c44c2b89474346afec38a0c2803ec4fb8ce959e" + integrity sha512-C2Xj8FZ0uHWeCXXqX5B4/gVFQmtSkiuOolzAgutjTfseNOHT3pUjljDZsTSxXFGgio54bCzVFqmEOUrIVk8RDA== + dependencies: + "@peculiar/asn1-cms" "^2.6.0" + "@peculiar/asn1-csr" "^2.6.0" + "@peculiar/asn1-ecc" "^2.6.0" + "@peculiar/asn1-pkcs9" "^2.6.0" + "@peculiar/asn1-rsa" "^2.6.0" + "@peculiar/asn1-schema" "^2.6.0" + "@peculiar/asn1-x509" "^2.6.0" + pvtsutils "^1.3.6" + reflect-metadata "^0.2.2" + tslib "^2.8.1" + tsyringe "^4.10.0" + "@pnpm/config.env-replace@^1.1.0": version "1.1.0" resolved "https://registry.yarnpkg.com/@pnpm/config.env-replace/-/config.env-replace-1.1.0.tgz#ab29da53df41e8948a00f2433f085f54de8b3a4c" @@ -2282,6 +2679,88 @@ resolved "https://registry.yarnpkg.com/@popperjs/core/-/core-2.11.8.tgz#6b79032e760a0899cd4204710beede972a3a185f" integrity sha512-P1st0aksCrn9sGZhp8GMYwBnQsbvAWsZAX44oXNNvLHGqAOcoVxmjZiohstwQ7SqKnbR47akdNi+uleWD8+g6A== +"@rspack/binding-darwin-arm64@1.7.11": + version "1.7.11" + resolved "https://registry.yarnpkg.com/@rspack/binding-darwin-arm64/-/binding-darwin-arm64-1.7.11.tgz#ea43ac25a9ff99a9faf6c820f5d174a32974e95c" + integrity sha512-oduECiZVqbO5zlVw+q7Vy65sJFth99fWPTyucwvLJJtJkPL5n17Uiql2cYP6Ijn0pkqtf1SXgK8WjiKLG5bIig== + +"@rspack/binding-darwin-x64@1.7.11": + version "1.7.11" + resolved "https://registry.yarnpkg.com/@rspack/binding-darwin-x64/-/binding-darwin-x64-1.7.11.tgz#5c724d91559d642d4a5e6aa4ed380c30bd0f64c0" + integrity sha512-a1+TtTE9ap6RalgFi7FGIgkJP6O4Vy6ctv+9WGJy53E4kuqHR0RygzaiVxCI/GMc/vBT9vY23hyrpWb3d1vtXA== + +"@rspack/binding-linux-arm64-gnu@1.7.11": + version "1.7.11" + resolved "https://registry.yarnpkg.com/@rspack/binding-linux-arm64-gnu/-/binding-linux-arm64-gnu-1.7.11.tgz#429119939bbe9d51a72caf99cffb8febe0f870fe" + integrity sha512-P0QrGRPbTWu6RKWfN0bDtbnEps3rXH0MWIMreZABoUrVmNQKtXR6e73J3ub6a+di5s2+K0M2LJ9Bh2/H4UsDUA== + +"@rspack/binding-linux-arm64-musl@1.7.11": + version "1.7.11" + resolved "https://registry.yarnpkg.com/@rspack/binding-linux-arm64-musl/-/binding-linux-arm64-musl-1.7.11.tgz#d939b8c2c5bf35380d3c860402f7063031ef469a" + integrity sha512-6ky7R43VMjWwmx3Yx7Jl7faLBBMAgMDt+/bN35RgwjiPgsIByz65EwytUVuW9rikB43BGHvA/eqlnjLrUzNBqw== + +"@rspack/binding-linux-x64-gnu@1.7.11": + version "1.7.11" + resolved "https://registry.yarnpkg.com/@rspack/binding-linux-x64-gnu/-/binding-linux-x64-gnu-1.7.11.tgz#03567317a7e8cfc62d994dcf9683f932fd22054a" + integrity sha512-cuOJMfCOvb2Wgsry5enXJ3iT1FGUjdPqtGUBVupQlEG4ntSYsQ2PtF4wIDVasR3wdxC5nQbipOrDiN/u6fYsdQ== + +"@rspack/binding-linux-x64-musl@1.7.11": + version "1.7.11" + resolved "https://registry.yarnpkg.com/@rspack/binding-linux-x64-musl/-/binding-linux-x64-musl-1.7.11.tgz#d93c93ea796eae1572b2353a50d58cc6218c53b6" + integrity sha512-CoK37hva4AmHGh3VCsQXmGr40L36m1/AdnN5LEjUX6kx5rEH7/1nEBN6Ii72pejqDVvk9anEROmPDiPw10tpFg== + +"@rspack/binding-wasm32-wasi@1.7.11": + version "1.7.11" + resolved "https://registry.yarnpkg.com/@rspack/binding-wasm32-wasi/-/binding-wasm32-wasi-1.7.11.tgz#c90235032fb14de50baf535592069923c1308f4e" + integrity sha512-OtrmnPUVJMxjNa3eDMfHyPdtlLRmmp/aIm0fQHlAOATbZvlGm12q7rhPW5BXTu1yh+1rQ1/uqvz+SzKEZXuJaQ== + dependencies: + "@napi-rs/wasm-runtime" "1.0.7" + +"@rspack/binding-win32-arm64-msvc@1.7.11": + version "1.7.11" + resolved "https://registry.yarnpkg.com/@rspack/binding-win32-arm64-msvc/-/binding-win32-arm64-msvc-1.7.11.tgz#0afcfde6a77cdf6fa6a85de4f8a39b94a593aab2" + integrity sha512-lObFW6e5lCWNgTBNwT//yiEDbsxm9QG4BYUojqeXxothuzJ/L6ibXz6+gLMvbOvLGV3nKgkXmx8GvT9WDKR0mA== + +"@rspack/binding-win32-ia32-msvc@1.7.11": + version "1.7.11" + resolved "https://registry.yarnpkg.com/@rspack/binding-win32-ia32-msvc/-/binding-win32-ia32-msvc-1.7.11.tgz#46606834538e84cd0f95f19089695ab122d69586" + integrity sha512-0pYGnZd8PPqNR68zQ8skamqNAXEA1sUfXuAdYcknIIRq2wsbiwFzIc0Pov1cIfHYab37G7sSIPBiOUdOWF5Ivw== + +"@rspack/binding-win32-x64-msvc@1.7.11": + version "1.7.11" + resolved "https://registry.yarnpkg.com/@rspack/binding-win32-x64-msvc/-/binding-win32-x64-msvc-1.7.11.tgz#e486a33fc1227ec9cbd70439ef1b32ead1faec68" + integrity sha512-EeQXayoQk/uBkI3pdoXfQBXNIUrADq56L3s/DFyM2pJeUDrWmhfIw2UFIGkYPTMSCo8F2JcdcGM32FGJrSnU0Q== + +"@rspack/binding@1.7.11": + version "1.7.11" + resolved "https://registry.yarnpkg.com/@rspack/binding/-/binding-1.7.11.tgz#30f3e87242d9dcb3744edc22752cf24a9ceb4d61" + integrity sha512-2MGdy2s2HimsDT444Bp5XnALzNRxuBNc7y0JzyuqKbHBywd4x2NeXyhWXXoxufaCFu5PBc9Qq9jyfjW2Aeh06Q== + optionalDependencies: + "@rspack/binding-darwin-arm64" "1.7.11" + "@rspack/binding-darwin-x64" "1.7.11" + "@rspack/binding-linux-arm64-gnu" "1.7.11" + "@rspack/binding-linux-arm64-musl" "1.7.11" + "@rspack/binding-linux-x64-gnu" "1.7.11" + "@rspack/binding-linux-x64-musl" "1.7.11" + "@rspack/binding-wasm32-wasi" "1.7.11" + "@rspack/binding-win32-arm64-msvc" "1.7.11" + "@rspack/binding-win32-ia32-msvc" "1.7.11" + "@rspack/binding-win32-x64-msvc" "1.7.11" + +"@rspack/core@^1.7.10": + version "1.7.11" + resolved "https://registry.yarnpkg.com/@rspack/core/-/core-1.7.11.tgz#8d7d77db3b71332afd22a9c90904fe18a6832e2c" + integrity sha512-rsD9b+Khmot5DwCMiB3cqTQo53ioPG3M/A7BySu8+0+RS7GCxKm+Z+mtsjtG/vsu4Tn2tcqCdZtA3pgLoJB+ew== + dependencies: + "@module-federation/runtime-tools" "0.22.0" + "@rspack/binding" "1.7.11" + "@rspack/lite-tapable" "1.1.0" + +"@rspack/lite-tapable@1.1.0": + version "1.1.0" + resolved "https://registry.yarnpkg.com/@rspack/lite-tapable/-/lite-tapable-1.1.0.tgz#3cfdafeed01078e116bd4f191b684c8b484de425" + integrity sha512-E2B0JhYFmVAwdDiG14+DW0Di4Ze4Jg10Pc4/lILUrd5DRCaklduz2OvJ5HYQ6G+hd+WTzqQb3QnDNfK4yvAFYw== + "@sideway/address@^4.1.5": version "4.1.5" resolved "https://registry.yarnpkg.com/@sideway/address/-/address-4.1.5.tgz#4bc149a0076623ced99ca8208ba780d65a99b9d5" @@ -2429,6 +2908,179 @@ "@svgr/plugin-jsx" "8.1.0" "@svgr/plugin-svgo" "8.1.0" +"@swc/core-darwin-arm64@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/core-darwin-arm64/-/core-darwin-arm64-1.15.33.tgz#d84134fb80417d41128739f0b9014542e3ed9dd3" + integrity sha512-N+L0uXhuO7FIfzqwgxmzv0zIpV0qEp8wPX3QQs2p4atjMoywup2JTeDlXPw+z9pWJGCae3JjM+tZ6myclI+2gA== + +"@swc/core-darwin-x64@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/core-darwin-x64/-/core-darwin-x64-1.15.33.tgz#0badb9834071f1c6005986571d4a96359c1d7cd0" + integrity sha512-/Il4QHSOhV4FekbsDtkrNmKbsX26oSysvgrRswa/RYOHXAkwXDbB4jaeKq6PsJLSPkzJ2KzQ061gtBnk0vNHfA== + +"@swc/core-linux-arm-gnueabihf@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/core-linux-arm-gnueabihf/-/core-linux-arm-gnueabihf-1.15.33.tgz#b7577a825b59d98b6a9a5c991d842046efe1c34a" + integrity sha512-C64hBnBxq4viOPQ8hlx+2lJ23bzZBGnjw7ryALmS+0Q3zHmwO8lw1/DArLENw4Q18/0w5wdEO1k3m1wWNtKGqQ== + +"@swc/core-linux-arm64-gnu@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/core-linux-arm64-gnu/-/core-linux-arm64-gnu-1.15.33.tgz#304c48321494a18c67b2913c273b08674ee70d8c" + integrity sha512-TRJfnJbX3jqpxRDRoieMzRiCBS5jOmXNb3iQXmcgjFEHKLnAgK1RZRU8Cq1MsPqO4jAJp/ld1G4O3fXuxv85uw== + +"@swc/core-linux-arm64-musl@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/core-linux-arm64-musl/-/core-linux-arm64-musl-1.15.33.tgz#d116cbc04ccb4f4ee810da6bca79d4423605dbcd" + integrity sha512-il7tYM+CpUNzieQbwAjFT1P8zqAhmGWNAGhQZBnxurXZ0aNn+5nqYFTEUKNZl7QibtT0uQXzTZrNGHCIj6Y1Og== + +"@swc/core-linux-ppc64-gnu@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/core-linux-ppc64-gnu/-/core-linux-ppc64-gnu-1.15.33.tgz#f5354dba36db9414305bab344c817d57b8b457c2" + integrity sha512-ZtNBwN0Z7CFj9Il0FcPaKdjgP7URyKu/3RfH46vq+0paOBqLj4NYldD6Qo//Duif/7IOtAraUfDOmp0PLAufog== + +"@swc/core-linux-s390x-gnu@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/core-linux-s390x-gnu/-/core-linux-s390x-gnu-1.15.33.tgz#016df9f4c9d7fd65b85ca9c558c5aec341f06da0" + integrity sha512-De1IyajoOmhOYYjw/lx66bKlyDpHZTueqwpDrWgf5O7T6d1ODeJJO9/OqMBmrBQc5C+dNnlmIufHsp4QVCWufA== + +"@swc/core-linux-x64-gnu@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/core-linux-x64-gnu/-/core-linux-x64-gnu-1.15.33.tgz#49f36558ede072e71999aa37f123367daed2a662" + integrity sha512-mGTH0YxmUN+x6vRN/I6NOk5X0ogNktkwPnJ94IMvR7QjhRDwL0O8RXEDhyUM0YtwWrryBOqaJQBX4zruxEPRGw== + +"@swc/core-linux-x64-musl@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/core-linux-x64-musl/-/core-linux-x64-musl-1.15.33.tgz#b096665f5cfeee2612325f301da5c1590b10d8f3" + integrity sha512-hj628ZkSEJf6zMf5VMbYrG2O6QqyTIp2qwY6VlCjvIa9lAEZ5c2lfPblCLVGYubTeLJDxadLB/CxqQYOQABeEQ== + +"@swc/core-win32-arm64-msvc@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/core-win32-arm64-msvc/-/core-win32-arm64-msvc-1.15.33.tgz#f3101263a0dbaa173ec47638c9719d0b89838bd2" + integrity sha512-GV2oohtN2/5+KSccl86VULu3aT+LrISC8uzgSq0FRnikpD+Zwc+sBlXmoKQ+Db6jI57ITUOIB8jRkdGMABC29g== + +"@swc/core-win32-ia32-msvc@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/core-win32-ia32-msvc/-/core-win32-ia32-msvc-1.15.33.tgz#eb981ef5613d42c9220559bdb0c8bc58cf6c3eb9" + integrity sha512-gtyvzSNR8DHKfFEA2uqb8Ld1myqi6uEg2jyeUq3ikn5ytYs7H8RpZYC8mdy4NXr8hfcdJfCLXPlYaqqfBXpoEQ== + +"@swc/core-win32-x64-msvc@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/core-win32-x64-msvc/-/core-win32-x64-msvc-1.15.33.tgz#a2fed9956933027ceb368857bac4bb4ee203d47c" + integrity sha512-d6fRqQSkJI+kmMEBWaDQ7TMl8+YjLYbwRUPZQ9DY0ORBJeTzOrG0twvfvlZ2xgw6jA0ScQKgfBm4vHLSLl5Hqg== + +"@swc/core@^1.7.39": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/core/-/core-1.15.33.tgz#2a6571c8aca961925f14beae52b3f43c18370fc6" + integrity sha512-jOlwnFV2xhuuZeAUILGFULeR6vDPfijEJ57evfocwznQldLU3w2cZ9bSDryY9ip+AsM3r1NJKzf47V2NXebkeQ== + dependencies: + "@swc/counter" "^0.1.3" + "@swc/types" "^0.1.26" + optionalDependencies: + "@swc/core-darwin-arm64" "1.15.33" + "@swc/core-darwin-x64" "1.15.33" + "@swc/core-linux-arm-gnueabihf" "1.15.33" + "@swc/core-linux-arm64-gnu" "1.15.33" + "@swc/core-linux-arm64-musl" "1.15.33" + "@swc/core-linux-ppc64-gnu" "1.15.33" + "@swc/core-linux-s390x-gnu" "1.15.33" + "@swc/core-linux-x64-gnu" "1.15.33" + "@swc/core-linux-x64-musl" "1.15.33" + "@swc/core-win32-arm64-msvc" "1.15.33" + "@swc/core-win32-ia32-msvc" "1.15.33" + "@swc/core-win32-x64-msvc" "1.15.33" + +"@swc/counter@^0.1.3": + version "0.1.3" + resolved "https://registry.yarnpkg.com/@swc/counter/-/counter-0.1.3.tgz#cc7463bd02949611c6329596fccd2b0ec782b0e9" + integrity sha512-e2BR4lsJkkRlKZ/qCHPw9ZaSxc0MVUd7gtbtaB7aMvHeJVYe8sOB8DBZkP2DtISHGSku9sCK6T6cnY0CtXrOCQ== + +"@swc/html-darwin-arm64@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/html-darwin-arm64/-/html-darwin-arm64-1.15.33.tgz#f5f8432988460eb1dd06dd45eabec1d6fc460873" + integrity sha512-zyO6uMBfLyCh55wundAxKX+8P/f98ecuyir4VX6nTmn6y7x37ndB8f01LUrd9Tiq6eEAvDXLiqEUvuGjEc7Pmg== + +"@swc/html-darwin-x64@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/html-darwin-x64/-/html-darwin-x64-1.15.33.tgz#a5fe565500a77b5dce30d35dd7473fe72a459c40" + integrity sha512-MaGunsY/J5l7Rb5OmoztEWh+ikooydT7nWkjiDovj7UfkB9HLk5sLr9O7ZdNGJ2u9dD6FX89SzMdA0Psm9NJrQ== + +"@swc/html-linux-arm-gnueabihf@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/html-linux-arm-gnueabihf/-/html-linux-arm-gnueabihf-1.15.33.tgz#600f84c0c15bb79466fa1fbed403606b1046812e" + integrity sha512-CrbUDjVl6/hQ1C5KPMiK4vxk/eOMjxkVELqwnOxsZ+aFVTv3L3YrGMaJ5H47vvIihkPhqiSOUPmMEFqxvqKmXg== + +"@swc/html-linux-arm64-gnu@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/html-linux-arm64-gnu/-/html-linux-arm64-gnu-1.15.33.tgz#281a2511fd2942a4abe79a82f846fb622f5f7add" + integrity sha512-7tZ0IgmUslI9Extu/TpxJS0GjJoDx0j9zeq2cIidPdM/njSBpyRB7n4B292Q5WFVh7PcZl7WXqqqMczibQ27aA== + +"@swc/html-linux-arm64-musl@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/html-linux-arm64-musl/-/html-linux-arm64-musl-1.15.33.tgz#85d6abd6aaf54886a0d7c96f5d6b947c7ac55698" + integrity sha512-gYi2ainYZV2z+jwjp9UKuPVOf3c5q+NkH3QRDjqDrIPLagqDsYNjobi8p5oajGcPGFLNTcVw08VTcubJGChReA== + +"@swc/html-linux-ppc64-gnu@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/html-linux-ppc64-gnu/-/html-linux-ppc64-gnu-1.15.33.tgz#fcbe4c28ae85117663dea8d6c3c2a6cadda17ae4" + integrity sha512-6CfzyVQSdD8ezFdxFve4J/b6qTgXIwYFWEvSdaJvXSgwTy976uUV5Ff1LOF86mt2zWMhZJX9DqmkGyIhepbyWw== + +"@swc/html-linux-s390x-gnu@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/html-linux-s390x-gnu/-/html-linux-s390x-gnu-1.15.33.tgz#aa0202bbafff1f92c08c8ff4ad73acab0996d3fe" + integrity sha512-Msx1eniw95lhMHUSe3D5FXweKHtkHtzJLsHJDj920uL4Dm7UHqzwaCuZdCmzbkHnO96YjjQvAm266djg8wupmQ== + +"@swc/html-linux-x64-gnu@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/html-linux-x64-gnu/-/html-linux-x64-gnu-1.15.33.tgz#d67fe9e576aa7e86ca48a1a916ba28a8f6143702" + integrity sha512-JDNb4Uq+7g+23QuOtwWnP0/EqztWIHFFdQdeBIS5zx83YBG2dYRMdPAjnHJWh2YRZxdepd8q6S9MUIxpSrouAg== + +"@swc/html-linux-x64-musl@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/html-linux-x64-musl/-/html-linux-x64-musl-1.15.33.tgz#ba22ea26670bc6f63f1c8f31e9b2f1e70dbe5404" + integrity sha512-NSpZdbz4dj0pu1A0Z9l68Bll5HAzEMtBAeMe6jc4GEVfpIw6eeafQHm2/yMUEh09tgl8t9LzM9DycfdTZDjM4g== + +"@swc/html-win32-arm64-msvc@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/html-win32-arm64-msvc/-/html-win32-arm64-msvc-1.15.33.tgz#5fdbe3e27d5a49f98b0d877701728c237efc90de" + integrity sha512-w7iho3/zS3lCDqgUZMDLMBO0ElX7j+KgvMb8BOrKqLDOSTDDj3lY/BClNJ7vBpAliI2kPQs/mUikdZyzi4MBjQ== + +"@swc/html-win32-ia32-msvc@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/html-win32-ia32-msvc/-/html-win32-ia32-msvc-1.15.33.tgz#32a9f7fc740722fb3852044cad04e9ec0241fd4e" + integrity sha512-6hJ2pBweSfZ38trYHXmzTBDpRNvqJgFl2PkIWdy4IXbV/Fv0v9Dqe0t9Gi2ZVEBpgI7PD6pF42AT4HmrNTVFyQ== + +"@swc/html-win32-x64-msvc@1.15.33": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/html-win32-x64-msvc/-/html-win32-x64-msvc-1.15.33.tgz#36f063f02018a64b417dad020c15232a8ffaab6c" + integrity sha512-eaY/vNE7rkPKluJYjhOiQOA1tto5VbJOoD1C1xFTBmr9t7WsqYUfbQhYQy5A26/z83NNgtDwELM85rkMB+/vWA== + +"@swc/html@^1.13.5": + version "1.15.33" + resolved "https://registry.yarnpkg.com/@swc/html/-/html-1.15.33.tgz#4578fda4fed3b7563d0f738998cda36ad6b99be0" + integrity sha512-PZIfmj5zYpAJ2eMptf0My2q9Bl8bkraW28+FD1pRnxOiYMrKrP5vL2tB2PdxMRjS0ziLFVM5HEuGFw8PxEDOaw== + dependencies: + "@swc/counter" "^0.1.3" + optionalDependencies: + "@swc/html-darwin-arm64" "1.15.33" + "@swc/html-darwin-x64" "1.15.33" + "@swc/html-linux-arm-gnueabihf" "1.15.33" + "@swc/html-linux-arm64-gnu" "1.15.33" + "@swc/html-linux-arm64-musl" "1.15.33" + "@swc/html-linux-ppc64-gnu" "1.15.33" + "@swc/html-linux-s390x-gnu" "1.15.33" + "@swc/html-linux-x64-gnu" "1.15.33" + "@swc/html-linux-x64-musl" "1.15.33" + "@swc/html-win32-arm64-msvc" "1.15.33" + "@swc/html-win32-ia32-msvc" "1.15.33" + "@swc/html-win32-x64-msvc" "1.15.33" + +"@swc/types@^0.1.26": + version "0.1.26" + resolved "https://registry.yarnpkg.com/@swc/types/-/types-0.1.26.tgz#2a976a1870caef1992316dda1464150ee36968b5" + integrity sha512-lyMwd7WGgG79RS7EERZV3T8wMdmPq3xwyg+1nmAM64kIhx5yl+juO2PYIHb7vTiPgPCj8LYjsNV2T5wiQHUEaw== + dependencies: + "@swc/counter" "^0.1.3" + "@szmarczak/http-timer@^5.0.1": version "5.0.1" resolved "https://registry.yarnpkg.com/@szmarczak/http-timer/-/http-timer-5.0.1.tgz#c7c1bf1141cdd4751b0399c8fc7b8b664cd5be3a" @@ -2441,6 +3093,13 @@ resolved "https://registry.yarnpkg.com/@trysound/sax/-/sax-0.2.0.tgz#cccaab758af56761eb7bf37af6f03f326dd798ad" integrity sha512-L7z9BgrNEcYyUYtF+HaEfiS5ebkh9jXqbszz7pC0hRBPaatV0XjSD3+eHrpqFemQfgwiFF0QPIarnIihIDn7OA== +"@tybys/wasm-util@^0.10.1": + version "0.10.2" + resolved "https://registry.yarnpkg.com/@tybys/wasm-util/-/wasm-util-0.10.2.tgz#12b3a1b33db1f9cad4ddff1f604ab7dd00bf464e" + integrity sha512-RoBvJ2X0wuKlWFIjrwffGw1IqZHKQqzIchKaadZZfnNpsAYp2mM0h36JtPCjNDAHGgYez/15uMBpfGwchhiMgg== + dependencies: + tslib "^2.4.0" + "@types/body-parser@*": version "1.19.6" resolved "https://registry.yarnpkg.com/@types/body-parser/-/body-parser-1.19.6.tgz#1859bebb8fd7dac9918a45d54c1971ab8b5af474" @@ -2449,14 +3108,14 @@ "@types/connect" "*" "@types/node" "*" -"@types/bonjour@^3.5.9": +"@types/bonjour@^3.5.13": version "3.5.13" resolved "https://registry.yarnpkg.com/@types/bonjour/-/bonjour-3.5.13.tgz#adf90ce1a105e81dd1f9c61fdc5afda1bfb92956" integrity sha512-z9fJ5Im06zvUL548KvYNecEVlA7cVDkGUi6kZusb04mpyEFKCIZJvloCcmpmLaIahDpOQGHaHmG6imtPMmPXGQ== dependencies: "@types/node" "*" -"@types/connect-history-api-fallback@^1.3.5": +"@types/connect-history-api-fallback@^1.5.4": version "1.5.4" resolved "https://registry.yarnpkg.com/@types/connect-history-api-fallback/-/connect-history-api-fallback-1.5.4.tgz#7de71645a103056b48ac3ce07b3520b819c1d5b3" integrity sha512-n6Cr2xS1h4uAulPRdlw6Jl6s1oG8KrVilPN2yUITEs+K48EzMJJ3W1xy8K5eWuFvjp3R74AOIGSmp2UfBJ8HFw== @@ -2516,6 +3175,16 @@ "@types/range-parser" "*" "@types/send" "*" +"@types/express-serve-static-core@^4.17.21": + version "4.19.8" + resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-4.19.8.tgz#99b960322a4d576b239a640ab52ef191989b036f" + integrity sha512-02S5fmqeoKzVZCHPZid4b8JH2eM5HzQLZWN2FohQEy/0eXTq8VXZfSN6Pcr3F6N9R/vNrj7cpgbhjie6m/1tCA== + dependencies: + "@types/node" "*" + "@types/qs" "*" + "@types/range-parser" "*" + "@types/send" "*" + "@types/express-serve-static-core@^4.17.33": version "4.19.6" resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-4.19.6.tgz#e01324c2a024ff367d92c66f48553ced0ab50267" @@ -2535,20 +3204,20 @@ "@types/express-serve-static-core" "^5.0.0" "@types/serve-static" "*" -"@types/express@^4.17.13": - version "4.17.23" - resolved "https://registry.yarnpkg.com/@types/express/-/express-4.17.23.tgz#35af3193c640bfd4d7fe77191cd0ed411a433bef" - integrity sha512-Crp6WY9aTYP3qPi2wGDo9iUe/rceX01UMhnF1jmwDcKCFM6cx7YhGP/Mpr3y9AASpfHixIG0E6azCcL5OcDHsQ== +"@types/express@^4.17.25": + version "4.17.25" + resolved "https://registry.yarnpkg.com/@types/express/-/express-4.17.25.tgz#070c8c73a6fee6936d65c195dbbfb7da5026649b" + integrity sha512-dVd04UKsfpINUnK0yBoYHDF3xu7xVH4BuDotC/xGuycx4CgbP48X/KF/586bcObxT0HENHXEU8Nqtu6NR+eKhw== dependencies: "@types/body-parser" "*" "@types/express-serve-static-core" "^4.17.33" "@types/qs" "*" - "@types/serve-static" "*" + "@types/serve-static" "^1" -"@types/gtag.js@^0.0.12": - version "0.0.12" - resolved "https://registry.yarnpkg.com/@types/gtag.js/-/gtag.js-0.0.12.tgz#095122edca896689bdfcdd73b057e23064d23572" - integrity sha512-YQV9bUsemkzG81Ea295/nF/5GijnD2Af7QhEofh7xu+kvCN6RdodgNwwGWXB5GMI3NoyvQo0odNctoH/qLMIpg== +"@types/gtag.js@^0.0.20": + version "0.0.20" + resolved "https://registry.yarnpkg.com/@types/gtag.js/-/gtag.js-0.0.20.tgz#e47edabb4ed5ecac90a079275958e6c929d7c08a" + integrity sha512-wwAbk3SA2QeU67unN7zPxjEHmPmlXwZXZvQEpbEUQuMCRGgKyE1m6XDuTUA9b6pCGb/GqJmdfMOY5LuDjJSbbg== "@types/hast@^3.0.0": version "3.0.4" @@ -2630,13 +3299,6 @@ resolved "https://registry.yarnpkg.com/@types/ms/-/ms-2.1.0.tgz#052aa67a48eccc4309d7f0191b7e41434b90bb78" integrity sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA== -"@types/node-forge@^1.3.0": - version "1.3.14" - resolved "https://registry.yarnpkg.com/@types/node-forge/-/node-forge-1.3.14.tgz#006c2616ccd65550560c2757d8472eb6d3ecea0b" - integrity sha512-mhVF2BnD4BO+jtOp7z1CdzaK4mbuK0LLQYAvdOLqHTavxFNq4zA1EmYkpnFjP8HOUzedfQkRnp0E2ulSAYSzAw== - dependencies: - "@types/node" "*" - "@types/node@*": version "24.5.2" resolved "https://registry.yarnpkg.com/@types/node/-/node-24.5.2.tgz#52ceb83f50fe0fcfdfbd2a9fab6db2e9e7ef6446" @@ -2712,10 +3374,10 @@ dependencies: csstype "^3.0.2" -"@types/retry@0.12.0": - version "0.12.0" - resolved "https://registry.yarnpkg.com/@types/retry/-/retry-0.12.0.tgz#2b35eccfcee7d38cd72ad99232fbd58bffb3c84d" - integrity sha512-wWKOClTTiizcZhXnPY4wikVAwmdYHp8q6DmC+EJUzAMsycb7HB32Kh9RN4+0gExjmPmZSAQjgURXIGATPegAvA== +"@types/retry@0.12.2": + version "0.12.2" + resolved "https://registry.yarnpkg.com/@types/retry/-/retry-0.12.2.tgz#ed279a64fa438bb69f2480eda44937912bb7480a" + integrity sha512-XISRgDJ2Tc5q4TRqvgJtzsRkFYNJzZrhTdtMoGVBttwzzQJkPnS3WWTFc7kuDRoPtPakl+T+OfdEUjYJj7Jbow== "@types/sax@^1.2.1": version "1.2.7" @@ -2732,14 +3394,22 @@ "@types/mime" "^1" "@types/node" "*" -"@types/serve-index@^1.9.1": +"@types/send@<1": + version "0.17.6" + resolved "https://registry.yarnpkg.com/@types/send/-/send-0.17.6.tgz#aeb5385be62ff58a52cd5459daa509ae91651d25" + integrity sha512-Uqt8rPBE8SY0RK8JB1EzVOIZ32uqy8HwdxCnoCOsYrvnswqmFZ/k+9Ikidlk/ImhsdvBsloHbAlewb2IEBV/Og== + dependencies: + "@types/mime" "^1" + "@types/node" "*" + +"@types/serve-index@^1.9.4": version "1.9.4" resolved "https://registry.yarnpkg.com/@types/serve-index/-/serve-index-1.9.4.tgz#e6ae13d5053cb06ed36392110b4f9a49ac4ec898" integrity sha512-qLpGZ/c2fhSs5gnYsQxtDEq3Oy8SXPClIXkW5ghvAvsNuVSA8k+gCONcUCS/UjLEYvYps+e8uBtfgXgvhwfNug== dependencies: "@types/express" "*" -"@types/serve-static@*", "@types/serve-static@^1.13.10": +"@types/serve-static@*": version "1.15.8" resolved "https://registry.yarnpkg.com/@types/serve-static/-/serve-static-1.15.8.tgz#8180c3fbe4a70e8f00b9f70b9ba7f08f35987877" integrity sha512-roei0UY3LhpOJvjbIP6ZZFngyLKl5dskOtDhxY5THRSpO+ZI+nzJ+m5yUMzGrp89YRa7lvknKkMYjqQFGwA7Sg== @@ -2748,7 +3418,16 @@ "@types/node" "*" "@types/send" "*" -"@types/sockjs@^0.3.33": +"@types/serve-static@^1", "@types/serve-static@^1.15.5": + version "1.15.10" + resolved "https://registry.yarnpkg.com/@types/serve-static/-/serve-static-1.15.10.tgz#768169145a778f8f5dfcb6360aead414a3994fee" + integrity sha512-tRs1dB+g8Itk72rlSI2ZrW6vZg0YrLI81iQSTkMmOqnqCaNr/8Ek4VwWcN5vZgCYWbg/JJSGBlUaYGAOP73qBw== + dependencies: + "@types/http-errors" "*" + "@types/node" "*" + "@types/send" "<1" + +"@types/sockjs@^0.3.36": version "0.3.36" resolved "https://registry.yarnpkg.com/@types/sockjs/-/sockjs-0.3.36.tgz#ce322cf07bcc119d4cbf7f88954f3a3bd0f67535" integrity sha512-MK9V6NzAS1+Ud7JV9lJLFqW85VbC9dq3LmwZCuBe4wBDgKC0Kj/jd8Xl+nSviU+Qc3+m7umHHyHg//2KSa0a0Q== @@ -2765,7 +3444,7 @@ resolved "https://registry.yarnpkg.com/@types/unist/-/unist-2.0.11.tgz#11af57b127e32487774841f7a4e54eab166d03c4" integrity sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA== -"@types/ws@^8.5.5": +"@types/ws@^8.5.10": version "8.18.1" resolved "https://registry.yarnpkg.com/@types/ws/-/ws-8.18.1.tgz#48464e4bf2ddfd17db13d845467f6070ffea4aa9" integrity sha512-ThVF6DCVhA8kUGy+aazFQ4kXQ7E1Ty7A3ypFOe0IcJV8O/M511G99AW24irKrW56Wt44yG9+ij8FaqoBGkuBXg== @@ -3002,32 +3681,32 @@ ajv@^8.0.0, ajv@^8.9.0: json-schema-traverse "^1.0.0" require-from-string "^2.0.2" -algoliasearch-helper@^3.22.6: - version "3.26.0" - resolved "https://registry.yarnpkg.com/algoliasearch-helper/-/algoliasearch-helper-3.26.0.tgz#d6e283396a9fc5bf944f365dc3b712570314363f" - integrity sha512-Rv2x3GXleQ3ygwhkhJubhhYGsICmShLAiqtUuJTUkr9uOCOXyF2E71LVT4XDnVffbknv8XgScP4U0Oxtgm+hIw== +algoliasearch-helper@^3.26.0: + version "3.29.1" + resolved "https://registry.yarnpkg.com/algoliasearch-helper/-/algoliasearch-helper-3.29.1.tgz#4e764351493d461aa825d2a1209403a98e9b2477" + integrity sha512-6ck2YFudF2Pje7szQoPBiRFTGfd+1I+0I/WfLPGn0bj1kvrFoOQmNyedNiDxTk3/r4IfSLDYk+RA4G7u8H6+yA== dependencies: "@algolia/events" "^4.0.1" -algoliasearch@^5.14.2, algoliasearch@^5.17.1: - version "5.37.0" - resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-5.37.0.tgz#73dc4a09654e6e02b529300018d639706b95b47b" - integrity sha512-y7gau/ZOQDqoInTQp0IwTOjkrHc4Aq4R8JgpmCleFwiLl+PbN2DMWoDUWZnrK8AhNJwT++dn28Bt4NZYNLAmuA== - dependencies: - "@algolia/abtesting" "1.3.0" - "@algolia/client-abtesting" "5.37.0" - "@algolia/client-analytics" "5.37.0" - "@algolia/client-common" "5.37.0" - "@algolia/client-insights" "5.37.0" - "@algolia/client-personalization" "5.37.0" - "@algolia/client-query-suggestions" "5.37.0" - "@algolia/client-search" "5.37.0" - "@algolia/ingestion" "1.37.0" - "@algolia/monitoring" "1.37.0" - "@algolia/recommend" "5.37.0" - "@algolia/requester-browser-xhr" "5.37.0" - "@algolia/requester-fetch" "5.37.0" - "@algolia/requester-node-http" "5.37.0" +algoliasearch@^5.37.0: + version "5.52.1" + resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-5.52.1.tgz#4405146139ccbd79ae45a3c61abe047b281107b5" + integrity sha512-fHA8+kXTbjagw3jkLiaS7KKrH8qe2DyOsiUhGlN4cdT77PEsfqXZl7ewDk1hsg+pJnPlnE50XtLxjR91iJOpmg== + dependencies: + "@algolia/abtesting" "1.18.1" + "@algolia/client-abtesting" "5.52.1" + "@algolia/client-analytics" "5.52.1" + "@algolia/client-common" "5.52.1" + "@algolia/client-insights" "5.52.1" + "@algolia/client-personalization" "5.52.1" + "@algolia/client-query-suggestions" "5.52.1" + "@algolia/client-search" "5.52.1" + "@algolia/ingestion" "1.52.1" + "@algolia/monitoring" "1.52.1" + "@algolia/recommend" "5.52.1" + "@algolia/requester-browser-xhr" "5.52.1" + "@algolia/requester-fetch" "5.52.1" + "@algolia/requester-node-http" "5.52.1" ansi-align@^3.0.1: version "3.0.1" @@ -3036,13 +3715,6 @@ ansi-align@^3.0.1: dependencies: string-width "^4.1.0" -ansi-escapes@^4.3.2: - version "4.3.2" - resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-4.3.2.tgz#6b2291d1db7d98b6521d5f1efa42d0f3a9feb65e" - integrity sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ== - dependencies: - type-fest "^0.21.3" - ansi-html-community@^0.0.8: version "0.0.8" resolved "https://registry.yarnpkg.com/ansi-html-community/-/ansi-html-community-0.0.8.tgz#69fbc4d6ccbe383f9736934ae34c3f8290f1bf41" @@ -3058,7 +3730,7 @@ ansi-regex@^6.0.1: resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.2.2.tgz#60216eea464d864597ce2832000738a0589650c1" integrity sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg== -ansi-styles@^4.0.0, ansi-styles@^4.1.0: +ansi-styles@^4.1.0: version "4.3.0" resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-4.3.0.tgz#edd803628ae71c04c85ae7a0906edad34b648937" integrity sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg== @@ -3070,6 +3742,11 @@ ansi-styles@^6.1.0: resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-6.2.3.tgz#c044d5dcc521a076413472597a1acb1f103c4041" integrity sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg== +ansis@^3.2.0: + version "3.17.0" + resolved "https://registry.yarnpkg.com/ansis/-/ansis-3.17.0.tgz#fa8d9c2a93fe7d1177e0c17f9eeb562a58a832d7" + integrity sha512-0qWUglt9JEqLFr3w1I1pbrChn1grhaiAR2ocX1PP/flRmxgtwTzPFFFnfIlD6aMOLQZgSuCRlidD70lvx8yhzg== + anymatch@~3.1.2: version "3.1.3" resolved "https://registry.yarnpkg.com/anymatch/-/anymatch-3.1.3.tgz#790c58b19ba1720a84205b57c618d5ad8524973e" @@ -3105,6 +3782,15 @@ array-union@^2.1.0: resolved "https://registry.yarnpkg.com/array-union/-/array-union-2.1.0.tgz#b798420adbeb1de828d84acd8a2e23d3efe85e8d" integrity sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw== +asn1js@^3.0.6: + version "3.0.10" + resolved "https://registry.yarnpkg.com/asn1js/-/asn1js-3.0.10.tgz#df26c874c8a8b41ca605efea47b2ad07551013dd" + integrity sha512-S2s3aOytiKdFRdulw2qPE51MzjzVOisppcVv7jVFR+Kw0kxwvFrDcYA0h7Ndqbmj0HkMIXYWaoj7fli8kgx1eg== + dependencies: + pvtsutils "^1.3.6" + pvutils "^1.1.5" + tslib "^2.8.1" + astring@^1.8.0: version "1.9.0" resolved "https://registry.yarnpkg.com/astring/-/astring-1.9.0.tgz#cc73e6062a7eb03e7d19c22d8b0b3451fd9bfeef" @@ -3180,6 +3866,11 @@ balanced-match@^1.0.0: resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== +baseline-browser-mapping@^2.10.12, baseline-browser-mapping@^2.10.27: + version "2.10.27" + resolved "https://registry.yarnpkg.com/baseline-browser-mapping/-/baseline-browser-mapping-2.10.27.tgz#fee941c2a0b42cdf83c6427e4c830b1d0bdab2c3" + integrity sha512-zEs/ufmZoUd7WftKpKyXaT6RFxpQ5Qm9xytKRHvJfxFV9DFJkZph9RvJ1LcOUi0Z1ZVijMte65JbILeV+8QQEA== + baseline-browser-mapping@^2.8.3: version "2.8.5" resolved "https://registry.yarnpkg.com/baseline-browser-mapping/-/baseline-browser-mapping-2.8.5.tgz#3147fe6b01a0c49ce1952daebcfc2057fc43fedb" @@ -3200,25 +3891,25 @@ binary-extensions@^2.0.0: resolved "https://registry.yarnpkg.com/binary-extensions/-/binary-extensions-2.3.0.tgz#f6e14a97858d327252200242d4ccfe522c445522" integrity sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw== -body-parser@1.20.3: - version "1.20.3" - resolved "https://registry.yarnpkg.com/body-parser/-/body-parser-1.20.3.tgz#1953431221c6fb5cd63c4b36d53fab0928e548c6" - integrity sha512-7rAxByjUMqQ3/bHJy7D6OGXvx/MMc4IqBn/X0fcM1QUcAItpZrBEYhWGem+tzXH90c+G01ypMcYJBO9Y30203g== +body-parser@~1.20.3: + version "1.20.5" + resolved "https://registry.yarnpkg.com/body-parser/-/body-parser-1.20.5.tgz#303c8c34423d1d6fa799bc764e93c1e4dc6ebf64" + integrity sha512-3grm+/2tUOvu2cjJkvsIxrv/wVpfXQW4PsQHYm7yk4vfpu7Ekl6nEsYBoJUL6qDwZUx8wUhQ8tR2qz+ad9c9OA== dependencies: - bytes "3.1.2" + bytes "~3.1.2" content-type "~1.0.5" debug "2.6.9" depd "2.0.0" - destroy "1.2.0" - http-errors "2.0.0" - iconv-lite "0.4.24" - on-finished "2.4.1" - qs "6.13.0" - raw-body "2.5.2" + destroy "~1.2.0" + http-errors "~2.0.1" + iconv-lite "~0.4.24" + on-finished "~2.4.1" + qs "~6.15.1" + raw-body "~2.5.3" type-is "~1.6.18" - unpipe "1.0.0" + unpipe "~1.0.0" -bonjour-service@^1.0.11: +bonjour-service@^1.2.1: version "1.3.0" resolved "https://registry.yarnpkg.com/bonjour-service/-/bonjour-service-1.3.0.tgz#80d867430b5a0da64e82a8047fc1e355bdb71722" integrity sha512-3YuAUiSkWykd+2Azjgyxei8OWf8thdn8AITIog2M4UICzoqfjlqr64WIjEXZllf/W6vK1goqleSR6brGomxQqA== @@ -3285,21 +3976,44 @@ browserslist@^4.0.0, browserslist@^4.23.0, browserslist@^4.24.0, browserslist@^4 node-releases "^2.0.21" update-browserslist-db "^1.1.3" +browserslist@^4.24.2: + version "4.28.2" + resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.28.2.tgz#f50b65362ef48974ca9f50b3680566d786b811d2" + integrity sha512-48xSriZYYg+8qXna9kwqjIVzuQxi+KYWp2+5nCYnYKPTr0LvD89Jqk2Or5ogxz0NUMfIjhh2lIUX/LyX9B4oIg== + dependencies: + baseline-browser-mapping "^2.10.12" + caniuse-lite "^1.0.30001782" + electron-to-chromium "^1.5.328" + node-releases "^2.0.36" + update-browserslist-db "^1.2.3" + buffer-from@^1.0.0: version "1.1.2" resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.1.2.tgz#2b146a6fd72e80b4f55d255f35ed59a3a9a41bd5" integrity sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ== +bundle-name@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/bundle-name/-/bundle-name-4.1.0.tgz#f3b96b34160d6431a19d7688135af7cfb8797889" + integrity sha512-tjwM5exMg6BGRI+kNmTntNsvdZS1X8BFYS6tnJ2hdH0kVxM6/eVZ2xy+FqStSWvYmtfFMDLIxurorHwDKfDz5Q== + dependencies: + run-applescript "^7.0.0" + bytes@3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/bytes/-/bytes-3.0.0.tgz#d32815404d689699f85a4ea4fa8755dd13a96048" integrity sha512-pMhOfFDPiv9t5jjIXkHosWmkSyQbvsgEVNkz0ERHbuLh2T/7j4Mqqpz523Fe8MVY89KC6Sh/QfS2sM+SjgFDcw== -bytes@3.1.2: +bytes@3.1.2, bytes@~3.1.2: version "3.1.2" resolved "https://registry.yarnpkg.com/bytes/-/bytes-3.1.2.tgz#8b0beeb98605adf1b128fa4386403c009e0221a5" integrity sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg== +bytestreamjs@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/bytestreamjs/-/bytestreamjs-2.0.1.tgz#a32947c7ce389a6fa11a09a9a563d0a45889535e" + integrity sha512-U1Z/ob71V/bXfVABvNr/Kumf5VyeQRBEm6Txb0PQ6S7V5GpBM3w4Cbqz/xPDicR5tN0uvDifng8C+5qECeGwyQ== + cacheable-lookup@^7.0.0: version "7.0.0" resolved "https://registry.yarnpkg.com/cacheable-lookup/-/cacheable-lookup-7.0.0.tgz#3476a8215d046e5a3202a9209dd13fec1f933a27" @@ -3382,6 +4096,11 @@ caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001702, caniuse-lite@^1.0.30001741: resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001743.tgz#50ff91a991220a1ee2df5af00650dd5c308ea7cd" integrity sha512-e6Ojr7RV14Un7dz6ASD0aZDmQPT/A+eZU+nuTNfjqmRrmkmQlnTNWH0SKmqagx9PeW87UVqapSurtAXifmtdmw== +caniuse-lite@^1.0.30001782: + version "1.0.30001792" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001792.tgz#ca8bb9be244835a335e2018272ce7223691873c5" + integrity sha512-hVLMUZFgR4JJ6ACt1uEESvQN1/dBVqPAKY0hgrV70eN3391K6juAfTjKZLKvOMsx8PxA7gsY1/tLMMTcfFLLpw== + ccount@^2.0.0: version "2.0.1" resolved "https://registry.yarnpkg.com/ccount/-/ccount-2.0.1.tgz#17a3bf82302e0870d6da43a01311a8bc02a3ecf5" @@ -3450,7 +4169,7 @@ cheerio@1.0.0-rc.12: parse5 "^7.0.0" parse5-htmlparser2-tree-adapter "^7.0.0" -chokidar@^3.5.3: +chokidar@^3.5.3, chokidar@^3.6.0: version "3.6.0" resolved "https://registry.yarnpkg.com/chokidar/-/chokidar-3.6.0.tgz#197c6cc669ef2a8dc5e7b4d97ee4e092c3eb0d5b" integrity sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw== @@ -3598,7 +4317,7 @@ compressible@~2.0.18: dependencies: mime-db ">= 1.43.0 < 2" -compression@^1.7.4: +compression@^1.8.1: version "1.8.1" resolved "https://registry.yarnpkg.com/compression/-/compression-1.8.1.tgz#4a45d909ac16509195a9a28bd91094889c180d79" integrity sha512-9mAqGPHLakhCLeNyxPkK4xVo746zQ/czLH1Ky+vkitMnWfWZps8r0qXuwhwizagCRttsL4lfG4pIOvaWLpAP0w== @@ -3650,7 +4369,7 @@ content-disposition@0.5.2: resolved "https://registry.yarnpkg.com/content-disposition/-/content-disposition-0.5.2.tgz#0cf68bb9ddf5f2be7961c3a85178cb85dba78cb4" integrity sha512-kRGRZw3bLlFISDBgwTSA1TMBFN6J6GWDeubmDE3AF+3+yXL8hTWv8r5rkLbqYXY4RjPk/EzHnClI3zQf1cFmHA== -content-disposition@0.5.4: +content-disposition@~0.5.4: version "0.5.4" resolved "https://registry.yarnpkg.com/content-disposition/-/content-disposition-0.5.4.tgz#8b82b4efac82512a02bb0b1dcec9d2c5e8eb5bfe" integrity sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ== @@ -3672,15 +4391,15 @@ convert-source-map@^2.0.0: resolved "https://registry.yarnpkg.com/convert-source-map/-/convert-source-map-2.0.0.tgz#4b560f649fc4e918dd0ab75cf4961e8bc882d82a" integrity sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg== -cookie-signature@1.0.6: - version "1.0.6" - resolved "https://registry.yarnpkg.com/cookie-signature/-/cookie-signature-1.0.6.tgz#e303a882b342cc3ee8ca513a79999734dab3ae2c" - integrity sha512-QADzlaHc8icV8I7vbaJXJwod9HWYp8uCqf1xa4OfNu1T7JVxQIrUgOWtHdNDtPiywmFbiS12VjotIXLrKM3orQ== +cookie-signature@~1.0.6: + version "1.0.7" + resolved "https://registry.yarnpkg.com/cookie-signature/-/cookie-signature-1.0.7.tgz#ab5dd7ab757c54e60f37ef6550f481c426d10454" + integrity sha512-NXdYc3dLr47pBkpUCHtKSwIOQXLVn8dZEuywboCOJY/osA0wFSLlSawr3KN8qXJEyX66FcONTH8EIlVuK0yyFA== -cookie@0.7.1: - version "0.7.1" - resolved "https://registry.yarnpkg.com/cookie/-/cookie-0.7.1.tgz#2f73c42142d5d5cf71310a74fc4ae61670e5dbc9" - integrity sha512-6DnInpx7SJ2AK3+CTUE/ZM0vWTUboZCegxhC2xiIydHR9jNuTAASBrfEpHhiGOZw/nX51bHt6YQl8jsGo4y/0w== +cookie@~0.7.1: + version "0.7.2" + resolved "https://registry.yarnpkg.com/cookie/-/cookie-0.7.2.tgz#556369c472a2ba910f2979891b526b3436237ed7" + integrity sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w== copy-text-to-clipboard@^3.2.0: version "3.2.1" @@ -3706,11 +4425,6 @@ core-js-compat@^3.43.0: dependencies: browserslist "^4.25.3" -core-js-pure@^3.43.0: - version "3.45.1" - resolved "https://registry.yarnpkg.com/core-js-pure/-/core-js-pure-3.45.1.tgz#b129d86a5f7f8380378577c7eaee83608570a05a" - integrity sha512-OHnWFKgTUshEU8MK+lOs1H8kC8GkTi9Z1tvNkxrCcw9wl3MJIO7q2ld77wjWn4/xuGrVu2X+nME1iIIPBSdyEQ== - core-js@^3.31.1: version "3.45.1" resolved "https://registry.yarnpkg.com/core-js/-/core-js-3.45.1.tgz#5810e04a1b4e9bc5ddaa4dd12e702ff67300634d" @@ -3980,12 +4694,18 @@ deepmerge@^4.3.1: resolved "https://registry.yarnpkg.com/deepmerge/-/deepmerge-4.3.1.tgz#44b5f2147cd3b00d4b56137685966f26fd25dd4a" integrity sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A== -default-gateway@^6.0.3: - version "6.0.3" - resolved "https://registry.yarnpkg.com/default-gateway/-/default-gateway-6.0.3.tgz#819494c888053bdb743edbf343d6cdf7f2943a71" - integrity sha512-fwSOJsbbNzZ/CUFpqFBqYfYNLj1NbMPm8MMCIzHjC83iSJRBEGmDUxU+WP661BaBQImeC2yHwXtz+P/O9o+XEg== +default-browser-id@^5.0.0: + version "5.0.1" + resolved "https://registry.yarnpkg.com/default-browser-id/-/default-browser-id-5.0.1.tgz#f7a7ccb8f5104bf8e0f71ba3b1ccfa5eafdb21e8" + integrity sha512-x1VCxdX4t+8wVfd1so/9w+vQ4vx7lKd2Qp5tDRutErwmR85OgmfX7RlLRMWafRMY7hbEiXIbudNrjOAPa/hL8Q== + +default-browser@^5.2.1: + version "5.5.0" + resolved "https://registry.yarnpkg.com/default-browser/-/default-browser-5.5.0.tgz#2792e886f2422894545947cc80e1a444496c5976" + integrity sha512-H9LMLr5zwIbSxrmvikGuI/5KGhZ8E2zH3stkMgM5LpOWDutGM2JZaj460Udnf1a+946zc7YBgrqEWwbk7zHvGw== dependencies: - execa "^5.0.0" + bundle-name "^4.1.0" + default-browser-id "^5.0.0" defer-to-connect@^2.0.1: version "2.0.1" @@ -4006,6 +4726,11 @@ define-lazy-prop@^2.0.0: resolved "https://registry.yarnpkg.com/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz#3f7ae421129bcaaac9bc74905c98a0009ec9ee7f" integrity sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og== +define-lazy-prop@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/define-lazy-prop/-/define-lazy-prop-3.0.0.tgz#dbb19adfb746d7fc6d734a06b72f4a00d021255f" + integrity sha512-N+MeXYoqr3pOgn8xfyRPREN7gHakLYjhsHhWGT3fWAiL4IkAt0iDw14QiiEm2bE30c5XX5q0FtAA3CK5f9/BUg== + define-properties@^1.2.1: version "1.2.1" resolved "https://registry.yarnpkg.com/define-properties/-/define-properties-1.2.1.tgz#10781cc616eb951a80a034bafcaa7377f6af2b6c" @@ -4020,7 +4745,7 @@ delegate@^3.1.2: resolved "https://registry.yarnpkg.com/delegate/-/delegate-3.2.0.tgz#b66b71c3158522e8ab5744f720d8ca0c2af59166" integrity sha512-IofjkYBZaZivn0V8nnsMJGBr4jVLxHDheKSW88PyxS5QC4Vo9ZbZVvhzlSxY87fVq3STR6r+4cGepyHkcWOQSw== -depd@2.0.0: +depd@2.0.0, depd@~2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/depd/-/depd-2.0.0.tgz#b696163cc757560d09cf22cc8fad1571b79e76df" integrity sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw== @@ -4035,11 +4760,16 @@ dequal@^2.0.0: resolved "https://registry.yarnpkg.com/dequal/-/dequal-2.0.3.tgz#2644214f1997d39ed0ee0ece72335490a7ac67be" integrity sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA== -destroy@1.2.0: +destroy@1.2.0, destroy@~1.2.0: version "1.2.0" resolved "https://registry.yarnpkg.com/destroy/-/destroy-1.2.0.tgz#4803735509ad8be552934c67df614f94e66fa015" integrity sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg== +detect-libc@^2.0.3: + version "2.1.2" + resolved "https://registry.yarnpkg.com/detect-libc/-/detect-libc-2.1.2.tgz#689c5dcdc1900ef5583a4cb9f6d7b473742074ad" + integrity sha512-Btj2BOOO83o3WyH59e8MgXsxEQVcarkUOpEYrubB0urwnN10yQ364rsiByU11nZlqWYZm05i/of7io4mzihBtQ== + detect-node@^2.0.4: version "2.1.0" resolved "https://registry.yarnpkg.com/detect-node/-/detect-node-2.1.0.tgz#c9c70775a49c3d03bc2c06d9a73be550f978f8b1" @@ -4188,6 +4918,11 @@ electron-to-chromium@^1.5.218: resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.221.tgz#bd98014b2a247701c4ebd713080448d539545d79" integrity sha512-/1hFJ39wkW01ogqSyYoA4goOXOtMRy6B+yvA1u42nnsEGtHzIzmk93aPISumVQeblj47JUHLC9coCjUxb1EvtQ== +electron-to-chromium@^1.5.328: + version "1.5.352" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.352.tgz#0b57303cf654d7e4353edf01abe1ca55e5136063" + integrity sha512-9wHk8x6dyuimoe18EdiDPWKExNdxYqo4fn4FwOVVper6RxT3cmpBwBkWWfSOCYJjQdIco/nPhJhNLmn4Ufg1Yg== + emoji-regex@^8.0.0: version "8.0.0" resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37" @@ -4213,11 +4948,6 @@ emoticon@^4.0.1: resolved "https://registry.yarnpkg.com/emoticon/-/emoticon-4.1.0.tgz#d5a156868ee173095627a33de3f1e914c3dde79e" integrity sha512-VWZfnxqwNcc51hIy/sbOdEem6D+cVtpPzEEtVAFdaas30+1dgkyaOQ4sQ6Bp0tOMqWO1v+HQfYaoodOkdhK6SQ== -encodeurl@~1.0.2: - version "1.0.2" - resolved "https://registry.yarnpkg.com/encodeurl/-/encodeurl-1.0.2.tgz#ad3ff4c86ec2d029322f5a02c3a9a606c95b3f59" - integrity sha512-TPJXq8JqFaVYm2CWmPvnP2Iyo4ZSM7/QKcSmuMLDObfpH5fi7RUGmd/rTDf+rut/saiDiQEeVTNgAmJEdAOx0w== - encodeurl@~2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/encodeurl/-/encodeurl-2.0.0.tgz#7b8ea898077d7e409d3ac45474ea38eaf0857a58" @@ -4310,11 +5040,6 @@ escape-html@^1.0.3, escape-html@~1.0.3: resolved "https://registry.yarnpkg.com/escape-html/-/escape-html-1.0.3.tgz#0258eae4d3d0c0974de1c169188ef0051d1d1988" integrity sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow== -escape-string-regexp@^1.0.5: - version "1.0.5" - resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4" - integrity sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg== - escape-string-regexp@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz#14ba83a5d373e3d311e5afca29cf5bfad965bf34" @@ -4449,7 +5174,7 @@ events@^3.2.0: resolved "https://registry.yarnpkg.com/events/-/events-3.3.0.tgz#31a95ad0a924e2d2c419a813aeb2c4e878ea7400" integrity sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q== -execa@5.1.1, execa@^5.0.0: +execa@^5.1.1: version "5.1.1" resolved "https://registry.yarnpkg.com/execa/-/execa-5.1.1.tgz#f80ad9cbf4298f7bd1d4c9555c21e93741c411dd" integrity sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg== @@ -4464,39 +5189,39 @@ execa@5.1.1, execa@^5.0.0: signal-exit "^3.0.3" strip-final-newline "^2.0.0" -express@^4.17.3: - version "4.21.2" - resolved "https://registry.yarnpkg.com/express/-/express-4.21.2.tgz#cf250e48362174ead6cea4a566abef0162c1ec32" - integrity sha512-28HqgMZAmih1Czt9ny7qr6ek2qddF4FclbMzwhCREB6OFfH+rXAnuNCwo1/wFvrtbgsQDb4kSbX9de9lFbrXnA== +express@^4.22.1: + version "4.22.1" + resolved "https://registry.yarnpkg.com/express/-/express-4.22.1.tgz#1de23a09745a4fffdb39247b344bb5eaff382069" + integrity sha512-F2X8g9P1X7uCPZMA3MVf9wcTqlyNp7IhH5qPCI0izhaOIYXaW9L535tGA3qmjRzpH+bZczqq7hVKxTR4NWnu+g== dependencies: accepts "~1.3.8" array-flatten "1.1.1" - body-parser "1.20.3" - content-disposition "0.5.4" + body-parser "~1.20.3" + content-disposition "~0.5.4" content-type "~1.0.4" - cookie "0.7.1" - cookie-signature "1.0.6" + cookie "~0.7.1" + cookie-signature "~1.0.6" debug "2.6.9" depd "2.0.0" encodeurl "~2.0.0" escape-html "~1.0.3" etag "~1.8.1" - finalhandler "1.3.1" - fresh "0.5.2" - http-errors "2.0.0" + finalhandler "~1.3.1" + fresh "~0.5.2" + http-errors "~2.0.0" merge-descriptors "1.0.3" methods "~1.1.2" - on-finished "2.4.1" + on-finished "~2.4.1" parseurl "~1.3.3" - path-to-regexp "0.1.12" + path-to-regexp "~0.1.12" proxy-addr "~2.0.7" - qs "6.13.0" + qs "~6.14.0" range-parser "~1.2.1" safe-buffer "5.2.1" - send "0.19.0" - serve-static "1.16.2" + send "~0.19.0" + serve-static "~1.16.2" setprototypeof "1.2.0" - statuses "2.0.1" + statuses "~2.0.1" type-is "~1.6.18" utils-merge "1.0.1" vary "~1.1.2" @@ -4567,13 +5292,6 @@ feed@^4.2.2: dependencies: xml-js "^1.6.11" -figures@^3.2.0: - version "3.2.0" - resolved "https://registry.yarnpkg.com/figures/-/figures-3.2.0.tgz#625c18bd293c604dc4a8ddb2febf0c88341746af" - integrity sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg== - dependencies: - escape-string-regexp "^1.0.5" - file-loader@^6.2.0: version "6.2.0" resolved "https://registry.yarnpkg.com/file-loader/-/file-loader-6.2.0.tgz#baef7cf8e1840df325e4390b4484879480eebe4d" @@ -4589,17 +5307,17 @@ fill-range@^7.1.1: dependencies: to-regex-range "^5.0.1" -finalhandler@1.3.1: - version "1.3.1" - resolved "https://registry.yarnpkg.com/finalhandler/-/finalhandler-1.3.1.tgz#0c575f1d1d324ddd1da35ad7ece3df7d19088019" - integrity sha512-6BN9trH7bp3qvnrRyzsBz+g3lZxTNZTbVO2EV1CS0WIcDbawYVdYvGflME/9QP0h0pYlCDBCTjYa9nZzMDpyxQ== +finalhandler@~1.3.1: + version "1.3.2" + resolved "https://registry.yarnpkg.com/finalhandler/-/finalhandler-1.3.2.tgz#1ebc2228fc7673aac4a472c310cc05b77d852b88" + integrity sha512-aA4RyPcd3badbdABGDuTXCMTtOneUCAYH/gxoYRTZlIJdF0YPWuGqiAsIrhNnnqdXGswYk6dGujem4w80UJFhg== dependencies: debug "2.6.9" encodeurl "~2.0.0" escape-html "~1.0.3" - on-finished "2.4.1" + on-finished "~2.4.1" parseurl "~1.3.3" - statuses "2.0.1" + statuses "~2.0.2" unpipe "~1.0.0" find-cache-dir@^4.0.0: @@ -4653,7 +5371,7 @@ fraction.js@^4.3.7: resolved "https://registry.yarnpkg.com/fraction.js/-/fraction.js-4.3.7.tgz#06ca0085157e42fda7f9e726e79fefc4068840f7" integrity sha512-ZsDfxO51wGAXREY55a7la9LScWpwv9RxIrYABrlvOFBlH/ShPnrtsXeuUIfXKKOVicNxQ+o8JTbJvjS4M89yew== -fresh@0.5.2: +fresh@~0.5.2: version "0.5.2" resolved "https://registry.yarnpkg.com/fresh/-/fresh-0.5.2.tgz#3d8cadd90d976569fa835ab1f8e4b23a105605a7" integrity sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q== @@ -4667,16 +5385,6 @@ fs-extra@^11.1.1, fs-extra@^11.2.0: jsonfile "^6.0.1" universalify "^2.0.0" -fs-monkey@^1.0.4: - version "1.1.0" - resolved "https://registry.yarnpkg.com/fs-monkey/-/fs-monkey-1.1.0.tgz#632aa15a20e71828ed56b24303363fb1414e5997" - integrity sha512-QMUezzXWII9EV5aTFXW1UBVUO77wYPpjqIF8/AviUCThNeSYZykpoTixUeaNNBwmCev0AMDWMAni+f8Hxb1IFw== - -fs.realpath@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" - integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw== - fsevents@~2.3.2: version "2.3.3" resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.3.tgz#cac6407785d03675a2a5e1a5305c697b347d90d6" @@ -4745,23 +5453,16 @@ glob-parent@^6.0.1: dependencies: is-glob "^4.0.3" +glob-to-regex.js@^1.0.0, glob-to-regex.js@^1.0.1: + version "1.2.0" + resolved "https://registry.yarnpkg.com/glob-to-regex.js/-/glob-to-regex.js-1.2.0.tgz#2b323728271d133830850e32311f40766c5f6413" + integrity sha512-QMwlOQKU/IzqMUOAZWubUOT8Qft+Y0KQWnX9nK3ch0CJg0tTp4TvGZsTfudYKv2NzoQSyPcnA6TYeIQ3jGichQ== + glob-to-regexp@^0.4.1: version "0.4.1" resolved "https://registry.yarnpkg.com/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz#c75297087c851b9a578bd217dd59a92f59fe546e" integrity sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw== -glob@^7.1.3: - version "7.2.3" - resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.3.tgz#b8df0fb802bbfa8e89bd1d938b4e16578ed44f2b" - integrity sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q== - dependencies: - fs.realpath "^1.0.0" - inflight "^1.0.4" - inherits "2" - minimatch "^3.1.1" - once "^1.3.0" - path-is-absolute "^1.0.0" - global-dirs@^3.0.0: version "3.0.1" resolved "https://registry.yarnpkg.com/global-dirs/-/global-dirs-3.0.1.tgz#0c488971f066baceda21447aecb1a8b911d22485" @@ -5030,11 +5731,6 @@ hpack.js@^2.1.6: readable-stream "^2.0.1" wbuf "^1.1.0" -html-entities@^2.3.2: - version "2.6.0" - resolved "https://registry.yarnpkg.com/html-entities/-/html-entities-2.6.0.tgz#7c64f1ea3b36818ccae3d3fb48b6974208e984f8" - integrity sha512-kig+rMn/QOVRvr7c86gQ8lWXq+Hkv6CbAH1hLu+RG338StTpE8Z0b44SDVaqVu7HGKf27frdmUYEs9hTUX/cLQ== - html-escaper@^2.0.2: version "2.0.2" resolved "https://registry.yarnpkg.com/html-escaper/-/html-escaper-2.0.2.tgz#dfd60027da36a36dfcbe236262c00a5822681453" @@ -5117,17 +5813,6 @@ http-deceiver@^1.2.7: resolved "https://registry.yarnpkg.com/http-deceiver/-/http-deceiver-1.2.7.tgz#fa7168944ab9a519d337cb0bec7284dc3e723d87" integrity sha512-LmpOGxTfbpgtGVxJrj5k7asXHCgNZp5nLfp+hWc8QQRqtb7fUy6kRY3BO1h9ddF6yIPYUARgxGOwB42DnxIaNw== -http-errors@2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/http-errors/-/http-errors-2.0.0.tgz#b7774a1486ef73cf7667ac9ae0858c012c57b9d3" - integrity sha512-FtwrG/euBzaEjYeRqOgly7G0qviiXoJWnvEH2Z1plBdXgbyjv34pHTSb9zoeHMyDy33+DWy5Wt9Wo+TURtOYSQ== - dependencies: - depd "2.0.0" - inherits "2.0.4" - setprototypeof "1.2.0" - statuses "2.0.1" - toidentifier "1.0.1" - http-errors@~1.6.2: version "1.6.3" resolved "https://registry.yarnpkg.com/http-errors/-/http-errors-1.6.3.tgz#8b55680bb4be283a0b5bf4ea2e38580be1d9320d" @@ -5138,12 +5823,23 @@ http-errors@~1.6.2: setprototypeof "1.1.0" statuses ">= 1.4.0 < 2" +http-errors@~2.0.0, http-errors@~2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/http-errors/-/http-errors-2.0.1.tgz#36d2f65bc909c8790018dd36fb4d93da6caae06b" + integrity sha512-4FbRdAX+bSdmo4AUFuS0WNiPz8NgFt+r8ThgNWmlrjQjt1Q7ZR9+zTlce2859x4KSXrwIsaeTqDoKQmtP8pLmQ== + dependencies: + depd "~2.0.0" + inherits "~2.0.4" + setprototypeof "~1.2.0" + statuses "~2.0.2" + toidentifier "~1.0.1" + http-parser-js@>=0.5.1: version "0.5.10" resolved "https://registry.yarnpkg.com/http-parser-js/-/http-parser-js-0.5.10.tgz#b3277bd6d7ed5588e20ea73bf724fcbe44609075" integrity sha512-Pysuw9XpUq5dVc/2SMHpuTY01RFl8fttgcyunjL7eEMhGM3cI4eOmiCycJDVCo/7O7ClfQD3SaI6ftDzqOXYMA== -http-proxy-middleware@^2.0.3: +http-proxy-middleware@^2.0.9: version "2.0.9" resolved "https://registry.yarnpkg.com/http-proxy-middleware/-/http-proxy-middleware-2.0.9.tgz#e9e63d68afaa4eee3d147f39149ab84c0c2815ef" integrity sha512-c1IyJYLYppU574+YI7R4QyX2ystMtVXZwIdzazUIPIJsHuWNd+mho2j+bKoHftndicGj9yh+xjd+l0yj7VeT1Q== @@ -5176,7 +5872,12 @@ human-signals@^2.1.0: resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0" integrity sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw== -iconv-lite@0.4.24: +hyperdyperid@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/hyperdyperid/-/hyperdyperid-1.2.0.tgz#59668d323ada92228d2a869d3e474d5a33b69e6b" + integrity sha512-Y93lCzHYgGWdrJ66yIktxiaGULYc6oGiABxhcO5AufBeOyoIdZF7bIfLaOrbM0iGIOXQQgxxRrFEnb+Y6w1n4A== + +iconv-lite@~0.4.24: version "0.4.24" resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.24.tgz#2022b4b25fbddc21d2f524974a474aafe733908b" integrity sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA== @@ -5226,24 +5927,16 @@ infima@0.2.0-alpha.45: resolved "https://registry.yarnpkg.com/infima/-/infima-0.2.0-alpha.45.tgz#542aab5a249274d81679631b492973dd2c1e7466" integrity sha512-uyH0zfr1erU1OohLk0fT4Rrb94AOhguWNOcD9uGrSpRvNB+6gZXUoJX5J0NtvzBO10YZ9PgvA4NFgt+fYg8ojw== -inflight@^1.0.4: - version "1.0.6" - resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" - integrity sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA== - dependencies: - once "^1.3.0" - wrappy "1" - -inherits@2, inherits@2.0.4, inherits@^2.0.1, inherits@^2.0.3, inherits@~2.0.3: - version "2.0.4" - resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" - integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== - inherits@2.0.3: version "2.0.3" resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.3.tgz#633c2c83e3da42a502f52466022480f4208261de" integrity sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw== +inherits@^2.0.1, inherits@^2.0.3, inherits@~2.0.3, inherits@~2.0.4: + version "2.0.4" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" + integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== + ini@2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/ini/-/ini-2.0.0.tgz#e5fd556ecdd5726be978fa1001862eacb0a94bc5" @@ -5271,10 +5964,10 @@ ipaddr.js@1.9.1: resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-1.9.1.tgz#bff38543eeb8984825079ff3a2a8e6cbd46781b3" integrity sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g== -ipaddr.js@^2.0.1: - version "2.2.0" - resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-2.2.0.tgz#d33fa7bac284f4de7af949638c9d68157c6b92e8" - integrity sha512-Ag3wB2o37wslZS19hZqorUnrnzSkpOVy+IiiDEiTqNubEYpYuHWIf6K4psgN2ZWKExS4xhVCrRVfb/wfW8fWJA== +ipaddr.js@^2.1.0: + version "2.4.0" + resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-2.4.0.tgz#038e9ceaf8219efc5bb76347b7eb787875d5095b" + integrity sha512-9VGk3HGanVE6JoZXHiCpnGy5X0jYDnN4EA4lntFPj+1vIWlFhIylq2CrrCOJH9EAhc5CYhq18F2Av2tgoAPsYQ== is-alphabetical@^2.0.0: version "2.0.1" @@ -5325,6 +6018,11 @@ is-docker@^2.0.0, is-docker@^2.1.1: resolved "https://registry.yarnpkg.com/is-docker/-/is-docker-2.2.1.tgz#33eeabe23cfe86f14bde4408a02c0cfb853acdaa" integrity sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ== +is-docker@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/is-docker/-/is-docker-3.0.0.tgz#90093aa3106277d8a77a5910dbae71747e15a200" + integrity sha512-eljcgEDlEns/7AXFosB5K/2nCM4P7FQPkGc/DWLy5rmFEWvZayGrik1d9/QIY5nJ4f9YsVvBkA6kJpHn9rISdQ== + is-extendable@^0.1.0: version "0.1.1" resolved "https://registry.yarnpkg.com/is-extendable/-/is-extendable-0.1.1.tgz#62b110e289a471418e3ec36a617d472e301dfc89" @@ -5352,6 +6050,13 @@ is-hexadecimal@^2.0.0: resolved "https://registry.yarnpkg.com/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz#86b5bf668fca307498d319dfc03289d781a90027" integrity sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg== +is-inside-container@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-inside-container/-/is-inside-container-1.0.0.tgz#e81fba699662eb31dbdaf26766a61d4814717ea4" + integrity sha512-KIYLCCJghfHZxqjYBE7rEy0OBuTd5xCHS7tHVgvCLkx7StIoaxwNW3hCALgEUjFfeRk+MG/Qxmp/vtETEF3tRA== + dependencies: + is-docker "^3.0.0" + is-installed-globally@^0.4.0: version "0.4.0" resolved "https://registry.yarnpkg.com/is-installed-globally/-/is-installed-globally-0.4.0.tgz#9a0fd407949c30f86eb6959ef1b7994ed0b7b520" @@ -5360,6 +6065,11 @@ is-installed-globally@^0.4.0: global-dirs "^3.0.0" is-path-inside "^3.0.2" +is-network-error@^1.0.0: + version "1.3.1" + resolved "https://registry.yarnpkg.com/is-network-error/-/is-network-error-1.3.1.tgz#a2a86b80ffd6b05b774755c73c8aaab16597e58d" + integrity sha512-6QCxa49rQbmUWLfk0nuGqzql9U8uaV2H6279bRErPBHe/109hCzsLUBUHfbEtvLIHBd6hyXbgedBSHevm43Edw== + is-npm@^6.0.0: version "6.1.0" resolved "https://registry.yarnpkg.com/is-npm/-/is-npm-6.1.0.tgz#f70e0b6c132dfc817ac97d3badc0134945b098d3" @@ -5424,6 +6134,13 @@ is-wsl@^2.2.0: dependencies: is-docker "^2.0.0" +is-wsl@^3.1.0: + version "3.1.1" + resolved "https://registry.yarnpkg.com/is-wsl/-/is-wsl-3.1.1.tgz#327897b26832a3eb117da6c27492d04ca132594f" + integrity sha512-e6rvdUCiQCAuumZslxRJWR/Doq4VpPR82kqclvcS0efgt430SlGIk05vdCN58+VrzgtIcfNODjozVielycD4Sw== + dependencies: + is-inside-container "^1.0.0" + is-yarn-global@^0.4.0: version "0.4.1" resolved "https://registry.yarnpkg.com/is-yarn-global/-/is-yarn-global-0.4.1.tgz#b312d902b313f81e4eaf98b6361ba2b45cd694bb" @@ -5584,10 +6301,10 @@ latest-version@^7.0.0: dependencies: package-json "^8.1.0" -launch-editor@^2.6.0: - version "2.11.1" - resolved "https://registry.yarnpkg.com/launch-editor/-/launch-editor-2.11.1.tgz#61a0b7314a42fd84a6cbb564573d9e9ffcf3d72b" - integrity sha512-SEET7oNfgSaB6Ym0jufAdCeo3meJVeCaaDyzRygy0xsp2BFKCprcfHljTq4QkzTLUxEKkFK6OK4811YM2oSrRg== +launch-editor@^2.6.1: + version "2.13.2" + resolved "https://registry.yarnpkg.com/launch-editor/-/launch-editor-2.13.2.tgz#41d51baaf8afb393224b89bd2bcb4e02f2306405" + integrity sha512-4VVDnbOpLXy/s8rdRCSXb+zfMeFR0WlJWpET1iA9CQdlZDfwyLjUuGQzXU4VeOoey6AicSAluWan7Etga6Kcmg== dependencies: picocolors "^1.1.1" shell-quote "^1.8.3" @@ -5597,6 +6314,80 @@ leven@^3.1.0: resolved "https://registry.yarnpkg.com/leven/-/leven-3.1.0.tgz#77891de834064cccba82ae7842bb6b14a13ed7f2" integrity sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A== +lightningcss-android-arm64@1.32.0: + version "1.32.0" + resolved "https://registry.yarnpkg.com/lightningcss-android-arm64/-/lightningcss-android-arm64-1.32.0.tgz#f033885116dfefd9c6f54787523e3514b61e1968" + integrity sha512-YK7/ClTt4kAK0vo6w3X+Pnm0D2cf2vPHbhOXdoNti1Ga0al1P4TBZhwjATvjNwLEBCnKvjJc2jQgHXH0NEwlAg== + +lightningcss-darwin-arm64@1.32.0: + version "1.32.0" + resolved "https://registry.yarnpkg.com/lightningcss-darwin-arm64/-/lightningcss-darwin-arm64-1.32.0.tgz#50b71871b01c8199584b649e292547faea7af9b5" + integrity sha512-RzeG9Ju5bag2Bv1/lwlVJvBE3q6TtXskdZLLCyfg5pt+HLz9BqlICO7LZM7VHNTTn/5PRhHFBSjk5lc4cmscPQ== + +lightningcss-darwin-x64@1.32.0: + version "1.32.0" + resolved "https://registry.yarnpkg.com/lightningcss-darwin-x64/-/lightningcss-darwin-x64-1.32.0.tgz#35f3e97332d130b9ca181e11b568ded6aebc6d5e" + integrity sha512-U+QsBp2m/s2wqpUYT/6wnlagdZbtZdndSmut/NJqlCcMLTWp5muCrID+K5UJ6jqD2BFshejCYXniPDbNh73V8w== + +lightningcss-freebsd-x64@1.32.0: + version "1.32.0" + resolved "https://registry.yarnpkg.com/lightningcss-freebsd-x64/-/lightningcss-freebsd-x64-1.32.0.tgz#9777a76472b64ed6ff94342ad64c7bafd794a575" + integrity sha512-JCTigedEksZk3tHTTthnMdVfGf61Fky8Ji2E4YjUTEQX14xiy/lTzXnu1vwiZe3bYe0q+SpsSH/CTeDXK6WHig== + +lightningcss-linux-arm-gnueabihf@1.32.0: + version "1.32.0" + resolved "https://registry.yarnpkg.com/lightningcss-linux-arm-gnueabihf/-/lightningcss-linux-arm-gnueabihf-1.32.0.tgz#13ae652e1ab73b9135d7b7da172f666c410ad53d" + integrity sha512-x6rnnpRa2GL0zQOkt6rts3YDPzduLpWvwAF6EMhXFVZXD4tPrBkEFqzGowzCsIWsPjqSK+tyNEODUBXeeVHSkw== + +lightningcss-linux-arm64-gnu@1.32.0: + version "1.32.0" + resolved "https://registry.yarnpkg.com/lightningcss-linux-arm64-gnu/-/lightningcss-linux-arm64-gnu-1.32.0.tgz#417858795a94592f680123a1b1f9da8a0e1ef335" + integrity sha512-0nnMyoyOLRJXfbMOilaSRcLH3Jw5z9HDNGfT/gwCPgaDjnx0i8w7vBzFLFR1f6CMLKF8gVbebmkUN3fa/kQJpQ== + +lightningcss-linux-arm64-musl@1.32.0: + version "1.32.0" + resolved "https://registry.yarnpkg.com/lightningcss-linux-arm64-musl/-/lightningcss-linux-arm64-musl-1.32.0.tgz#6be36692e810b718040802fd809623cffe732133" + integrity sha512-UpQkoenr4UJEzgVIYpI80lDFvRmPVg6oqboNHfoH4CQIfNA+HOrZ7Mo7KZP02dC6LjghPQJeBsvXhJod/wnIBg== + +lightningcss-linux-x64-gnu@1.32.0: + version "1.32.0" + resolved "https://registry.yarnpkg.com/lightningcss-linux-x64-gnu/-/lightningcss-linux-x64-gnu-1.32.0.tgz#0b7803af4eb21cfd38dd39fe2abbb53c7dd091f6" + integrity sha512-V7Qr52IhZmdKPVr+Vtw8o+WLsQJYCTd8loIfpDaMRWGUZfBOYEJeyJIkqGIDMZPwPx24pUMfwSxxI8phr/MbOA== + +lightningcss-linux-x64-musl@1.32.0: + version "1.32.0" + resolved "https://registry.yarnpkg.com/lightningcss-linux-x64-musl/-/lightningcss-linux-x64-musl-1.32.0.tgz#88dc8ba865ddddb1ac5ef04b0f161804418c163b" + integrity sha512-bYcLp+Vb0awsiXg/80uCRezCYHNg1/l3mt0gzHnWV9XP1W5sKa5/TCdGWaR/zBM2PeF/HbsQv/j2URNOiVuxWg== + +lightningcss-win32-arm64-msvc@1.32.0: + version "1.32.0" + resolved "https://registry.yarnpkg.com/lightningcss-win32-arm64-msvc/-/lightningcss-win32-arm64-msvc-1.32.0.tgz#4f30ba3fa5e925f5b79f945e8cc0d176c3b1ab38" + integrity sha512-8SbC8BR40pS6baCM8sbtYDSwEVQd4JlFTOlaD3gWGHfThTcABnNDBda6eTZeqbofalIJhFx0qKzgHJmcPTnGdw== + +lightningcss-win32-x64-msvc@1.32.0: + version "1.32.0" + resolved "https://registry.yarnpkg.com/lightningcss-win32-x64-msvc/-/lightningcss-win32-x64-msvc-1.32.0.tgz#141aa5605645064928902bb4af045fa7d9f4220a" + integrity sha512-Amq9B/SoZYdDi1kFrojnoqPLxYhQ4Wo5XiL8EVJrVsB8ARoC1PWW6VGtT0WKCemjy8aC+louJnjS7U18x3b06Q== + +lightningcss@^1.27.0: + version "1.32.0" + resolved "https://registry.yarnpkg.com/lightningcss/-/lightningcss-1.32.0.tgz#b85aae96486dcb1bf49a7c8571221273f4f1e4a9" + integrity sha512-NXYBzinNrblfraPGyrbPoD19C1h9lfI/1mzgWYvXUTe414Gz/X1FD2XBZSZM7rRTrMA8JL3OtAaGifrIKhQ5yQ== + dependencies: + detect-libc "^2.0.3" + optionalDependencies: + lightningcss-android-arm64 "1.32.0" + lightningcss-darwin-arm64 "1.32.0" + lightningcss-darwin-x64 "1.32.0" + lightningcss-freebsd-x64 "1.32.0" + lightningcss-linux-arm-gnueabihf "1.32.0" + lightningcss-linux-arm64-gnu "1.32.0" + lightningcss-linux-arm64-musl "1.32.0" + lightningcss-linux-x64-gnu "1.32.0" + lightningcss-linux-x64-musl "1.32.0" + lightningcss-win32-arm64-msvc "1.32.0" + lightningcss-win32-x64-msvc "1.32.0" + lilconfig@^3.1.1: version "3.1.3" resolved "https://registry.yarnpkg.com/lilconfig/-/lilconfig-3.1.3.tgz#a1bcfd6257f9585bf5ae14ceeebb7b559025e4c4" @@ -5684,13 +6475,6 @@ markdown-extensions@^2.0.0: resolved "https://registry.yarnpkg.com/markdown-extensions/-/markdown-extensions-2.0.0.tgz#34bebc83e9938cae16e0e017e4a9814a8330d3c4" integrity sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q== -markdown-table@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/markdown-table/-/markdown-table-2.0.0.tgz#194a90ced26d31fe753d8b9434430214c011865b" - integrity sha512-Ezda85ToJUBhM6WGaG6veasyym+Tbs3cMAw/ZhOPqXiYsr0jgocBV3j3nx+4lk47plLlIqjwuTm/ywVI+zjJ/A== - dependencies: - repeat-string "^1.0.0" - markdown-table@^3.0.0: version "3.0.4" resolved "https://registry.yarnpkg.com/markdown-table/-/markdown-table-3.0.4.tgz#fe44d6d410ff9d6f2ea1797a3f60aa4d2b631c2a" @@ -5934,12 +6718,25 @@ media-typer@0.3.0: resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748" integrity sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ== -memfs@^3.4.3: - version "3.6.0" - resolved "https://registry.yarnpkg.com/memfs/-/memfs-3.6.0.tgz#d7a2110f86f79dd950a8b6df6d57bc984aa185f6" - integrity sha512-EGowvkkgbMcIChjMTMkESFDbZeSh8xZ7kNSF0hAiAN4Jh6jgHCRS0Ga/+C8y6Au+oqpezRHCfPsmJ2+DwAgiwQ== - dependencies: - fs-monkey "^1.0.4" +memfs@^4.43.1: + version "4.57.2" + resolved "https://registry.yarnpkg.com/memfs/-/memfs-4.57.2.tgz#5f74e977c9a14681ea10d427b3ce5d7db5f817e7" + integrity sha512-2nWzSsJzrukurSDna4Z0WywuScK4Id3tSKejgu74u8KCdW4uNrseKRSIDg75C6Yw5ZRqBe0F0EtMNlTbUq8bAQ== + dependencies: + "@jsonjoy.com/fs-core" "4.57.2" + "@jsonjoy.com/fs-fsa" "4.57.2" + "@jsonjoy.com/fs-node" "4.57.2" + "@jsonjoy.com/fs-node-builtins" "4.57.2" + "@jsonjoy.com/fs-node-to-fsa" "4.57.2" + "@jsonjoy.com/fs-node-utils" "4.57.2" + "@jsonjoy.com/fs-print" "4.57.2" + "@jsonjoy.com/fs-snapshot" "4.57.2" + "@jsonjoy.com/json-pack" "^1.11.0" + "@jsonjoy.com/util" "^1.9.0" + glob-to-regex.js "^1.0.1" + thingies "^2.5.0" + tree-dump "^1.0.3" + tslib "^2.0.0" merge-descriptors@1.0.3: version "1.0.3" @@ -6390,7 +7187,7 @@ mime-db@1.52.0: resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.52.0.tgz#bbabcdc02859f4987301c856e3387ce5ec43bf70" integrity sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg== -"mime-db@>= 1.43.0 < 2": +"mime-db@>= 1.43.0 < 2", mime-db@^1.54.0: version "1.54.0" resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.54.0.tgz#cddb3ee4f9c64530dff640236661d42cb6a314f5" integrity sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ== @@ -6407,13 +7204,20 @@ mime-types@2.1.18: dependencies: mime-db "~1.33.0" -mime-types@^2.1.27, mime-types@^2.1.31, mime-types@~2.1.17, mime-types@~2.1.24, mime-types@~2.1.34: +mime-types@^2.1.27, mime-types@~2.1.17, mime-types@~2.1.24, mime-types@~2.1.34: version "2.1.35" resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.35.tgz#381a871b62a734450660ae3deee44813f70d959a" integrity sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw== dependencies: mime-db "1.52.0" +mime-types@^3.0.1: + version "3.0.2" + resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-3.0.2.tgz#39002d4182575d5af036ffa118100f2524b2e2ab" + integrity sha512-Lbgzdk0h4juoQ9fCKXW4by0UJqj+nOOrI9MJ1sSj4nI8aI2eo1qmvQEie4VD1glsS250n15LsWsYtCugiStS5A== + dependencies: + mime-db "^1.54.0" + mime@1.6.0: version "1.6.0" resolved "https://registry.yarnpkg.com/mime/-/mime-1.6.0.tgz#32cd9e5c64553bd58d19a568af452acff04981b1" @@ -6447,10 +7251,10 @@ minimalistic-assert@^1.0.0: resolved "https://registry.yarnpkg.com/minimalistic-assert/-/minimalistic-assert-1.0.1.tgz#2e194de044626d4a10e7f7fbc00ce73e83e4d5c7" integrity sha512-UtJcAD4yEaGtjPezWuO9wC4nwUnVH/8/Im3yEHQP4b67cXlD/Qr9hdITCU1xDbSEXg2XKNaP8jsReV7vQd00/A== -minimatch@3.1.2, minimatch@^3.1.1: - version "3.1.2" - resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.2.tgz#19cd194bfd3e428f049a70817c038d89ab4be35b" - integrity sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw== +minimatch@3.1.5: + version "3.1.5" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.5.tgz#580c88f8d5445f2bd6aa8f3cadefa0de79fbd69e" + integrity sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w== dependencies: brace-expansion "^1.1.7" @@ -6520,16 +7324,16 @@ node-emoji@^2.1.0: emojilib "^2.4.0" skin-tone "^2.0.0" -node-forge@^1: - version "1.3.1" - resolved "https://registry.yarnpkg.com/node-forge/-/node-forge-1.3.1.tgz#be8da2af243b2417d5f646a770663a92b7e9ded3" - integrity sha512-dPEtOeMvF9VMcYV/1Wb8CPoVAXtp6MKMlcbAt4ddqmGqUJ6fQZFXkNZNkNlfevtNkGtaSoXf/vNNNSvgrdXwtA== - node-releases@^2.0.21: version "2.0.21" resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.21.tgz#f59b018bc0048044be2d4c4c04e4c8b18160894c" integrity sha512-5b0pgg78U3hwXkCM8Z9b2FJdPZlr9Psr9V2gQPESdGHqbntyFJKFW4r5TeWGFzafGY3hzs1JC62VEQMbl1JFkw== +node-releases@^2.0.36: + version "2.0.38" + resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.38.tgz#791569b9e4424a044e12c3abfad418ed83ce9947" + integrity sha512-3qT/88Y3FbH/Kx4szpQQ4HzUbVrHPKTLVpVocKiLfoYvw9XSGOX2FmD2d6DrXbVYyAQTF2HeF6My8jmzx7/CRw== + normalize-path@^3.0.0, normalize-path@~3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/normalize-path/-/normalize-path-3.0.0.tgz#0dcd69ff23a1c9b11fd0978316644a0388216a65" @@ -6604,7 +7408,7 @@ obuf@^1.0.0, obuf@^1.1.2: resolved "https://registry.yarnpkg.com/obuf/-/obuf-1.1.2.tgz#09bea3343d41859ebd446292d11c9d4db619084e" integrity sha512-PX1wu0AmAdPqOL1mWhqmlOd8kOIZQwGZw6rh7uby9fTc5lhaOWFLX3I6R1hrF9k3zUY40e6igsLGkDXK92LJNg== -on-finished@2.4.1: +on-finished@^2.4.1, on-finished@~2.4.1: version "2.4.1" resolved "https://registry.yarnpkg.com/on-finished/-/on-finished-2.4.1.tgz#58c8c44116e54845ad57f14ab10b03533184ac3f" integrity sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg== @@ -6616,13 +7420,6 @@ on-headers@~1.1.0: resolved "https://registry.yarnpkg.com/on-headers/-/on-headers-1.1.0.tgz#59da4f91c45f5f989c6e4bcedc5a3b0aed70ff65" integrity sha512-737ZY3yNnXy37FHkQxPzt4UZ2UWPWiCZWLvFZ4fu5cueciegX0zGPnrlY6bwRg4FdQOe9YU8MkmJwGhoMybl8A== -once@^1.3.0: - version "1.4.0" - resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" - integrity sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w== - dependencies: - wrappy "1" - onetime@^5.1.2: version "5.1.2" resolved "https://registry.yarnpkg.com/onetime/-/onetime-5.1.2.tgz#d0e96ebb56b07476df1dd9c4806e5237985ca45e" @@ -6630,7 +7427,17 @@ onetime@^5.1.2: dependencies: mimic-fn "^2.1.0" -open@^8.0.9, open@^8.4.0: +open@^10.0.3: + version "10.2.0" + resolved "https://registry.yarnpkg.com/open/-/open-10.2.0.tgz#b9d855be007620e80b6fb05fac98141fe62db73c" + integrity sha512-YgBpdJHPyQ2UE5x+hlSXcnejzAvD0b22U2OuAP+8OnlJT+PjWPxtgmGqKKc+RgTM63U9gN0YzrYc71R2WT/hTA== + dependencies: + default-browser "^5.2.1" + define-lazy-prop "^3.0.0" + is-inside-container "^1.0.0" + wsl-utils "^0.1.0" + +open@^8.4.0: version "8.4.2" resolved "https://registry.yarnpkg.com/open/-/open-8.4.2.tgz#5b5ffe2a8f793dcd2aad73e550cb87b59cb084f9" integrity sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ== @@ -6683,12 +7490,13 @@ p-queue@^6.6.2: eventemitter3 "^4.0.4" p-timeout "^3.2.0" -p-retry@^4.5.0: - version "4.6.2" - resolved "https://registry.yarnpkg.com/p-retry/-/p-retry-4.6.2.tgz#9baae7184057edd4e17231cee04264106e092a16" - integrity sha512-312Id396EbJdvRONlngUx0NydfrIQ5lsYu0znKVUzVvArzEIt08V1qhtyESbGVd1FGX7UKtiFp5uwKZdM8wIuQ== +p-retry@^6.2.0: + version "6.2.1" + resolved "https://registry.yarnpkg.com/p-retry/-/p-retry-6.2.1.tgz#81828f8dc61c6ef5a800585491572cc9892703af" + integrity sha512-hEt02O4hUct5wtwg4H4KcWgDdm+l1bOaEy/hWzd8xtXB9BqxTWBBhb+2ImAtH4Cv4rPjV76xN3Zumqk3k3AhhQ== dependencies: - "@types/retry" "0.12.0" + "@types/retry" "0.12.2" + is-network-error "^1.0.0" retry "^0.13.1" p-timeout@^3.2.0: @@ -6784,11 +7592,6 @@ path-exists@^5.0.0: resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-5.0.0.tgz#a6aad9489200b21fab31e49cf09277e5116fb9e7" integrity sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ== -path-is-absolute@^1.0.0: - version "1.0.1" - resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f" - integrity sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg== - path-is-inside@1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/path-is-inside/-/path-is-inside-1.0.2.tgz#365417dede44430d1c11af61027facf074bdfc53" @@ -6804,11 +7607,6 @@ path-parse@^1.0.7: resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.7.tgz#fbc114b60ca42b30d9daf5858e4bd68bbedb6735" integrity sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw== -path-to-regexp@0.1.12: - version "0.1.12" - resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-0.1.12.tgz#d5e1a12e478a976d432ef3c58d534b9923164bb7" - integrity sha512-RA1GjUVMnvYFxuqovrEqZoxxW5NUZqbwKtYz/Tt7nXerk0LbLblQmrsgdeOxV5SFHf0UDggjS/bSeOZwt1pmEQ== - path-to-regexp@3.3.0: version "3.3.0" resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-3.3.0.tgz#f7f31d32e8518c2660862b644414b6d5c63a611b" @@ -6821,6 +7619,11 @@ path-to-regexp@^1.7.0: dependencies: isarray "0.0.1" +path-to-regexp@~0.1.12: + version "0.1.13" + resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-0.1.13.tgz#9b22ec16bc3ab88d05a0c7e369869421401ab17d" + integrity sha512-A/AGNMFN3c8bOlvV9RreMdrv7jsmF9XIfDeCd87+I8RNg6s78BhJxMu69NEMHBSJFxKidViTEdruRwEk/WIKqA== + path-type@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/path-type/-/path-type-4.0.0.tgz#84ed01c0a7ba380afe09d90a8c180dcd9d03043b" @@ -6843,6 +7646,18 @@ pkg-dir@^7.0.0: dependencies: find-up "^6.3.0" +pkijs@^3.3.3: + version "3.4.0" + resolved "https://registry.yarnpkg.com/pkijs/-/pkijs-3.4.0.tgz#d9164def30ff6d97be2d88966d5e36192499ca9c" + integrity sha512-emEcLuomt2j03vxD54giVB4SxTjnsqkU692xZOZXHDVoYyypEm+b3jpiTcc+Cf+myooc+/Ly0z01jqeNHVgJGw== + dependencies: + "@noble/hashes" "1.4.0" + asn1js "^3.0.6" + bytestreamjs "^2.0.1" + pvtsutils "^1.3.6" + pvutils "^1.1.3" + tslib "^2.8.1" + postcss-attribute-case-insensitive@^7.0.1: version "7.0.1" resolved "https://registry.yarnpkg.com/postcss-attribute-case-insensitive/-/postcss-attribute-case-insensitive-7.0.1.tgz#0c4500e3bcb2141848e89382c05b5a31c23033a3" @@ -7485,12 +8300,31 @@ pupa@^3.1.0: dependencies: escape-goat "^4.0.0" -qs@6.13.0: - version "6.13.0" - resolved "https://registry.yarnpkg.com/qs/-/qs-6.13.0.tgz#6ca3bd58439f7e245655798997787b0d88a51906" - integrity sha512-+38qI9SOr8tfZ4QmJNplMUxqjbe7LKvvZgWdExBOmd+egZTtjLB67Gu0HRX3u/XOq7UU2Nx6nsjvS16Z9uwfpg== +pvtsutils@^1.3.6: + version "1.3.6" + resolved "https://registry.yarnpkg.com/pvtsutils/-/pvtsutils-1.3.6.tgz#ec46e34db7422b9e4fdc5490578c1883657d6001" + integrity sha512-PLgQXQ6H2FWCaeRak8vvk1GW462lMxB5s3Jm673N82zI4vqtVUPuZdffdZbPDFRoU8kAhItWFtPCWiPpp4/EDg== + dependencies: + tslib "^2.8.1" + +pvutils@^1.1.3, pvutils@^1.1.5: + version "1.1.5" + resolved "https://registry.yarnpkg.com/pvutils/-/pvutils-1.1.5.tgz#84b0dea4a5d670249aa9800511804ee0b7c2809c" + integrity sha512-KTqnxsgGiQ6ZAzZCVlJH5eOjSnvlyEgx1m8bkRJfOhmGRqfo5KLvmAlACQkrjEtOQ4B7wF9TdSLIs9O90MX9xA== + +qs@~6.14.0: + version "6.14.2" + resolved "https://registry.yarnpkg.com/qs/-/qs-6.14.2.tgz#b5634cf9d9ad9898e31fba3504e866e8efb6798c" + integrity sha512-V/yCWTTF7VJ9hIh18Ugr2zhJMP01MY7c5kh4J870L7imm6/DIzBsNLTXzMwUA3yZ5b/KBqLx8Kp3uRvd7xSe3Q== + dependencies: + side-channel "^1.1.0" + +qs@~6.15.1: + version "6.15.1" + resolved "https://registry.yarnpkg.com/qs/-/qs-6.15.1.tgz#bdb55aed06bfac257a90c44a446a73fba5575c8f" + integrity sha512-6YHEFRL9mfgcAvql/XhwTvf5jKcOiiupt2FiJxHkiX1z4j7WL8J/jRHYLluORvc1XxB5rV20KoeK00gVJamspg== dependencies: - side-channel "^1.0.6" + side-channel "^1.1.0" queue-microtask@^1.2.2: version "1.2.3" @@ -7519,15 +8353,15 @@ range-parser@^1.2.1, range-parser@~1.2.1: resolved "https://registry.yarnpkg.com/range-parser/-/range-parser-1.2.1.tgz#3cf37023d199e1c24d1a55b84800c2f3e6468031" integrity sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg== -raw-body@2.5.2: - version "2.5.2" - resolved "https://registry.yarnpkg.com/raw-body/-/raw-body-2.5.2.tgz#99febd83b90e08975087e8f1f9419a149366b68a" - integrity sha512-8zGqypfENjCIqGhgXToC8aB2r7YrBX+AQAfIPs/Mlk+BtPTztOvTS01NRW/3Eh60J+a48lt8qsCzirQ6loCVfA== +raw-body@~2.5.3: + version "2.5.3" + resolved "https://registry.yarnpkg.com/raw-body/-/raw-body-2.5.3.tgz#11c6650ee770a7de1b494f197927de0c923822e2" + integrity sha512-s4VSOf6yN0rvbRZGxs8Om5CWj6seneMwK3oDb4lWDH0UPhWcxwOWw5+qk24bxq87szX1ydrwylIOp2uG1ojUpA== dependencies: - bytes "3.1.2" - http-errors "2.0.0" - iconv-lite "0.4.24" - unpipe "1.0.0" + bytes "~3.1.2" + http-errors "~2.0.1" + iconv-lite "~0.4.24" + unpipe "~1.0.0" rc@1.2.8: version "1.2.8" @@ -7577,10 +8411,10 @@ react-json-view-lite@^2.3.0: resolved "https://registry.yarnpkg.com/react-json-view-lite/-/react-json-view-lite-2.5.0.tgz#c7ff011c7cc80e9900abc7aa4916c6a5c6d6c1c6" integrity sha512-tk7o7QG9oYyELWHL8xiMQ8x4WzjCzbWNyig3uexmkLb54r8jO0yH3WCWx8UZS0c49eSA4QUmG5caiRJ8fAn58g== -react-loadable-ssr-addon-v5-slorber@^1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/react-loadable-ssr-addon-v5-slorber/-/react-loadable-ssr-addon-v5-slorber-1.0.1.tgz#2cdc91e8a744ffdf9e3556caabeb6e4278689883" - integrity sha512-lq3Lyw1lGku8zUEJPDxsNm1AfYHBrO9Y1+olAYwpUJ2IGFBskM0DMKok97A6LWUpHm+o7IvQBOWu9MLenp9Z+A== +react-loadable-ssr-addon-v5-slorber@^1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/react-loadable-ssr-addon-v5-slorber/-/react-loadable-ssr-addon-v5-slorber-1.0.3.tgz#bb3791bf481222c63a5bc6b96ee23f68cb5614b9" + integrity sha512-GXfh9VLwB5ERaCsU6RULh7tkemeX15aNh6wuMEBtfdyMa7fFG8TXrhXlx1SoEK2Ty/l6XIkzzYIQmyaWW3JgdQ== dependencies: "@babel/runtime" "^7.10.3" @@ -7710,6 +8544,11 @@ recma-stringify@^1.0.0: unified "^11.0.0" vfile "^6.0.0" +reflect-metadata@^0.2.2: + version "0.2.2" + resolved "https://registry.yarnpkg.com/reflect-metadata/-/reflect-metadata-0.2.2.tgz#400c845b6cba87a21f2c65c4aeb158f4fa4d9c5b" + integrity sha512-urBwgfrvVP/eAyXx4hluJivBKzuEbSQs9rKWCrCkbSxNv8mxPcUZKeuoF3Uy4mJl3Lwprp6yy5/39VWigZ4K6Q== + regenerate-unicode-properties@^10.2.2: version "10.2.2" resolved "https://registry.yarnpkg.com/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.2.tgz#aa113812ba899b630658c7623466be71e1f86f66" @@ -7875,11 +8714,6 @@ renderkid@^3.0.0: lodash "^4.17.21" strip-ansi "^6.0.1" -repeat-string@^1.0.0: - version "1.6.1" - resolved "https://registry.yarnpkg.com/repeat-string/-/repeat-string-1.6.1.tgz#8dcae470e1c88abc2d600fff4a776286da75e637" - integrity sha512-PV0dzCYDNfRi1jCDbJzpW7jNNDRuCOG/jI5ctQcGKt/clZD+YcPS3yIlWuTJMmESC8aevCFmWJy5wjAFgNqN6w== - require-from-string@^2.0.2: version "2.0.2" resolved "https://registry.yarnpkg.com/require-from-string/-/require-from-string-2.0.2.tgz#89a7fdd938261267318eafe14f9c32e598c36909" @@ -7936,13 +8770,6 @@ reusify@^1.0.4: resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.1.0.tgz#0fe13b9522e1473f51b558ee796e08f11f9b489f" integrity sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw== -rimraf@^3.0.2: - version "3.0.2" - resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a" - integrity sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA== - dependencies: - glob "^7.1.3" - rtlcss@^4.1.0: version "4.3.0" resolved "https://registry.yarnpkg.com/rtlcss/-/rtlcss-4.3.0.tgz#f8efd4d5b64f640ec4af8fa25b65bacd9e07cc97" @@ -7953,6 +8780,11 @@ rtlcss@^4.1.0: postcss "^8.4.21" strip-json-comments "^3.1.1" +run-applescript@^7.0.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/run-applescript/-/run-applescript-7.1.0.tgz#2e9e54c4664ec3106c5b5630e249d3d6595c4911" + integrity sha512-DPe5pVFaAsinSaV6QjQ6gdiedWDcRCbUuiQfQa2wmWV7+xC9bGulGI8+TdRmoFkAPaBXk8CrAbnlY2ISniJ47Q== + run-parallel@^1.1.9: version "1.2.0" resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee" @@ -8009,6 +8841,16 @@ schema-utils@^4.0.0, schema-utils@^4.0.1, schema-utils@^4.3.0, schema-utils@^4.3 ajv-formats "^2.1.1" ajv-keywords "^5.1.0" +schema-utils@^4.2.0: + version "4.3.3" + resolved "https://registry.yarnpkg.com/schema-utils/-/schema-utils-4.3.3.tgz#5b1850912fa31df90716963d45d9121fdfc09f46" + integrity sha512-eflK8wEtyOE6+hsaRVPxvUKYCpRgzLqDTb8krvAsRIwOGlHoSgYLgBXoubGgLd2fT41/OUYdb48v4k4WWHQurA== + dependencies: + "@types/json-schema" "^7.0.9" + ajv "^8.9.0" + ajv-formats "^2.1.1" + ajv-keywords "^5.1.0" + section-matter@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/section-matter/-/section-matter-1.0.0.tgz#e9041953506780ec01d59f292a19c7b850b84167" @@ -8027,13 +8869,13 @@ select@^1.1.2: resolved "https://registry.yarnpkg.com/select/-/select-1.1.2.tgz#0e7350acdec80b1108528786ec1d4418d11b396d" integrity sha512-OwpTSOfy6xSs1+pwcNrv0RBMOzI39Lp3qQKUTPVVPRjCdNa5JH/oPRiqsesIskK8TVgmRiHwO4KXlV2Li9dANA== -selfsigned@^2.1.1: - version "2.4.1" - resolved "https://registry.yarnpkg.com/selfsigned/-/selfsigned-2.4.1.tgz#560d90565442a3ed35b674034cec4e95dceb4ae0" - integrity sha512-th5B4L2U+eGLq1TVh7zNRGBapioSORUeymIydxgFpwww9d2qyKvtuPU2jJuHvYAwwqi2Y596QBL3eEqcPEYL8Q== +selfsigned@^5.5.0: + version "5.5.0" + resolved "https://registry.yarnpkg.com/selfsigned/-/selfsigned-5.5.0.tgz#4c9ab7c7c9f35f18fb6a9882c253eb0e6bd6557b" + integrity sha512-ftnu3TW4+3eBfLRFnDEkzGxSF/10BJBkaLJuBHZX0kiPS7bRdlpZGu6YGt4KngMkdTwJE6MbjavFpqHvqVt+Ew== dependencies: - "@types/node-forge" "^1.3.0" - node-forge "^1" + "@peculiar/x509" "^1.14.2" + pkijs "^3.3.3" semver-diff@^4.0.0: version "4.0.0" @@ -8052,24 +8894,24 @@ semver@^7.3.5, semver@^7.3.7, semver@^7.5.4: resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.2.tgz#67d99fdcd35cec21e6f8b87a7fd515a33f982b58" integrity sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA== -send@0.19.0: - version "0.19.0" - resolved "https://registry.yarnpkg.com/send/-/send-0.19.0.tgz#bbc5a388c8ea6c048967049dbeac0e4a3f09d7f8" - integrity sha512-dW41u5VfLXu8SJh5bwRmyYUbAoSB3c9uQh6L8h/KtsFREPWpbX1lrljJo186Jc4nmci/sGUZ9a0a0J2zgfq2hw== +send@~0.19.0, send@~0.19.1: + version "0.19.2" + resolved "https://registry.yarnpkg.com/send/-/send-0.19.2.tgz#59bc0da1b4ea7ad42736fd642b1c4294e114ff29" + integrity sha512-VMbMxbDeehAxpOtWJXlcUS5E8iXh6QmN+BkRX1GARS3wRaXEEgzCcB10gTQazO42tpNIya8xIyNx8fll1OFPrg== dependencies: debug "2.6.9" depd "2.0.0" destroy "1.2.0" - encodeurl "~1.0.2" + encodeurl "~2.0.0" escape-html "~1.0.3" etag "~1.8.1" - fresh "0.5.2" - http-errors "2.0.0" + fresh "~0.5.2" + http-errors "~2.0.1" mime "1.6.0" ms "2.1.3" - on-finished "2.4.1" + on-finished "~2.4.1" range-parser "~1.2.1" - statuses "2.0.1" + statuses "~2.0.2" serialize-javascript@^6.0.0, serialize-javascript@^6.0.1, serialize-javascript@^6.0.2: version "6.0.2" @@ -8078,15 +8920,15 @@ serialize-javascript@^6.0.0, serialize-javascript@^6.0.1, serialize-javascript@^ dependencies: randombytes "^2.1.0" -serve-handler@^6.1.6: - version "6.1.6" - resolved "https://registry.yarnpkg.com/serve-handler/-/serve-handler-6.1.6.tgz#50803c1d3e947cd4a341d617f8209b22bd76cfa1" - integrity sha512-x5RL9Y2p5+Sh3D38Fh9i/iQ5ZK+e4xuXRd/pGbM4D13tgo/MGwbttUk8emytcr1YYzBYs+apnUngBDFYfpjPuQ== +serve-handler@^6.1.7: + version "6.1.7" + resolved "https://registry.yarnpkg.com/serve-handler/-/serve-handler-6.1.7.tgz#e9bb864e87ee71e8dab874cde44d146b77e3fb78" + integrity sha512-CinAq1xWb0vR3twAv9evEU8cNWkXCb9kd5ePAHUKJBkOsUpR1wt/CvGdeca7vqumL1U5cSaeVQ6zZMxiJ3yWsg== dependencies: bytes "3.0.0" content-disposition "0.5.2" mime-types "2.1.18" - minimatch "3.1.2" + minimatch "3.1.5" path-is-inside "1.0.2" path-to-regexp "3.3.0" range-parser "1.2.0" @@ -8104,15 +8946,15 @@ serve-index@^1.9.1: mime-types "~2.1.17" parseurl "~1.3.2" -serve-static@1.16.2: - version "1.16.2" - resolved "https://registry.yarnpkg.com/serve-static/-/serve-static-1.16.2.tgz#b6a5343da47f6bdd2673848bf45754941e803296" - integrity sha512-VqpjJZKadQB/PEbEwvFdO43Ax5dFBZ2UECszz8bQ7pi7wt//PWe1P6MN7eCnjsatYtBT6EuiClbjSWP2WrIoTw== +serve-static@~1.16.2: + version "1.16.3" + resolved "https://registry.yarnpkg.com/serve-static/-/serve-static-1.16.3.tgz#a97b74d955778583f3862a4f0b841eb4d5d78cf9" + integrity sha512-x0RTqQel6g5SY7Lg6ZreMmsOzncHFU7nhnRWkKgWuMTu5NN0DR5oruckMqRvacAN9d5w6ARnRBXl9xhDCgfMeA== dependencies: encodeurl "~2.0.0" escape-html "~1.0.3" parseurl "~1.3.3" - send "0.19.0" + send "~0.19.1" set-function-length@^1.2.2: version "1.2.2" @@ -8131,7 +8973,7 @@ setprototypeof@1.1.0: resolved "https://registry.yarnpkg.com/setprototypeof/-/setprototypeof-1.1.0.tgz#d0bd85536887b6fe7c0d818cb962d9d91c54e656" integrity sha512-BvE/TwpZX4FXExxOxZyRGQQv651MSwmWKZGqvmPcRIjDqWub67kTKuIMx43cZZrS/cBBzwBcNDWoFxt2XEFIpQ== -setprototypeof@1.2.0: +setprototypeof@1.2.0, setprototypeof@~1.2.0: version "1.2.0" resolved "https://registry.yarnpkg.com/setprototypeof/-/setprototypeof-1.2.0.tgz#66c9a24a73f9fc28cbe66b09fed3d33dcaf1b424" integrity sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw== @@ -8194,7 +9036,7 @@ side-channel-weakmap@^1.0.2: object-inspect "^1.13.3" side-channel-map "^1.0.1" -side-channel@^1.0.6: +side-channel@^1.1.0: version "1.1.0" resolved "https://registry.yarnpkg.com/side-channel/-/side-channel-1.1.0.tgz#c3fcff9c4da932784873335ec9765fa94ff66bc9" integrity sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw== @@ -8339,16 +9181,16 @@ srcset@^4.0.0: resolved "https://registry.yarnpkg.com/srcset/-/srcset-4.0.0.tgz#336816b665b14cd013ba545b6fe62357f86e65f4" integrity sha512-wvLeHgcVHKO8Sc/H/5lkGreJQVeYMm9rlmt8PuR1xE31rIuXhuzznUUqAt8MqLhB3MqJdFzlNAfpcWnxiFUcPw== -statuses@2.0.1: - version "2.0.1" - resolved "https://registry.yarnpkg.com/statuses/-/statuses-2.0.1.tgz#55cb000ccf1d48728bd23c685a063998cf1a1b63" - integrity sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ== - "statuses@>= 1.4.0 < 2": version "1.5.0" resolved "https://registry.yarnpkg.com/statuses/-/statuses-1.5.0.tgz#161c7dac177659fd9811f43771fa99381478628c" integrity sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA== +statuses@~2.0.1, statuses@~2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/statuses/-/statuses-2.0.2.tgz#8f75eecef765b5e1cfcdc080da59409ed424e382" + integrity sha512-DvEy55V3DB7uknRo+4iOGT5fP1slR8wQohVdknigZPMpMstaKJQWhwiYBACJE3Ul2pTnATihhBYnRhZQHGBiRw== + std-env@^3.7.0: version "3.9.0" resolved "https://registry.yarnpkg.com/std-env/-/std-env-3.9.0.tgz#1a6f7243b339dca4c9fd55e1c7504c77ef23e8f1" @@ -8403,7 +9245,7 @@ stringify-object@^3.3.0: is-obj "^1.0.1" is-regexp "^1.0.0" -strip-ansi@^6.0.0, strip-ansi@^6.0.1: +strip-ansi@^6.0.1: version "6.0.1" resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== @@ -8501,6 +9343,13 @@ svgo@^3.0.2, svgo@^3.2.0: csso "^5.0.5" picocolors "^1.0.0" +swc-loader@^0.2.6: + version "0.2.7" + resolved "https://registry.yarnpkg.com/swc-loader/-/swc-loader-0.2.7.tgz#2d1611ab314c5d8342d74aa5e5901b3fbf490de2" + integrity sha512-nwYWw3Fh9ame3Rtm7StS9SBLpHRRnYcK7bnpF3UKZmesAK0gw2/ADvlURFAINmPvKtDLzp+GBiP9yLoEjg6S9w== + dependencies: + "@swc/counter" "^0.1.3" + tapable@^2.0.0, tapable@^2.1.1, tapable@^2.2.0, tapable@^2.2.1: version "2.2.3" resolved "https://registry.yarnpkg.com/tapable/-/tapable-2.2.3.tgz#4b67b635b2d97578a06a2713d2f04800c237e99b" @@ -8527,6 +9376,11 @@ terser@^5.10.0, terser@^5.15.1, terser@^5.31.1: commander "^2.20.0" source-map-support "~0.5.20" +thingies@^2.5.0: + version "2.6.0" + resolved "https://registry.yarnpkg.com/thingies/-/thingies-2.6.0.tgz#e09b98b9e6f6caf8a759eca8481fea1de974d2b1" + integrity sha512-rMHRjmlFLM1R96UYPvpmnc3LYtdFrT33JIB7L9hetGue1qAPfn1N2LJeEjxUSidu1Iku+haLZXDuEXUHNGO/lg== + thunky@^1.0.2: version "1.1.0" resolved "https://registry.yarnpkg.com/thunky/-/thunky-1.1.0.tgz#5abaf714a9405db0504732bbccd2cedd9ef9537d" @@ -8559,7 +9413,7 @@ to-regex-range@^5.0.1: dependencies: is-number "^7.0.0" -toidentifier@1.0.1: +toidentifier@~1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/toidentifier/-/toidentifier-1.0.1.tgz#3be34321a88a820ed1bd80dfaa33e479fbb8dd35" integrity sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA== @@ -8569,6 +9423,11 @@ totalist@^3.0.0: resolved "https://registry.yarnpkg.com/totalist/-/totalist-3.0.1.tgz#ba3a3d600c915b1a97872348f79c127475f6acf8" integrity sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ== +tree-dump@^1.0.3, tree-dump@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/tree-dump/-/tree-dump-1.1.0.tgz#ab29129169dc46004414f5a9d4a3c6e89f13e8a4" + integrity sha512-rMuvhU4MCDbcbnleZTFezWsaZXRFemSqAM+7jPnzUl1fo9w3YEKOxAeui0fz3OI4EU4hf23iyA7uQRVko+UaBA== + trim-lines@^3.0.0: version "3.0.1" resolved "https://registry.yarnpkg.com/trim-lines/-/trim-lines-3.0.1.tgz#d802e332a07df861c48802c04321017b1bd87338" @@ -8579,15 +9438,22 @@ trough@^2.0.0: resolved "https://registry.yarnpkg.com/trough/-/trough-2.2.0.tgz#94a60bd6bd375c152c1df911a4b11d5b0256f50f" integrity sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw== -tslib@^2.0.3, tslib@^2.6.0: +tslib@^1.9.3: + version "1.14.1" + resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.14.1.tgz#cf2d38bdc34a134bcaf1091c41f6619e2f672d00" + integrity sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg== + +tslib@^2.0.0, tslib@^2.0.3, tslib@^2.4.0, tslib@^2.6.0, tslib@^2.8.1: version "2.8.1" resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.8.1.tgz#612efe4ed235d567e8aba5f2a5fab70280ade83f" integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w== -type-fest@^0.21.3: - version "0.21.3" - resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.21.3.tgz#d260a24b0198436e133fa26a524a6d65fa3b2e37" - integrity sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w== +tsyringe@^4.10.0: + version "4.10.0" + resolved "https://registry.yarnpkg.com/tsyringe/-/tsyringe-4.10.0.tgz#d0c95815d584464214060285eaaadd94aa03299c" + integrity sha512-axr3IdNuVIxnaK5XGEUFTu3YmAQ6lllgrvqfEoR16g/HGnYY/6We4oWENtAnzK6/LpJ2ur9PAb80RBt7/U4ugw== + dependencies: + tslib "^1.9.3" type-fest@^1.0.1: version "1.4.0" @@ -8717,7 +9583,7 @@ universalify@^2.0.0: resolved "https://registry.yarnpkg.com/universalify/-/universalify-2.0.1.tgz#168efc2180964e6386d061e094df61afe239b18d" integrity sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw== -unpipe@1.0.0, unpipe@~1.0.0: +unpipe@~1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/unpipe/-/unpipe-1.0.0.tgz#b2bf4ee8514aae6165b4817829d21b2ef49904ec" integrity sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ== @@ -8730,6 +9596,14 @@ update-browserslist-db@^1.1.3: escalade "^3.2.0" picocolors "^1.1.1" +update-browserslist-db@^1.2.3: + version "1.2.3" + resolved "https://registry.yarnpkg.com/update-browserslist-db/-/update-browserslist-db-1.2.3.tgz#64d76db58713136acbeb4c49114366cc6cc2e80d" + integrity sha512-Js0m9cx+qOgDxo0eMiFGEueWztz+d4+M3rGlmKPT+T4IS/jP4ylw3Nwpu6cpTTP8R1MAC1kF4VbdLt3ARf209w== + dependencies: + escalade "^3.2.0" + picocolors "^1.1.1" + update-notifier@^6.0.2: version "6.0.2" resolved "https://registry.yarnpkg.com/update-notifier/-/update-notifier-6.0.2.tgz#a6990253dfe6d5a02bd04fbb6a61543f55026b60" @@ -8863,52 +9737,51 @@ webpack-bundle-analyzer@^4.10.2: sirv "^2.0.3" ws "^7.3.1" -webpack-dev-middleware@^5.3.4: - version "5.3.4" - resolved "https://registry.yarnpkg.com/webpack-dev-middleware/-/webpack-dev-middleware-5.3.4.tgz#eb7b39281cbce10e104eb2b8bf2b63fce49a3517" - integrity sha512-BVdTqhhs+0IfoeAf7EoH5WE+exCmqGerHfDM0IL096Px60Tq2Mn9MAbnaGUe6HiMa41KMCYF19gyzZmBcq/o4Q== +webpack-dev-middleware@^7.4.2: + version "7.4.5" + resolved "https://registry.yarnpkg.com/webpack-dev-middleware/-/webpack-dev-middleware-7.4.5.tgz#d4e8720aa29cb03bc158084a94edb4594e3b7ac0" + integrity sha512-uxQ6YqGdE4hgDKNf7hUiPXOdtkXvBJXrfEGYSx7P7LC8hnUYGK70X6xQXUvXeNyBDDcsiQXpG2m3G9vxowaEuA== dependencies: colorette "^2.0.10" - memfs "^3.4.3" - mime-types "^2.1.31" + memfs "^4.43.1" + mime-types "^3.0.1" + on-finished "^2.4.1" range-parser "^1.2.1" schema-utils "^4.0.0" -webpack-dev-server@^4.15.2: - version "4.15.2" - resolved "https://registry.yarnpkg.com/webpack-dev-server/-/webpack-dev-server-4.15.2.tgz#9e0c70a42a012560860adb186986da1248333173" - integrity sha512-0XavAZbNJ5sDrCbkpWL8mia0o5WPOd2YGtxrEiZkBK9FjLppIUK2TgxK6qGD2P3hUXTJNNPVibrerKcx5WkR1g== - dependencies: - "@types/bonjour" "^3.5.9" - "@types/connect-history-api-fallback" "^1.3.5" - "@types/express" "^4.17.13" - "@types/serve-index" "^1.9.1" - "@types/serve-static" "^1.13.10" - "@types/sockjs" "^0.3.33" - "@types/ws" "^8.5.5" +webpack-dev-server@^5.2.2: + version "5.2.3" + resolved "https://registry.yarnpkg.com/webpack-dev-server/-/webpack-dev-server-5.2.3.tgz#7f36a78be7ac88833fd87757edee31469a9e47d3" + integrity sha512-9Gyu2F7+bg4Vv+pjbovuYDhHX+mqdqITykfzdM9UyKqKHlsE5aAjRhR+oOEfXW5vBeu8tarzlJFIZva4ZjAdrQ== + dependencies: + "@types/bonjour" "^3.5.13" + "@types/connect-history-api-fallback" "^1.5.4" + "@types/express" "^4.17.25" + "@types/express-serve-static-core" "^4.17.21" + "@types/serve-index" "^1.9.4" + "@types/serve-static" "^1.15.5" + "@types/sockjs" "^0.3.36" + "@types/ws" "^8.5.10" ansi-html-community "^0.0.8" - bonjour-service "^1.0.11" - chokidar "^3.5.3" + bonjour-service "^1.2.1" + chokidar "^3.6.0" colorette "^2.0.10" - compression "^1.7.4" + compression "^1.8.1" connect-history-api-fallback "^2.0.0" - default-gateway "^6.0.3" - express "^4.17.3" + express "^4.22.1" graceful-fs "^4.2.6" - html-entities "^2.3.2" - http-proxy-middleware "^2.0.3" - ipaddr.js "^2.0.1" - launch-editor "^2.6.0" - open "^8.0.9" - p-retry "^4.5.0" - rimraf "^3.0.2" - schema-utils "^4.0.0" - selfsigned "^2.1.1" + http-proxy-middleware "^2.0.9" + ipaddr.js "^2.1.0" + launch-editor "^2.6.1" + open "^10.0.3" + p-retry "^6.2.0" + schema-utils "^4.2.0" + selfsigned "^5.5.0" serve-index "^1.9.1" sockjs "^0.3.24" spdy "^4.0.2" - webpack-dev-middleware "^5.3.4" - ws "^8.13.0" + webpack-dev-middleware "^7.4.2" + ws "^8.18.0" webpack-merge@^5.9.0: version "5.10.0" @@ -8964,19 +9837,15 @@ webpack@^5.88.1, webpack@^5.95.0: watchpack "^2.4.1" webpack-sources "^3.3.3" -webpackbar@^6.0.1: - version "6.0.1" - resolved "https://registry.yarnpkg.com/webpackbar/-/webpackbar-6.0.1.tgz#5ef57d3bf7ced8b19025477bc7496ea9d502076b" - integrity sha512-TnErZpmuKdwWBdMoexjio3KKX6ZtoKHRVvLIU0A47R0VVBDtx3ZyOJDktgYixhoJokZTYTt1Z37OkO9pnGJa9Q== +webpackbar@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/webpackbar/-/webpackbar-7.0.0.tgz#7228d32881af2392381b6514499ddea73cdf218a" + integrity sha512-aS9soqSO2iCHgqHoCrj4LbfGQUboDCYJPSFOAchEK+9psIjNrfSWW4Y0YEz67MKURNvMmfo0ycOg9d/+OOf9/Q== dependencies: - ansi-escapes "^4.3.2" - chalk "^4.1.2" + ansis "^3.2.0" consola "^3.2.3" - figures "^3.2.0" - markdown-table "^2.0.0" pretty-time "^1.1.0" std-env "^3.7.0" - wrap-ansi "^7.0.0" websocket-driver@>=0.5.1, websocket-driver@^0.7.4: version "0.7.4" @@ -9011,15 +9880,6 @@ wildcard@^2.0.0, wildcard@^2.0.1: resolved "https://registry.yarnpkg.com/wildcard/-/wildcard-2.0.1.tgz#5ab10d02487198954836b6349f74fff961e10f67" integrity sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ== -wrap-ansi@^7.0.0: - version "7.0.0" - resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" - integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== - dependencies: - ansi-styles "^4.0.0" - string-width "^4.1.0" - strip-ansi "^6.0.0" - wrap-ansi@^8.0.1, wrap-ansi@^8.1.0: version "8.1.0" resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-8.1.0.tgz#56dc22368ee570face1b49819975d9b9a5ead214" @@ -9029,11 +9889,6 @@ wrap-ansi@^8.0.1, wrap-ansi@^8.1.0: string-width "^5.0.1" strip-ansi "^7.0.1" -wrappy@1: - version "1.0.2" - resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" - integrity sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ== - write-file-atomic@^3.0.3: version "3.0.3" resolved "https://registry.yarnpkg.com/write-file-atomic/-/write-file-atomic-3.0.3.tgz#56bd5c5a5c70481cd19c571bd39ab965a5de56e8" @@ -9049,10 +9904,17 @@ ws@^7.3.1: resolved "https://registry.yarnpkg.com/ws/-/ws-7.5.10.tgz#58b5c20dc281633f6c19113f39b349bd8bd558d9" integrity sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ== -ws@^8.13.0: - version "8.18.3" - resolved "https://registry.yarnpkg.com/ws/-/ws-8.18.3.tgz#b56b88abffde62791c639170400c93dcb0c95472" - integrity sha512-PEIGCY5tSlUt50cqyMXfCzX+oOPqN0vuGqWzbcJ2xvnkzkq46oOpz7dQaTDBdfICb4N14+GARUDw2XV2N4tvzg== +ws@^8.18.0: + version "8.20.0" + resolved "https://registry.yarnpkg.com/ws/-/ws-8.20.0.tgz#4cd9532358eba60bc863aad1623dfb045a4d4af8" + integrity sha512-sAt8BhgNbzCtgGbt2OxmpuryO63ZoDk/sqaB/znQm94T4fCEsy/yV+7CdC1kJhOU9lboAEU7R3kquuycDoibVA== + +wsl-utils@^0.1.0: + version "0.1.0" + resolved "https://registry.yarnpkg.com/wsl-utils/-/wsl-utils-0.1.0.tgz#8783d4df671d4d50365be2ee4c71917a0557baab" + integrity sha512-h3Fbisa2nKGPxCpm89Hk33lBLsnaGBvctQopaBSOW/uIs6FTe1ATyAnKFJrzVs9vpGdsTe73WF3V4lIsk4Gacw== + dependencies: + is-wsl "^3.1.0" xdg-basedir@^5.0.1, xdg-basedir@^5.1.0: version "5.1.0"